概要
テンプレート変数により、ダッシュボード内の 1 つ以上のウィジェットを動的にフィルタリングできます。テンプレート変数の選択から保存ビューを構築し、ドロップダウン選択によって視覚化を整理して操作することができます。
テンプレート変数は、以下によって定義されます。
- Tag or Attribute:
- Name: ダッシュボード上のクエリに表示されるテンプレート変数の一意の名前です。テンプレート変数は、選択されたタグまたは属性の後に自動的に名前が付けられます。
- Default Value: ダッシュボードが読み込まれたときに自動的に表示されるタグまたは属性の値です。デフォルトは
* です。 - Available Values: ドロップダウンメニューで選択可能なタグまたは属性の値です。デフォルトは
(all) です。利用可能な値のリストには、常に * が含まれており、タグや属性の全ての値をクエリすることができます。
テンプレート変数の値
テンプレート変数の値 (テンプレート変数のドロップダウンメニューで利用可能な値) は、ダッシュボード内のウィジェットが使用しているソースに基づいて入力されます。例えば、ログをクエリするウィジェットがダッシュボードにある場合は、ログからの値のみが表示されます。ログ、メトリクス、RUM をクエリするウィジェットがダッシュボードにある場合は、ログ、メトリクス、RUM からの値が表示されます。
ほとんどのソースにおいて、テンプレート変数の値はダッシュボードのグローバルな時間枠に関連しています。例:
- ダッシュボードの時間枠が過去 15 分に設定されている場合、過去 15 分のテンプレート変数の値のみが表示されます。
- ダッシュボードの時間枠が 8 月 15 日午前 0 時から午後11時59分に設定されている場合、その時間枠の値のみが表示されます。
| データソース | データクエリ期間 |
|---|
| メトリクス | 現在 - 48 時間 |
| クラウドコスト | 現在 - 48 時間 |
| その他すべてのソース | ダッシュボードの時間枠 |
注: お探しのタグや属性が表示されない場合、そのデータが最近 Datadog に報告されていない可能性があります。さらに、テンプレート変数のためにクエリされたすべてのデータは保持ポリシーの対象となります。詳細については、履歴データを参照してください。
ダッシュボードレイアウト
変数がヘッダーを圧迫しないように、ダッシュボードは小さなサブセットを表示します。+ N ボタンをクリックすると、ダッシュボードに存在する追加の N 変数を見ることができます。
スクロールしながらすべての変数を一度に表示する必要がある場合は、テンプレート変数を展開をクリックします。
テンプレート変数の追加
ダッシュボードにテンプレート変数を追加するには
- Add Variable (または、既存のテンプレート変数がある場合は +) をクリックします
- 推奨されるテンプレート変数のリストから選択するか、特定のタグを検索します。
- このテンプレート変数を適用するウィジェットを選択します。
- Save をクリックします。
テンプレート変数のサイドパネルが開いている状態で次のことができます。
- 選択したウィジェットにこの変数を適用 (または削除) する (Select All または Deselect All オプションに注意する)
- フィルタリングとグループ化を切り替える
- 変数の表示名を変更する (ヘッダーとウィジェットクエリに表示)
- デフォルトのドロップダウン値を選択する
- ドロップダウン値をプレビューし、検索クエリでさらに構成する
テンプレート変数の編集
- ダッシュボードヘッダー上のテンプレート変数にカーソルを合わせ、編集をクリックします。テンプレート変数のサイドパネルが表示されます。
- パネルのオプションを使用して、変数をカスタマイズするか、より多くのウィジェットに変数を適用します。
保存済みビュー
作成
- ダッシュボードのテンプレート変数の左にある Saved Views ドロップダウンメニューをクリックします。テンプレート変数の値を更新する際、その値は自動的にビューに保存されません。
- 現在のテンプレート変数の値をビューに保存するには、Saved Views ドロップダウンメニューから Save selections as view を選択します。
- ビューの一意の名前を入力し、任意で説明を追加します。
- Save をクリックします。
保存済みビューがドロップダウンメニューに表示されます。ビューをクリックすると、以前に保存したテンプレート変数の値が表示されます。
削除
- 保存済みビューのドロップダウンメニューをクリックし、希望の保存済みビューにカーソルを合わせます。
- Delete View をクリックします。
変更
Default view は、テンプレート変数のデフォルト値を変更することでのみ編集できます。デフォルトビューを編集するには
- テンプレートにカーソルを合わせます。
- ボタンが表示されたら、Edit をクリックします。
- Done をクリックして保存します。
他の保存済みビューのテンプレート変数の値を変更するには
- ドロップダウンメニューから希望の保存済みビューを選択します。
- テンプレート変数を編集して、新しいモデルを構成します。
- ドロップダウンメニューを再度開きます。
- Save Changes をクリックします。
タイトルと説明を編集するには
- ドロップダウンメニューから希望の保存済みビューにカーソルを合わせます。
- Edit をクリックします。
- タイトルまたは説明を変更します。
- Save をクリックします。
使用方法
テンプレート変数は、ウィジェットとイベントオーバーレイに使用されます。
ログ、APM、および RUM クエリ
テンプレート変数は、ログ、APM、および RUM ウィジェットで動作します。ファセットに基づいて、ログ、APM、RUM のテンプレート変数を定義することができます。これらの変数は @ で始まり、例えば @http.status_code のようになります。
ログ、APM、および RUM ウィジェットでは、値の途中でワイルドカードを使用したり (たとえば、eng*@example.com)、値の中で複数のワイルドカードを使用したり (例: *prod*) することが可能です。
注: このタイプのテンプレート変数に Add to all を適用すると、すべてのログ、APM、RUM ウィジェットに変数が追加されます。
ウィジェットを作成または編集する場合、既存のフィルターテンプレート変数が from フィールドにオプションとして表示され、テンプレート変数ごとの既存のグループが by フィールドの後にオプションとして表示されます。例えば、environment テンプレート変数を構成する場合、$environment オプションがウィジェット内の動的変数として利用できます。
環境変数 environment に production を選択すると、$environment 変数を持つウィジェットが本番環境に動的にスコープされます。
テンプレート変数の値を変更する場合、ダッシュボード URL はそのテンプレート変数の値を反映するよう、&tpl_var_<TEMPLATE_VARIABLE_NAME>=<TEMPLATE_VARIABLE_VALUE> というフォーマットで更新されます。たとえば、テンプレート変数が $env のダッシュボードで値が prod に変更された場合、URL のパラメーターは &tpl_var_env=prod となります。
値をクエリに含めるには、$<TEMPLATE_VARIABLE_NAME>.value という構文で値を追加します。例えば、service という名前のテンプレート変数では、env:staging-$service.value を使用します。
テンプレート変数のフィールドにカーソルを合わせると、その変数を使用するウィジェットがダッシュボード上でハイライト表示され、一目でわかります。
関連するテンプレート変数
テンプレート変数の値を選択すると、セレクターの上部に関連値が表示されます。関連値は、ページ上で選択されている他のテンプレート変数の値から計算され、構成することなくシームレスに関連値を識別することができます。
テキスト
テキストベースのウィジェットでは、テンプレート変数のタグ/属性と値を $<TEMPLATE_VARIABLE_NAME> で、キーを $<TEMPLATE_VARIABLE_NAME>.key で、または値を $<TEMPLATE_VARIABLE_NAME>.value で表示させることができます。これは、英数字でない任意の文字の後に来ることができ、空白や以下の文字のいずれかを続けることができます。#、$、%、=、;、"、(、)、[、]、{、}、^、*、+、|、?。
注: ワイルドカード構文は、テンプレート変数の後にはサポートされていません。
例えば、テンプレート変数が env で、タグ/属性が environment で、選択値が dev である場合:
$env は environment:dev を表示します$env.key は environment を表示します$env.value は dev を表示します$env* は dev{dynamic-wildcard-value} ではなく dev* という正確な値を探します
イベントオーバーレイ
ダッシュボードで特定のタグとメトリクスに紐付くイベントを検索するには、テンプレート変数のイベントオーバーレイ検索が便利です。イベントオーバーレイ検索は個別のグラフに適用されます。
イベント検索フィールドで $<TEMPLATE_VARIABLE_KEY>.value 構文を使用すると、ダッシュボードテンプレート変数の値を直接キャプチャできます。
注: ダッシュボードのテンプレート変数は、イベントタグではなく、メトリクスタグである必要があります。
ダッシュボード
ダッシュボードから、以下のフォーマットを使用してテンプレート変数を持つイベントを検索します。
<TAG_KEY>:$<TEMPLATE_VARIABLE_NAME>.value
例えば、region:$region.value を、region テンプレート変数についての us-east1 の値で検索すると、region:us-east1 でタグ付けされたイベントが表示されます。さらに、イベントのタイミングがグラフ上にピンクのバーで示されます。
複数のテンプレート変数で検索するには、コンマを入れます (例: role:$role.value,env:$env.value)
注: 検索を実行する際に enter を押すと、$region.value がテンプレート変数ドロップダウンメニューの値に更新されます。
以下のフォーマットで、ウィジェットからテンプレート変数を使用したイベントのタイミングをオーバーレイします。
$<TEMPLATE_VARIABLE_NAME>
例えば、イベントオーバーレイ検索ボックスに $region と入力します。これにより、region テンプレート変数ドロップダウンメニューにある値のイベントを検索します。
参考資料
