通知メッセージ内で変数を使用すれば、条件付き変数を使用して条件付きメッセージを表示したり、通知をさまざまなチームにルーティングしたり、属性とタグ変数およびテンプレート変数を使用してそのコンテンツをリッチ化したりできます。

条件付き変数

条件付き変数は、if-else ロジックを使用して、モニターの状態やトリガーされた詳細に応じて異なるメッセージを表示します。これらの変数は、通知メッセージの件名や本文の中で使用できます。

以下の条件付き変数を使用できます。

例

条件付き変数には、テキストと @-notifications の間に開始と終了のペアが必要です。モニターの状態に基づく変数 (is_alertやis_warningなど) には、それぞれ独自のメッセージブロックがなければなりません。モニターは同時に 1 つの状態にしか存在できないため、それらを組み合わせることはできません。ただし、属性に基づいて一致する条件をネストすることは可能です。is_renotify の例を参照してください。

{{#is_alert}}
  <ALERT_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_alert}}

{{#is_warning}}
  <WARNING_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_warning}}

{{#is_recovery}}
  <RECOVERY_MESSAGE_TEXT> <@-NOTIFICATION>
{{/is_recovery}}

{{#is_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  This displays if <COMPARISON_STRING> is included in <TAG_VARIABLE>.
{{/is_match}}

{{#is_match "host.role.name" "db"}}
  This displays if the host triggering the alert contains `db`
  in the role name. @db-team@company.com
{{/is_match}}

{{#is_match "host.role.name" "db" "database"}}
  This displays if the host triggering the alert contains `db` or `database`
  in the role name. @db-team@company.com
{{/is_match}}

{{^is_match "host.role.name" "db"}}
  This displays if the role tag doesn't contain `db`.
  @slack-example
{{/is_match}}

{{#is_match "host.role.name" "db"}}
  This displays if the host triggering the alert contains `db`
  in the role name. @db-team@company.com
{{else}}
  This displays if the role tag doesn't contain `db`.
  @slack-example
{{/is_match}}

{{#is_exact_match "<TAG_VARIABLE>.name" "<COMPARISON_STRING>"}}
  This displays if <COMPARISON_STRING> is exactly <TAG_VARIABLE>.
{{/is_exact_match}}

{{#is_exact_match "host.name" "production"}}
  This displays if the host that triggered the alert is exactly
  named production. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "host.name" "production" "staging"}}
  This displays if the host that triggered the alert is exactly
  named production or staging. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "value" "<VALUE>"}}
  This displays if the value that breached the threshold of the monitor is exactly <VALUE>.
{{/is_exact_match}}

{{#is_exact_match "value" "5"}}
  This displays if the value that breached the threshold of the monitor is 5. @dev-team@company.com
{{/is_exact_match}}

{{#is_exact_match "host.datacenter" ""}}
  This displays if the attribute or tag does not exist or if it's empty
{{/is_exact_match}}

{{#is_renotify}}
{{#is_match "env" "production"}}
  This is an escalation message sent to @dev-team@company.com
{{/is_match}}
{{/is_renotify}}

{{^is_renotify}}
This monitor is alerting and sending a first message @dev-team@company.com

To solve this monitor follow the steps:
1. Go there
2. Do this
{{/is_renotify}}

This part is generic and sent both for the first trigger and the escalation message.

{{#is_renotify}}
  This is the escalation message @dev-team@company.com
{{/is_renotify}}

This part is generic and sent both for the first trigger and the escalation message.

This is the escalation message @dev-team@company.com

alert または warning の状態に遷移する条件ブロックを @-notifications ハンドルで構成した場合、Datadog では、そのハンドルに回復通知を送るために、対応する recovery 条件を構成することが推奨されます。

注: 構成されている条件付き変数の外側にあるテキストまたは通知ハンドルは、あらゆるモニター状態遷移で呼び出されます。構成されている条件付き変数の内側にあるテキストまたは通知ハンドルは、モニター状態遷移がその条件に一致する場合にのみ呼び出されます。

属性変数とタグ変数

属性変数とタグ変数を使用して、カスタマイズされた、有益で、特定のアラートメッセージを表示して、アラートの性質を理解できるようにします。以下のセクションにある例と使用例を参照してください。

• マルチアラート変数
• 一致する属性/タグ変数

タグ

自動的に添付される (ホスト名、コンテナ名、ログファイル名、サーバーレス関数名など) か、カスタムタグを通じて追加される (担当チーム、環境、アプリケーション、バージョンなど)。

属性

ログの内容に基づいており、リファレンステーブルから解析または追加されたもの (geoip など)。

注: データがない状態 (例えば、クエリに一致するイベントがない状態) でモニターが回復するように構成されている場合、回復メッセージにはデータは含まれません。回復メッセージの情報を保持するには、{{tag.name}}` でアクセスできる追加のタグでグループ化します。

マルチアラート変数

マルチアラートグループボックスで選択した次元に基づいて、マルチアラートモニターでマルチアラート変数を設定します。各アラートにおいて、グループの基準となる次元に関連付けられた値を動的に含めることにより、通知を充実させます。

注: 集約で group_by フィールドを使用する場合、モニターからの追加のタグやアラートが自動的に継承されることがあります。これは、監視対象のエンドポイントに設定されたアラートや構成が、集約結果の各グループに適用される可能性があることを意味します。

{{ key.name }}

{{[dot.key.test].name}}

{{ @facet_key.name }}

This alert was triggered on {{ @machine_id.name }}

{{ [@network.client.ip].name }}

通知をグループごとにカスタマイズする

クエリが特定のディメンションでグループ化されている場合、そのグループに関連する動的メタデータを活用して通知を拡充できます。タグの選択に基づいてタグ変数のリストを表示するには、通知と自動化の構成セクションで メッセージテンプレート変数を使用するをクリックします。次の例をご覧ください。

{{service.links[Runbook]}}

一致する属性/タグ変数

モニタークエリに一致するログ、トレーススパン、RUM イベント、CI パイプラインまたは CI テストイベントから任意の属性またはタグを含めることができます。次の表は、さまざまなモニタータイプから追加できる属性と変数の例を示しています。

重要な注意事項

• 選択されたイベントに属性もタグキーも含まれていない場合、通知メッセージの中でその変数は空になります。通知が欠落しないようにするには、{{#is_match}}` のハンドルで通知をルーティングする目的でこれらの変数を使用しないようにしてください。
• クエリで数式と関数を使用するモニターの場合、値は最初のクエリから抽出されるイベントに基づいて解決されます。

予約済み属性

ログ、イベント管理、スパン、RUM、CI パイプライン、CI テストイベントには、次の構文の変数で使用できる一般的な予約済み属性があります。

一致するイベントの定義に属性が含まれていない場合、変数は空になります。

エクスプローラーリンク

{{log.link}}, {{span.link}}, {{rum.link}}, and {{issue.link}} を使用して、クエリに一致するイベントを対象としたログエクスプローラー、トレースエクスプローラー、RUM エクスプローラー、またはエラー追跡へのリンクで通知を充実させます。

チェックモニター変数

チェックモニター変数 (カスタムチェックおよびインテグレーションチェック) には、変数 {{check_message}} が利用可能で、カスタムチェックまたはインテグレーションチェックで指定されたメッセージを表示します。

複合条件モニター変数

複合条件モニターは、アラートがトリガーされたときにサブモニターに関連付けられた値とステータスにアクセスできます。

たとえば、複合条件モニターにサブモニター a がある場合、a の値を次で含めることができます。

{{ a.value }}

サブモニター a のステータスを取得するには、以下を使用します。

{{ a.status }}

ステータスとして可能な値は、OK、Alert、Warn、および No Data です。

複合条件モニターは、基底のモニターと同様の方法でタグ変数もサポートします。基底のモニターが同じタグ/ファセットでグループ化されていることを条件に、複合条件モニターは他のモニターと同様の形式に従います。

たとえば、複合条件モニターにサブモニター a があり、それがログモニターであるとします。この場合は、次の方法で a のタグまたはファセットの値を含めることができます。

{{ a.log.message }} or {{ a.log.my_facet }}

文字エスケープ

デフォルトの場合、変数の内容は HTML エンコードされます。生の内容を未エンコードで出力するには、二重波括弧の代わりに三重波括弧を使用します。

たとえば、変数の値にクエリパラメーターを含む URL がある場合、& は、使用されているのが二重波括弧かそれとも三重波括弧かに応じて異なる扱いになります。

たとえば、HTML エンコーディングなしでチェックメッセージをレンダリングするには、次のようにします。

{{{check_message}}}

これが特に重要になるのは、{{check_message}} contains auto-generated URLs with query parameters (for example, on HTTP Check monitors). The & characters in those URLs are HTML-encoded by default, which can break clickable links in notifications. Use {{{check_message}}} で URL をそのまま保持する場合です。

テンプレート変数

テンプレート変数は、モニター通知をカスタマイズするために使用します組み込み変数には、次のものがあります。

トリガーされた変数

{{first_triggered_at}}, {{first_triggered_at_epoch}}, {{last_triggered_at}}, and {{last_triggered_at_epoch}} monitor template variables reflect the values when a monitor changes state, NOT when a new monitor event occurs. Renotification events show the same template variable if the monitor state has not changed. Use {{triggered_duration_sec}}。これらは、モニターイベントの時点での継続時間を表示するためのものです。

{{first_triggered_at}} is set when the monitor group goes from OK to a non-OK state or when a new group appears in a non-OK state. {{last_triggered_at}} gets set when the monitor group goes to a non-OK state independently from its previous state (including WARN → ALERT, ALERT → WARN). Additionally, {{last_triggered_at}} is set when a new group appears in a non-OK state. The difference is that {{last_triggered_at}} はその前の状態とは独立しています。

例: モニターが OK → WARN と遷移する場合、{{first_triggered_at}} and {{last_triggered_at}} の値のタイムスタンプはどちらも A になります。モニターが回復するまでの値を下表に示します。

評価

数値を返すテンプレート変数は、算術演算と関数をサポートしています。これにより、数値の算術演算や値のフォーマット変更を実行できます。詳細については、テンプレート変数の評価を参照してください。

ローカルタイム

local_time使うと、通知の中に好きなタイムゾーンで別の日付を追加することができます。この関数は、日付をローカルタイムに変換します: {{local_time 'time_variable' 'timezone'}}。 例えば、東京のタイムゾーンで最後にトリガーされたモニターの時刻を通知に追加するには、通知メッセージに次のように記述します。

{{local_time 'last_triggered_at' 'Asia/Tokyo'}}

結果は ISO 8601 形式で表示されます: yyyy-MM-dd HH:mm:ss±HH:mm、たとえば 2021-05-31 23:43:27+09:00 のようになります。 利用可能なタイムゾーンの値については、tz データベースのタイムゾーンリストで、TZ データベース名の列をご参照ください。

高度な

ダイナミックハンドル

タグ変数を使用して、通知ハンドルを動的に構築し、モニターが検出した問題の種類に基づいて、通知を適切なチームまたはサービスにルーティングします。

例: モニターがメトリクスをクエリし、service タグでグループ化すると、失敗したサービスに応じて異なる Slack チャンネルに通知をルーティングさせることができます。

@slack-{{service.name}} There is an ongoing issue with {{service.name}}.

service:ad-server グループでモニターが失敗し始めると、#ad-server Slack チャンネルに以下の内容で通知が送信されます。

@slack-ad-server There is an ongoing issue with ad-server.

常に存在するとは限らない属性を用いて動的ハンドルを構築する場合、通知の配信に問題が生じる可能性があります。属性が欠けている場合、その変数は通知メッセージ内で空としてレンダリングされ、無効なハンドルとなります。

これらの変数を用いた動的ハンドルで通知が失われないよう、フォールバックハンドルを必ず追加してください。

{{#is_exact_match "kube_namespace.owner" ""}}
  @slack-example
  // This will notify @slack-example if the kube_namespace.owner variable is empty or does not exist.
{{/is_exact_match}}

ダイナミックリンク

タグ変数を使用して、チームを適切なリソースにリンクする動的 URL 構築を有効にします。たとえば、ダッシュボード、ホストマップ、モニターなどの Datadog 内のページへのリンクを提供できます。

https://app.datadoghq.com/dash/integration/system_overview?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dash/integration/<INTEGRATION_NAME>?tpl_var_scope=host:{{host.name}}

https://app.datadoghq.com/dashboard/<DASHBOARD_ID>/<DASHBOARD_NAME>?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

https://app.datadoghq.com/infrastructure/map?filter=service:{{service.name}}

https://app.datadoghq.com/monitors/manage?q=scope:host:{{host.name}}

https://app.datadoghq.com/logs?from_ts={{eval "last_triggered_at_epoch-10*60*1000"}}&to_ts={{eval "last_triggered_at_epoch+10*60*1000"}}&live=false

コメント

モニターのメッセージにコメントを含めるには、次の構文を使用します。

{{!-- this is a comment --}}
{{!-- this is a comment }}

未加工の形式

アラートメッセージで {{ <TEXT> }} などの二重中括弧を送信する必要がある場合は、{{ <TEXT> }}, use {{{{raw}}}}` の形式を使用します。たとえば、次のようになります。

{{{{raw}}}}
{{ <TEXT_1> }} {{ <TEXT_2> }}
{{{{/raw}}}}

出力:

{{ <TEXT_1> }} {{ <TEXT_2> }}

条件付き変数で使用されている ^|# ヘルパーは、{{{{raw}}}}formatting and must be removed. For instance, to output raw text with the形式と共に使用できず、削除する必要があります。たとえば、``{{is_match}}` 条件付き変数を使用してテキストをそのまま出力するには、次のテンプレートを使用します。

{{{{is_match "host.name" "<HOST_NAME>"}}}}
{{ .matched }} the host name
{{{{/is_match}}}}

host.name が <HOST_NAME> と一致する場合、テンプレートは次を出力します。

{{ .matched }} the host name

URL Encode

アラートメッセージに URL でエンコードする必要がある情報が含まれている場合 (たとえば、リダイレクトの場合)、{{ urlencode "<variable>"}} 構文を使います。

例: モニターメッセージに特定のサービスにフィルタリングされた Software Catalog への URL が含まれている場合、service タグ変数を使い、URL に {{ urlencode "<variable>"}} 構文を追加します。

https://app.datadoghq.com/services/{{urlencode "service.name"}}

参考資料

お役に立つドキュメント、リンクや記事:

テンプレート変数の評価による算術演算と関数の実行ガイド モニターの作成ドキュメント モニター通知ドキュメント モニターの管理ドキュメント アラートモニター通知をカスタマイズするコースを受講するラーニングセンター Datadog モニター通知ルールでモニター アラートをルーティングするブログ