翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

変数の追加と管理

次の表に、Grafana に組み込まれる変数タイプ一覧を示します。

一般的なオプションの入力

作成する変数のタイプには、一般的なオプションを入力する必要があります。

クエリ変数の追加

クエリ変数を使用すると、メトリクス名、タグ値、またはキーのリストを返すデータソースクエリを記述できます。例えば、クエリ変数は、サーバー名、センサー ID、またはデータセンターのリストを返す場合があります。変数値は、データソースクエリでオプションを動的に取得するにつれて変化します。

クエリ変数は通常、文字列でのみサポートされます。クエリが数値またはその他のデータ型を返す場合は、変数として使用するために文字列に変換する必要があります。例えば、Azure データソースの場合、この目的のために tostring 関数を使用できます。

クエリ式には、他の変数への参照を含めることができ、実際にはリンクされた変数を作成できます。Grafana はこれを検出し、リンクされた変数のいずれかが変更されると変数を自動的に更新します。

カスタム変数の追加

数値や文字列など、変更されない値にはカスタム変数を使用します。

例えば、サーバー名やリージョン名が変更されない場合は、クエリ変数ではなくカスタム変数として作成できます。これらは変更されないため、他のクエリ変数ではなく、連鎖変数で使用できます。これにより、連鎖変数が更新されたときに Grafana が送信する必要があるクエリの数が減少します。

テキストボックス変数の追加

テキストボックス変数は、任意のデフォルト値を使用して自由テキスト入力フィールドを表示します。これは、任意の値を入力できるため、最も柔軟な変数です。カーディナリティの高いメトリクスがある場合や、ダッシュボード内の複数のパネルを同時に更新する場合は、このタイプの変数を使用します。

定数変数の追加

定数変数を使用すると、非表示の定数を定義できます。定数変数は、共有するダッシュボードに対するメトリックパスの接頭辞に有用です。ダッシュボードをエクスポートすると、定数変数がインポートオプションに変換されます。

定数変数は複数設定できません。各定数変数は 1 つの値のみを保持し、変数設定を更新しない限り更新できません。

定数変数は、クエリに含める必要がある複素数値があっても、クエリすべてに再入力したくない場合に便利です。例えば、「i-0b6a61efe2ab843gg」というサーバーパスがある場合、それを「$path_gg」という変数に置き換えることができます。

データソース変数の追加

データソース変数を使用すると、ダッシュボード全体のデータソースをすばやく変更できます。データソースのインスタンスが複数ある場合、おそらく異なる環境にある場合に便利です。

間隔変数の追加

間隔変数を使用して、1m、1h、1dなどの時間範囲を表します。これらはダッシュボード全体の group by time コマンドと考えることができます。間隔変数は、視覚化でのデータのグループ化方法を変更します。また、[自動] オプションを使用して、時間範囲ごとに複数のデータポイントを返すこともできます。

間隔変数を時間 (InfluxDB の場合)、日付ヒストグラム間隔 (Elasticsearch の場合) でグループ化するパラメータとして、または要約関数パラメータ (Graphite の場合) として使用できます。

間隔変数の例

Graphite 関数でテンプレート変数 myinterval を使用する例:

summarize($myinterval, sum, false)

アドホックフィルターの追加

アドホックフィルターを使用して、指定されたデータソースを使用するすべてのメトリクスクエリに自動的に追加されるキー/値フィルターを追加できます。他の変数とは異なり、クエリではアドホックフィルターを使用しません。代わりに、アドホックフィルターを使用して既存のクエリのフィルターを書き込みます。

アドホックフィルターの作成

アドホックフィルターは、利用可能な最も複雑で変更可能な変数オプションの 1 つです。変数オプションの通常リストの代わりに、この変数によりダッシュボード全体のアドホッククエリを構築できます。この方法で適用するフィルターは、ダッシュボード上のすべてのパネルに適用されます。

変数選択オプションを設定する

選択オプションは、可変オプションの選択を管理するために使用できる機能です。すべての選択オプションは任意で使用でき、デフォルトではオフになっています。

複数値の変数

複数値が選択された変数を補間するのは、変数が使用されている特定のコンテキストで有効な文字列に複数の値をフォーマットする方法が単純ではないため、難しくなります。Grafana は、各データソースプラグインがテンプレート補間エンジンに、複数値に使用する形式を通知できるようにすることで、この問題を解決しようと試みます。

Graphite データソースを使用した複数値変数

Graphite は glob 式を使用します。この場合、複数の値を持つ変数は、現在の変数値が host1、host2、host3 であった場合は、{host1,host2,host3} として補間されます。

Prometheus または InfluxDB データソースを使用した複数値変数

InfluxDB と Prometheus は正規表現を使用するため、同じ変数は (host1|host2|host3) として補間されます。すべての値も正規表現エスケープされます。そうでない場合、正規表現コントロール文字を持つ値は正規表現を破ります。

Elastic データソースを使用した複数値変数

Elasticsearch は Lucene クエリ構文を使用するため、同じ変数は ("host1" OR "host2" OR "host3") としてフォーマットされます。この場合、すべての値がエスケープされ、値には lucene 制御語と引用符のみが含まれます。

複数値変数のトラブルシューティング

自動エスケープとフォーマットは問題を引き起こす可能性があり、その背後にあるロジックを理解するのは難しい場合があります。特に InfluxDB と Prometheus では、正規表現構文を使用するために、変数を正規表現演算子コンテキストで使用する必要があります。

Grafana でこの自動正規表現エスケープとフォーマットを実行したくない場合は、次のいずれかを実行する必要があります。

すべてを含めるオプション

Grafana は、変数ドロップダウンリストに All オプションを追加します。ユーザーがこのオプションを選択すると、すべての変数オプションが選択されます。

すべての値のカスタム化

このオプションは、[すべてを含めるオプション] が選択されている場合にのみ表示されます。

[すべての値のカスタム化] フィールドに 正規表現、globs、または lucene 構文を入力して、 All オプションの値を定義します。

デフォルトでは、All 値は結合式内のすべてのオプションを含みます。これは非常に長くなり、パフォーマンスの問題が発生する可能性があります。ワイルドカード正規表現など、すべての値のカスタム化を指定する方がよい場合があります。

[すべての値のカスタム化] オプションにカスタム正規表現、globs、または lucene 構文を含めるには、エスケープされないため、データソースに有効な値は何かを検討する必要があります。

グローバル変数

Grafana には、クエリエディタの式で使用できるグローバル組み込み変数があります。このトピックでは、それらをアルファベット順に一覧表示し、定義します。これらの変数は、クエリ、ダッシュボードリンク、パネルリンク、データリンクに役立ちます。

$__dashboard

この変数は、現在のダッシュボードの名前です。

$__from および $__to

Grafana には、「$__from」と「$__to」の 2 つの組み込み時間範囲変数があります。これらは現在、デフォルトでは常にエポックミリ秒として補間されていますが、日付の書式設定をユーザーが管理できます。

上記の構文は、${__to} としても機能します。

$__interval

$__interval 変数を時間 (InfluxDB 、MySQL、Postgres、MSSQL の場合)、日付ヒストグラム間隔 (Elasticsearch の場合) でグループ化するパラメータとして、または[要約]関数パラメータ (Graphite の場合) として使用できます。

Grafana は、クエリで時間別にグループ化するために使用できる間隔を自動的に計算します。グラフに表示されるデータポイントよりも多い場合、クエリはより長い間隔でグループ化することで、より効率的になります。例えば、3 か月分のデータのグラフを見ている場合、分レベルで詳細を表示できない場合があります。時間別または日別にグループ化すると、グラフの表示内容に影響を与えることなく、クエリの効率が向上します。$__interval は、時間範囲とグラフの幅 (ピクセル数) を使用して計算されます。

概算: (to - from) / resolution

例えば、時間範囲が 1 時間でグラフが全画面表示の場合、間隔は 2m で計算され、ポイントは 2 分間隔でグループ化されます。時間範囲が 6 か月で、グラフが全画面表示の場合、間隔は 1d (1 日) で、ポイントは日ごとにグループ化されます。

InfluxDB データソースでは、レガシー変数 $interval は同じ変数であり、$__interval を代わりに使用すべきです。

InfluxDB データソースと Elasticsearch データソースには、間隔をハードコード化したり、$__interval 変数の最小制限 (Group by time interval など、> 構文を使用して) を設定したりするために使用される >10m フィールドがあります。

$__interval_ms

この変数はミリ秒単位の $__interval 変数であり、時間間隔形式の文字列ではありません。例えば、$__interval が 20m の場合、$__interval_ms は 1200000 です。

$__org

この変数は現在の組織の ID です。 ${__org.name} は現在の組織の名前を表します。

$__user

${__user.id} は現在のユーザーの ID です。 ${__user.login} は現在のユーザーのログインハンドルです。 ${__user.email}は現在のユーザーの E メールです。

$__range

現在、Prometheus および Loki データソースでのみサポートされています。この変数は、現在のダッシュボードの範囲を表します。to - from で計算されます。ミリ秒は $__range_ms、秒は $__range_s で表示されます。

$__rate_interval

現在、Prometheus データソースでのみサポートされています。$__rate_interval 変数は、レート関数で使用することを目的としています。

$timeFilter または $__timeFilter

$timeFilter 変数は、現在選択されている時間範囲を式として返します。例えば、時間間隔「Last 7 days」の式は time > now() - 7d です。

これは、次のようないくつかの場所で使用されます。

連鎖変数

連鎖変数は、リンクされた変数またはネストされた変数とも呼ばれ、変数クエリ内において 1 つ以上の他の変数を持つクエリ変数です。このセクションでは、連鎖変数がどのように機能するかを説明し、連鎖変数を使用するダッシュボード例へのリンクを共有します。

連鎖変数クエリはデータソースごとに異なりますが、前提はすべてのデータソースで同じです。連鎖変数クエリは、それらを使用できる任意のデータソースで使用できます。

非常に複雑なリンクされたテンプレート化されたダッシュボードは、5 または 10 レベルの深さで作成できます。技術的には、どれだけ深く、複雑にできるかに制限はありませんが、リンクが多いほどクエリの負荷が大きくなります。

ベストプラクティスとヒント

以下のプラクティスにより、ダッシュボードと変数の使用が容易になります。

新しいリンクされた変数の作成

変数の順序

ダッシュボード変数リストの変数の順序は、各エントリの右側にある上下の矢印をクリックして変更できます。Grafana は、このリストに従って左から右に変数のドロップダウンを一覧表示し、一番上の変数を左端に表示します。

複雑さに関する考慮事項

変数の依存関係のレイヤーが多いほど、変数を変更した後にダッシュボードを更新するのに時間がかかります。

例えば、4 項目がリンクされた一連の変数 (国、地域、サーバー、メトリック) があり、ルート変数値 (国) を変更する場合、Grafana はダッシュボード内の視覚化を更新する前に、すべての従属変数に対してクエリを実行する必要があります。

変数の管理

変数ページでは、変数を追加し、既存の変数を管理できます。また、変数を検査し、変数が他の変数またはダッシュボードで参照 (または使用されている) されているかどうかを識別することもできます。

[移動] ドラッグアンドドロップを使用して、変数をリストの上または下に移動できます。

[クローン] 変数をクローン (コピー) するには、右側の一連のアイコンからクローンアイコンをクリックします。これにより、元の変数の名前に copy_of_ というプレフィックスが付いた変数のコピーが作成されます。

削除： 変数を削除するには、右側の一連のアイコンからごみ箱アイコンをクリックします。

正規表現での変数のフィルタリング

[正規表現クエリ] オプションを使用して、変数クエリによって返されるオプションの一覧をフィルタリングするか、返されるオプションを変更します。

このページでは、正規表現を使用して変数ドロップダウンの値をフィルタリング/変更する方法を説明します。

[正規表現クエリ] オプションを使用して、変数クエリによって返されるオプションの一覧をフィルタリングするか、返されるオプションを変更します。詳細については、[正規表現]に関する Mozilla ガイドを参照してください。

次の例は、次のオプションリストのフィルタリングを示しています。

backend_01
backend_02
backend_03
backend_04

01 または 02 で終わるオプションのみが返されるようにフィルタリングする

正規表現:

/
(
01|02 
) 
$/

結果:

backend_01
backend_02

正規表現キャプチャグループを使用してテキストの一部を返すオプションのフィルタリングおよび変更

正規表現:

/.* 
(
01|02 
)
/

結果:

01
02

フィルタリングと変更 - Prometheus の例

オプションのリスト:

up{instance="demo.robustperception.io:9090",job="prometheus"} 1 1521630638000
up{instance="demo.robustperception.io:9093",job="alertmanager"} 1 1521630638000
up{instance="demo.robustperception.io:9100",job="node"} 1 1521630638000

正規表現:

/. *instance="
(
[^"]*
)
.*/

結果:

demo.robustperception.io:9090
demo.robustperception.io:9093
demo.robustperception.io:9100

名前付きテキストおよび値キャプチャグループを使用してフィルタリングおよび変更する

名前付きキャプチャグループを使用すると、変数クエリによって返されるオプションから「テキスト」部分と「値」部分を別々にキャプチャできます。これにより、変数ドロップダウンリストに、選択できる各値に対するわかりやすい名前を含めることができます。

例えば、node_hwmon_chip_names Prometheus メトリクスをクエリする場合、 chip_nameは chip 値よりもはるかにわかりやすくなります。したがって、次の変数クエリの結果は以下のとおりになります。

node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_0",chip_name="enp216s0f0np0"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_1",chip_name="enp216s0f0np1"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_2",chip_name="enp216s0f0np2"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_3",chip_name="enp216s0f0np3"} 1

次の正規表現を渡す:

/chip_name="(?<text>[ ^ " ] + ) |chip=" (?<value >[ ^ " ] + )/g

次のドロップダウンリストを生成:

Display Name          Value
------------          -------------------------
enp216s0f0np0         0000:d7:00_0_0000:d8:00_0
enp216s0f0np1         0000:d7:00_0_0000:d8:00_1
enp216s0f0np2         0000:d7:00_0_0000:d8:00_2
enp216s0f0np3         0000:d7:00_0_0000:d8:00_3

text および value キャプチャグループ名のみがサポートされています。

変数ページでは、変数が他の変数またはダッシュボードで参照 (または使用) されているかどうかを簡単に識別できます。

参照または使用される変数の横には緑色のチェックマークが付き、参照されていない変数の横にはオレンジ色の注意アイコンが付きます。さらに、参照されるすべての変数には、緑色のチェックマークの横にある依存関係アイコンがあります。アイコンを選択すると、依存関係マップが表示されます。依存関係マップは移動できます。マウスホイールまたは同等の機能を使用してズームインまたはズームアウトできます。