テンプレート変数
Dash が新機能を発表!インシデントマネジメント、Continuous Profiler など多数の機能が追加されました! Dash イベントで発表された新機能!

テンプレート変数

テンプレート変数により、ダッシュボード内の 1 つ以上のウィジェットを動的にフィルタリングすることができます。

作成

ダッシュボードに最初のテンプレート変数を作成するには、Add Template Variables をクリックします。テンプレート変数が既に定義されている場合は、鉛筆 アイコンをクリックしてテンプレート変数エディタを開きます。編集モードでAdd Variable + をクリックしてテンプレート変数を追加します。

テンプレート変数は、以下のように定義されます。

  • Name: テンプレート変数固有の名前です。この名前はダッシュボードの内容をフィルタリングするのに使用されます。
  • Tag or Attribute:
  • Default Value: テンプレート変数のタグまたは属性のデフォルト値。

テンプレート変数を作成後、その変数を使用しているソースの数がDatadog に表示されます。下の例では、2 つのグラフの内の 1 つでテンプレート変数が使用されています。

個々のウィジェットでテンプレート変数を使用 するか、Add to All オプションをクリックします。すべてのウィジェットからテンプレート変数を削除するには、Remove From All オプションをクリックします。

ログ、APM、RUM クエリ

テンプレート変数はログ、APM、RUM ウィジェットと連動しています。これはメトリクス、ログ、APM、および RUM が同じタグを共有しているためです。 ログ、APM、RUM のテンプレート変数はログ、APM、RUM ファセットに基づいて定義することができます。これらの変数は @http.status_code のように @ から始まる値となります。

: このタイプのテンプレート変数に Add to all を適用すると、すべてのログ、APM、RUM ウィジェットに変数が追加されます。

保存済みビュー

作成

ダッシュボードでは、テンプレート変数画面の左側に (Default Value) というドロップダウンリストが表示されています。テンプレート変数の値を変更しても、その値はビューに自動保存されません。 ビューでテンプレート変数の現在値を保存するには、ドロップダウンメニューをクリックし、Save selections as view をクリックします。次の画面でビューに一意の名前を入力し、保存するとそのビューがドロップダウンメニューに表示されます。過去に保存したテンプレート変数の値を復元する場合は、ここから該当するビューをクリックします。

削除

ビューを削除するには、保存済みビューのドロップダウンをクリックし、Manage views… を選択します。それぞれのビューの横に、保存されているビューのポップアップがごみ箱アイコンとともに表示されます。ビューを削除するには、該当するごみ箱アイコンをクリックして下さい。

変更

(Default Value) のビューを変更するには、鉛筆アイコンをクリックしてテンプレート変数の値を更新します。次に、Done をクリックして保存します。他のビューで値を更新した場合は、その値を新規のビューとして保存し、元のビューを削除します。

使用

テンプレート変数は、ウィジェットとイベントオーバーレイに使用されます。

ウィジェット

ウィジェットを作成または編集する場合、既存のテンプレート変数が from フィールドにオプションとして表示されます。例えば、テンプレート変数 env を作成する場合、オプション $env が利用可能です。

ウィジェットが保存されると、テンプレート変数の値はダッシュボードの上から選択されたものとなります。

テキスト

テキストベースのウィジェットには、テンプレート変数の名前と値を $<テンプレート変数名> と共に、または値だけを $<テンプレート変数名> と共に表示できます。例として、名前が env、選択された値が dev のテンプレート変数の場合、

  • $env には env:dev と表示されます
  • $env.value には dev が表示されます

イベントオーバーレイ

ダッシュボードで特定のタグとメトリクスに紐付くイベントを検索するには、テンプレート変数のイベントオーバーレイ検索が便利です。イベントオーバーレイ検索は個別のグラフに適用されます。

イベント検索フィールドで $<TEMPLATE_VARIABLE_KEY>.value 構文を使用すると、ダッシュボードテンプレート変数の値を直接キャプチャできます。

: ダッシュボードのテンプレート変数は、イベントタグではなく、メトリクスタグである必要があります。

ダッシュボード

ダッシュボードから、以下のフォーマットを用いたテンプレート変数のイベントストリームを検索します。

tags:<TAG_KEY>:$<TEMPLATE_VARIABLE_NAME>.value

例えば、tags:region:$region.value を、region テンプレート変数についての us-east1 の値で検索すると、region:us-east1 でタグ付けされたイベントが表示されます。さらに、イベントのタイミングがグラフ上にピンクのバーで示されます。

複数のテンプレート変数で検索するには、コンマを入れます(例: tags:role:$role.value,env:$env.value

: 検索を実行する際に enter を押すと、$region.value がテンプレート変数ドロップダウンの値に更新されます。

ウィジェット

以下のフォーマットで、ウィジェットからテンプレート変数を使用したイベントのタイミングをオーバーレイします。

tags:$<TEMPLATE_VARIABLE_NAME>

例えば、イベントオーバーレイ検索ボックスに tags:$region と入力して、region テンプレート変数ドロップダウンにある値のイベントを検索します。

その他の参考資料