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

基本文法

預設情況下，在分隔字元內部，分隔字元與運算式之間的空格會被忽略。例如{{ 23 }} < {{ 45 }}等同於{{23}} < {{45}}，渲染結果都為23 < 45。但是分隔字元外部的Null 字元（空格、Tab、換行等）會被保留，例如{{ 23 }} < {{ 45 }}的渲染結果為23 < 45，而不是23<45。

條件判斷支援對參數或者邏輯比較運算式進行判斷。通過條件判斷，可以進行動態渲染。

• 如果if後面傳入的是常量或者普通變數，則對該值進行真值判斷。其中布爾值false、數字0、Null 字元串""、空值null、空數組[]、Null 物件{}都會被判定為假，其它值被判定為真。

• 如果if後面傳入的是邏輯比較運算式，則按照比較結果進行判斷。例如{{ if alert.severity >= 8 }}用於判斷警示嚴重度是否大於等於8。

{% if alert.severity >= 8 %}
嚴重警示
{% endif %}

{% if alert.severity >= 8 %}
嚴重警示
{% else %}
普通警示
{% endif %}

{% if alert.severity >= 8 %}
嚴重警示
{% elif alert.severity >= 4 %}
普通警示
{% endif %}

{% if alert.severity >= 8 %}
嚴重警示
{% elif alert.severity >= 4 %}
普通警示
{% else %}
通知
{% endif %}

{% if alert.severity >= 8 %}
嚴重警示
{% else %}
{% if alert.severity >= 4 %}
普通警示
{% else %}
通知
{% 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 %}

如果您希望特殊字元串（例如{{）不被內容範本解析和渲染，可對特殊字元串進行轉義。例如：根據如下配置表示保留{% raw %}和{% endraw %}之間所有的內容。

• 內容範本配置

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

• 結果

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

內建模板函數便於您對資料進行各種操作，豐富了通知內容的格式和展示樣式。更多資訊，請參見內建模板函數。

例如您要通過Webhook方式發送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 }} 。

使用過濾器方式時，請先確認目標內建函數是否支援過濾器方式。大部分內建函數都支援過濾器方式的調用。更多資訊，請參見內建模板函數。

內容範本運算式中支援如下操作符。操作符的優先順序說明請參見Operator precedence。

使用警示變數

在新版內容範本中，警示變數的使用形式為alert.xxx，例如alert.project。更多資訊，請參見內容範本變數說明（新版）。

配置樣本

• 樣本1：根據警示狀態展示不同內容

  觸發警示後，展示警示狀態、警示嚴重度和觸發結果等資訊；警示恢複時，只展示警示狀態。

  • 不使用函數

    {% if alert.status == "firing" %}
    - 狀態: <font color="#E03C39">觸發</font>
    - 嚴重度：{{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% else %}
    - 狀態: <font color="#72C140">恢複</font>
    {% endif %}

  • 使用函數

    使用format_status函數和format_severity函數簡化配置。

    - 狀態: {{ alert.status | format_status }}
    {% if alert.status == "firing" %}
    - 嚴重度：{{ alert.severity | format_severity }}
    - Results: {{ alert.results | to_json }}
    {% endif %}

• 結構化資料展示

  將警示標籤的內容轉換為列表形式，內容為Markdown格式。

  • 不使用函數

    - 專案: {{ alert.project }}
    - 警示名稱: {{ alert.alert_name }}
    - 警示標籤:
    {%- for key, val in alert.labels.items() %}
    > - {{ key }}: {{ val }}
    {%- endfor %}

  • 使用函數

    使用to_list函數和blockquote函數簡化配置。

    - 專案: {{ alert.project }}
    - 警示名稱: {{ alert.alert_name }}
    - 警示標籤:
    {{ alert.labels | to_list | blockquote }}