カスタムイベント通知テンプレート¶

テンプレート構文を使用して、イベント通知の内容をカスタマイズできます：

• 動的レンダリング：{{ フィールド名 }} を使用してアラートフィールドを直接挿入（例：{{ host }}、{{ df_status }}）

• データ処理：{{ 変数 | 関数() }} を使用してデータをフォーマット（例：タイムスタンプの日付変換、数値のパーセンテージ変換）

• 条件分岐：{% if ... %} を使用して異なるステータスに応じた通知を実現

• リアルタイムクエリ：DQL（"クエリ文"）を埋め込んで関連データを取得（例：ホストIP、アプリケーション情報）

基本テンプレート変数¶

テンプレート変数の基本構文は {{ フィールド名 }} で、イベントに関連する動的情報をレンダリングするために使用されます。以下は一般的なテンプレート変数とその用途です：

テンプレート変数の例¶

モニターの by に region と host が設定され、イベント内容のテンプレートが以下の通りだとします：

イベント名：

モニター {{ df_monitor_checker_name }} が {{ df_dimension_tags }} にインシデントを検出

イベント内容：

- 地域：{{ region }}
- ホスト：{{ host }}
- レベル：{{ df_status }}
- 検出値：{{ Result }}
- モニター：{{ df_monitor_checker_name }}（アラートポリシー：{{ df_monitor_name }}）

この場合、error イベントが発生すると、レンダリング後のイベント出力は次のようになります：

出力イベント名：

モニター モニター001 が {"region":"hangzhou","host":"web-001"} にインシデントを検出

出力イベント内容：

- 地域：hangzhou
- ホスト：web-001
- レベル：error
- 検出値：90.12345
- モニター：モニター001（アラートポリシー：チーム001）

特殊なシナリオの変数¶

RUM メトリクス検出¶

RUM メトリクス検出では、上記の汎用テンプレート変数に加えて、以下のテンプレート変数が追加でサポートされています：

特殊文字フィールドの処理¶

検出設定の ディメンション フィールドに特殊文字（例：-、@）、例えば host-name、@level が含まれている場合、通常の変数名として直接使用できず、テンプレートのレンダリングに失敗する可能性があります。

解決策として、以下の形式で参照します：

• {{ host-name }} の代わりに {{ df_event['host-name'] }} を使用

• {{ @level }} の代わりに {{ df_event['@level'] }} を使用

テンプレート関数¶

イベント内のフィールド値を直接表示するだけでなく、テンプレート関数を使用してフィールド値をさらに処理し、出力を最適化することもできます。

基本構文は次のとおりです：

{{ <テンプレート変数> | <テンプレート関数> }}

具体的な例：

イベント発生時刻：{{ date | to_datetime }}

テンプレート関数にパラメータを渡す必要がある場合、構文は次のとおりです：

イベント発生時刻：{{ date | to_datetime('America/Chicago') }}

CPU 使用率：{{ (Result * 100) | to_round(2) }}

利用可能なテンプレート関数のリストは次のとおりです：

テンプレート関数の例¶

詳細については、各テンプレート関数の例を参照してください。

設定されたモニターの by に region と host が設定され、アラート設定のテンプレートが以下の通りだとします：

イベント名：

モニター {{ df_monitor_checker_name }} が {{ df_dimension_tags | to_pretty_tags }} にインシデントを検出

イベント内容：

- 対象：{{ df_dimension_tags | to_pretty_tags }}
- 時刻：{{ date | to_datetime }}
- レベル：{{ df_status | to_status_human }}
- 検出値：{{ (Result * 100) | to_round(2) }}

この場合、error イベントが発生すると、レンダリング後のイベント出力は次のようになります：

出力イベント名：

モニター 私のモニター が region:hangzhou, host:web-001 にインシデントを検出

出力イベント内容：

- 検出対象：region:hangzhou, host:web-001
- 検出時刻：2022-01-01 01:23:45
- インシデントレベル：重要
- 検出値：9012.35

テンプレート分岐¶

テンプレートは、条件に応じて異なるコンテンツをレンダリングするための分岐構文もサポートしています。

テンプレート分岐の例¶

次の構文を使用して分岐機能を実現できます：

{% if df_status == 'critical' %}
緊急の問題です。直ちに対処してください！
{% elif df_status == 'error' %}
重要な問題です。対処してください
{% elif df_status == 'warning' %}
問題が発生している可能性があります。時間があるときに対処してください
{% elif df_status == 'nodata' %}
データが途絶えています。直ちに対処してください！
{% else %}
問題ありません！
{% endif %}

より典型的な例は次のとおりです：

{% if  df_status != 'ok' %}
> レベル：{{ df_status }}
> ホスト：{{ host }}
> 内容：Elasticsearch JVM ヒープメモリの使用量が {{ Result }}% です
> 推奨：現在、JVM ガベージコレクションが JVM ガベージの生成に追いついていません。業務状況を確認してください

{% else %}
> レベル：{{df_status}}
> ホスト：{{host}}
> 内容：Elasticsearch JVM ヒープメモリアラートが復旧しました

{% endif %}

埋め込み DQL クエリ関数¶

状況によっては、テンプレート変数だけではレンダリングのニーズを満たせない場合があります。そのような場合は、埋め込み DQL クエリ関数を使用して追加のデータクエリを実現できます。

埋め込み DQL クエリ関数は、今回の検出時間範囲内で現在のワークスペース内の任意の DQL ステートメントの実行をサポートします。通常、クエリで取得した最初のデータは、テンプレート内でテンプレート変数として使用できます。使用方法は次のとおりです：

{% set dql_data = DQL("実行する DQL ステートメント") %}

あるフィールド：{{ dql_data.some_field }}

埋め込み DQL クエリの例¶

次の埋め込み DQL ステートメントは、host フィールドが "my_server" のデータをクエリし、最初のデータを dql_data 変数に代入します：

{% set dql_data = DQL("O::HOST:(host, host_ip, os, datakit_ver) { host = 'my_server' }") %}

ホスト OS：{{ dql_data.os }}

これ以降のテンプレートでは、{{ dql_data.os }} を使用してクエリ結果の特定のフィールドを出力できます。

埋め込み DQL へのパラメータ渡し¶

DQL ステートメントを実行する際にパラメータを渡す必要がある場合があります。これらのパラメータは DQL ステートメントに直接埋め込むことができ、by フィルタを追加するかどうかを選択できます。ただし、記述方法が少し異なります。通常、変数を参照する場合は {{df_status}} を使用します。しかし、DQL ステートメント内では、{{ }} を付けずに変数名を直接使用する必要があります。したがって、最終的な記述は status になります。

モニターの by に region と host が設定され、イベント内容のテンプレートが以下の通りだとします：

{% set dql_data = DQL("O::HOST:(host_ip, os) { region = ?, host = ? }", region, host) %}

ホスト情報：
IP：{{ dql_data.host_ip }}
OS: {{ dql_data.os }}

イベントには、異なるデータを識別するための region と host テンプレート変数のみが含まれており、IP アドレスや OS などの詳細情報は含まれていません。

その場合、埋め込み DQL を使用すると、region と host を DQL クエリパラメータとして使用して対応するデータを取得し、{{ dql_data.host_ip }} などを使用して関連情報を出力できます。

埋め込み DQL クエリ関数の詳細¶

埋め込み DQL クエリ関数の呼び出し形式は次のとおりです：

DQL(dql, param_1, param_2, ...)

• 第 1 引数は DQL ステートメントで、パラメータプレースホルダ ? を含めることができます
• 後続の引数は DQL ステートメントのパラメータ値または変数です

パラメータプレースホルダ ? は、具体的な値に置き換えられる際に、システムによって自動的にエスケープされます。

変数 host の値が "my_server" であると仮定すると、埋め込み DQL 関数と実行される最終的な DQL ステートメントは次のようになります：

DQL("O::HOST:(host, host_ip, os, datakit_ver) { host = ? }",  host)

O::HOST:(host, host_ip, os, datakit_ver) { host = 'my_server' }

その他の DQL ドキュメント¶