Simple Log Service:新しいアラートテンプレートの構文

概要

新しいアラートテンプレートの構文は完全に互換性があり、元のアラートテンプレートの構文と一緒に使用できます。 ただし、新しいアラートテンプレートの構文では、元のアラートテンプレートの構文とは異なるタイプ、値、およびスタイルのアラート属性が使用されます。 したがって、新しいアラートテンプレートの構文と元のアラートテンプレートの構文を同時に使用しないことをお勧めします。 新しいアラートテンプレートの構文を使用することを推奨します。

クイックスタート

このセクションでは、新しいアラートテンプレートで定義できる通知コンテンツの例を示します。

• アラートコンテンツ:

  {
      "alert_id": "test-alert",
      "alert_name": "PV/UV Alert",
      "project": "project-1",
      "status": "firing",
      "severity": 6,
      "labels": {
          "app": "nginx",
          "host": "host-1"
      },
      "results": [
          {
              "project": "project-1",
              "logstore": "logstore-1",
              "query": "* | select count(*) as pv"
          },
          {
              "project": "project-2",
              "logstore": "logstore-2",
              "query": "* | select count(distinct user_id) as uv"
          }
      ]
  }

• アラートテンプレートの設定:

  - Alert ID: {{ alert.alert_id }}
  - Alert Name: {{ alert.alert_name }}
  - Project: {{ alert.project }}
  - Status: {% if alert.status == "firing" %}FIRING{% else %}RESOLVED{% endif %}
  - Labels:
  {%- for key, val in alert.labels.items() %}
      - {{ key }}: {{ val }}
  {%- endfor %}
  - Query: {{ alert.results[0].query }}

• 出力結果:

  - Alert ID: test-alert
  - Alert Name: PV/UV Alert
  - Project: project-1
  - Status: FIRING
  - Labels:
      - app: nginx
      - host: host-1
  - Query: * | select count(*) as pv

基本構文

デフォルトでは、区切り文字を使用して式の開始と終了をマークすると、Simple Log Serviceは区切り文字と区切り文字内の式の間のスペースを無視します。 たとえば、Simple Log Serviceは、{{23}} < {45}} と {{23}} < {45} の両方を23 < 45にレンダリングします。 ただし、Simple Log Serviceは、スペース、タブ、改行などの空の文字列を区切り文字の外側に保持します。 たとえば、Simple Log Serviceは {{ 23 }} < {45} を23 <45ではなく23 <45にレンダリングします。

条件フローは, パラメーターの値と論理式の結果を評価するために使用されます。 Simple Log Serviceは、条件フローに基づいてデータをレンダリングできます。

• If句の後に定数または正規変数が続く場合、Simple Log Serviceは定数または正規変数の値をtrueまたはfalseに評価します。 Simple Log Serviceは、すべてのブール値false、数値0、空の文字列 "" 、空の値null、空の配列 [] 、空のオブジェクト {} をfalseに評価し、他のすべての値をtrueに評価します。

• If句の後に論理式が続く場合、Simple Log Serviceは論理式の結果をtrueまたはfalseに評価します。 たとえば、{{ if alert.severity >= 8 }} を使用して、アラートの重大度レベルが8以上かどうかを評価します。

{% if alert.severity >= 8 %}
Critical alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% else %}
Normal alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% elif alert.severity >= 4 %}
Normal alert
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% elif alert.severity >= 4 %}
Normal alert
{% else %}
Notification
{% endif %}

{% if alert.severity >= 8 %}
Critical alert
{% else %}
{% if alert.severity >= 4 %}
Normal alert
{% else %}
Notification
{% endif %}
{% endif %}

ループステートメントは、配列とオブジェクトに対して反復操作を実行するために使用されます。 次の表に、新しいアラートテンプレートでサポートされているループステートメントを示します。

{% for result in alert.results %}
{{ result }}
{% endfor %}

{% for index, result in enumerate(alert.results) %}
{{ index }}: {{ result }}
{% endfor %}

{% for index, result in enumerate(alert.results, start=1) %}
{{ index }}: {{ result }}
{% endfor %}

{% for key, val in alert.labels.items() %}
{{ key }}: {{ val }}
{% endfor %}

{% for result in alert.fire_results %}
{% for key, val in result.items() %}
{{ key }}: {{ val }}
{% endfor %}
{% endfor %}

Simple Log Serviceで {{などの特殊文字で構成される文字列を解析またはレンダリングしたくない場合は、文字列をエスケープできます。 たとえば、次のアラートテンプレート設定では、{% raw %} と {% endraw %} の間のすべてのコンテンツを保持するように指定します。

• アラートテンプレートの設定

  {% raw %}
  {% for result in alert.results %}
  {{ result }}
  {% endfor %}
  {% endraw %}

• 結果

  {% for result in alert.results %}
  {{ result }}
  {% endfor %}

アラートテンプレートは組み込み機能を提供します。 組み込み機能を使用して、アラート通知の形式とスタイルを柔軟に設定できます。 詳細については、「アラートテンプレートの組み込み関数」をご参照ください。

たとえば、Simple Log Serviceでwebhook URLを使用してアラート通知をJSON形式でプッシュする場合は、次のアラートテンプレート設定を指定する必要があります。

• 改行を含むクエリ文

  * |
  select count(*) as cnt

• 異なるアラートテンプレート設定の比較

  項目	アラートテンプレート	結果	補足
  関数は使用されません	{ "query": "{{ alert.results[0].query }}" }	{ "query": "* | select count(*) as pv" }	JSON形式が無効です。
  使用されるquote関数	{ "query": {{ quote(alert.results[0].query) }} }	{ "query": "* | \nselect count(*) as pv" }	JSON形式は有効です。

{{ block(to_list(alert.labels)) }}} などのネストされた関数を使用する場合、通知コンテンツの編集は面倒です。 この状況では、フィルターを使用して通知コンテンツを編集できます。 フィルターは演算子として縦棒 (|) を使用し、メソッドチェーンを使用して呼び出すことができます。 ほとんどの場合、{{ xxx | filiter1 | filter2 | ... }} 形式でフィルターを指定できます。 たとえば、{{ blockquote(to_list(alert.labels)) }} は {{{ alert.labels | to_list | blockquote }} に相当します。

組み込み関数でフィルターを指定する前に、組み込み関数がフィルターをサポートしていることを確認する必要があります。 新しいアラートテンプレートで使用できる組み込み関数のほとんどは、フィルターをサポートしています。 詳細については、「アラートテンプレートの組み込み関数」をご参照ください。

次の表に、新しいアラートテンプレートでサポートされる演算子を示します。 演算子の優先順位の詳細については、「演算子の優先順位」をご参照ください。

アラート変数

新しいアラートテンプレートでは、アラート変数はalert.xxx形式です。 たとえば、alert.project変数は有効なアラート変数です。 詳細については、「新しいアラートテンプレートの変数」をご参照ください。

設定例

• 例1: アラートのステータスに基づいて、各アラートに関する情報を表示します。

  アラートがトリガーされた後、アラートのステータス、重大度レベル、結果などの情報が提供されます。 アラートがクリアされると、アラートのステータスのみが提供されます。

  • 次のアラートテンプレート設定には、機能は含まれません。

    {% if alert.status == "firing" %}
    - Status: <font color="#E03C39">Firing</font>
    - Severity level: {{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% else %}
    - Status: <font color="#72C140">Cleared</font>
    {% endif %}

  • 次のアラートテンプレート設定には機能が含まれます。

    format_status関数とformat_severity関数は、アラートテンプレートの設定を簡素化するために使用されます。

    - Status: {{ alert.status | format_status }}
    {% if alert.status == "firing" %}
    - Severity level: {{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% endif %}

• 例2: 各アラートに関する情報を構造化された形式で表示します。

  各アラートのラベルは、Markdown形式の配列に変換されます。

  • 次のアラートテンプレート設定には、機能は含まれません。

    - Project: {{ alert.project }}
    - Alert name: {{ alert.alert_name }}
    - Label:
    {%- for key, val in alert.labels.items() %}
    > - {{ key }}: {{ val }}
    {%- endfor %}

  • 次のアラートテンプレート設定には機能が含まれます。

    to_list関数とblockquote関数は、アラートテンプレートの設定を簡素化するために使用されます。

    - Project: {{ alert.project }}
    - Alert name: {{ alert.alert_name }}
    - Label:
    {{ alert.labels | to_list | blockquote }}