変数タイプ

Grafana は、変数のタイプをいくつか使用します。

クエリ変数の追加

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

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

クエリ式

クエリ式はデータソースごとに異なります。詳細については、データソースに接続するのデータソースに関するドキュメントを参照してください。

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

クエリオプションの入力

カスタム変数の追加

変更されない値にはカスタム変数を使用します。これは、数値、文字列、またはその他の変数である場合があります。

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

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

カスタムオプションの入力

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

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

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

テキストオプションの入力

定数変数の追加

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

定数変数は複数設定できません。各定数変数は 1 つの値のみを保持します。更新するには、変数設定を更新する必要があります。

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

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

定数オプションの入力

データソース変数の追加

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

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

データソースオプションの入力

間隔変数の追加

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

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

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

間隔オプションの入力

間隔変数の例

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

summarize($myinterval, sum, false)

より複雑な Graphite の例:

groupByNode(summarize(movingAverage(apps.$app.$server.counters.requests.count, 5), '$interval', 'sum', false), 2, 'sum')

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

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

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

オプションの入力

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

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

連鎖変数

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

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

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

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

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

新しい連鎖変数の作成

変数の順序

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

複雑さに関する考慮事項

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

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

グローバル変数

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

$__dashboard

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

$__from および $__to

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

上記の構文は「${__to}」を使用しても機能します。

この変数は URL でも使用できます。例えば、6 時間前から現在までの時間範囲を示すダッシュボードにエンドユーザーを送信するには、次の URL を使用します。https://play.grafana.org/d/000000012/grafana-play-home?viewPanel=2&orgId=1?from=now-6h&to=now

$__interval

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

Grafana ワークスペースは、クエリで時間別にグループ化するために使用できる間隔を自動的に計算します。グラフに表示されるデータポイントよりも多い場合、クエリはより長い間隔でグループ化することで、より効率的になります。例えば、3 か月分のデータを調べる場合、1 日でグループ化する方が 10 秒でグループ化するよりも効率的です。グラフは同じように見え、クエリは高速になります。$__interval は、時間範囲とグラフの幅 (ピクセル数) を使用して計算されます。

概算: (from - to) / resolution

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

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

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

$__interval_ms

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

$__name

この変数は Singlestat パネルでのみ使用でき、[オプション] タブのプレフィックスまたはサフィックスフィールドで使用できます。変数は系列名またはエイリアスに置き換えられます。

$__org

この変数は、現在の組織 ID です。変数 ${__org.name} は、現在の組織名称です。

$__user

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

$__range

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

$timeFilter または $__timeFilter

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

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