- 重要な情報
- はじめに
- 用語集
- ガイド
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- Service Management
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
テンプレート変数を使用すると、ダッシュボード内の 1 つまたは複数のウィジェットを動的にフィルターできます。テンプレート変数の選択から保存ビューを構築することができ、ドロップダウン選択によって視覚化を整理して操作することができます。
テンプレート変数は、以下のように定義されます。
<KEY>:<VALUE>
) に従う場合、Tag は <KEY>
となります。*
です。(all)
です。利用可能な値のリストには、常に *
が含まれており、タグや属性の全ての値をクエリすることができます。ダッシュボードにテンプレート変数を追加するには
team
がダッシュボード上の 2 つのグラフで使用されています。ダッシュボードのテンプレート変数の左側にある Saved Views ドロップダウンメニューをクリックします。テンプレート変数の値を更新しても、その値が自動的にビューに保存されるわけではありません。
現在のテンプレート変数の値をビューに保存するには、Saved Views ドロップダウンメニューから Save selections as view を選択します。ビューの一意な名前を入力し、Save をクリックします。
保存ビューがドロップダウンメニューに表示されます。ビューをクリックすると、以前に保存したテンプレート変数の値が表示されます。
ビューを削除するには、保存ビューのドロップダウンメニューをクリックし、Manage views… を選択します。それぞれのビューの横に、保存されているビューのポップアップがごみ箱アイコンとともに表示されます。ビューを削除するには、該当するごみ箱アイコンをクリックして下さい。
Default view を変更するには、鉛筆アイコンをクリックしてテンプレート変数の値を更新します。次に、Done をクリックして保存します。他のビューで値を更新した場合は、その値を新規のビューとして保存し、元のビューを削除します。
テンプレート変数は、ウィジェットとイベントオーバーレイに使用されます。
テンプレート変数は、ログ、APM、および RUM ウィジェットで動作します。ファセットに基づいて、ログ、APM、RUM のテンプレート変数を定義することができます。これらの変数は @
で始まり、例えば @http.status_code
のようになります。
ログ、APM、および RUM ウィジェットでは、値の途中でワイルドカードを使用したり (たとえば、eng*@example.com
)、値の中で複数のワイルドカードを使用したり (たとえば、*prod*
) することが可能です。
注: このタイプのテンプレート変数に Add to all を適用すると、すべてのログ、APM、RUM ウィジェットに変数が追加されます。
ウィジェットを作成または編集する場合、既存のテンプレート変数が from
フィールドにオプションとして表示されます。例えば、テンプレート変数 environment
を構成した場合、$environment
オプションはウィジェット内の動的変数として利用できます。
環境変数 environment
に production を選択すると、$environment
変数を持つウィジェットが本番環境に動的にスコープされます。
テンプレート変数の値を変更する場合、ダッシュボード URL はそのテンプレート変数の値を反映するよう、&tpl_var_<TEMPLATE_VARIABLE_NAME>=<TEMPLATE_VARIABLE_VALUE>
というフォーマットで更新されます。たとえば、テンプレート変数が $env
のダッシュボードで値が prod
に変更された場合、URL のパラメーターは &tpl_var_env=prod
となります。
値をクエリに含めるには、{TX-PL-LABEL}lt;TEMPLATE_VARIABLE_NAME>.value
という構文で値を追加します。例えば、service
という名前のテンプレート変数では、 env:staging-$service.value
を使用します。
テンプレート変数のフィールドにカーソルを合わせると、その変数を使用するウィジェットがダッシュボード上でハイライト表示され、一目でわかります。
テンプレート変数の値を選択すると、セレクターの上部に関連値が表示されます。関連値は、ページ上で選択されている他のテンプレート変数の値から計算され、構成することなくシームレスに関連値を識別することができます。
テキストベースのウィジェットでは、テンプレート変数のタグ/属性と値を {TX-PL-LABEL}lt;TEMPLATE_VARIABLE_NAME>
で、キーを {TX-PL-LABEL}lt;TEMPLATE_VARIABLE_NAME>.key
で、または値を {TX-PL-LABEL}lt;TEMPLATE_VARIABLE_NAME>.value
で表示させることができます。これは、英数字でない任意の文字の後に来ることができ、空白や以下の文字のいずれかが続くことができます: #
、{TX-PL-LABEL}#x60;、
%、
=、
;、
"、
(、
)、
[、
]、
{、
}、
^、
*、
+、
|、
?`
注: ワイルドカード構文は、テンプレート変数の後にはサポートされていません。
例えば、テンプレート変数が env
で、タグ/属性が environment
で、選択値が dev
である場合:
$env
には environment:dev
と表示されます$env.key
には environment
と表示されます$env.value
には dev
が表示されますdev{dynamic-wildcard-value}
ではなく、$env*
は 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
テンプレート変数ドロップダウンメニューにある値のイベントを検索します。