日志服务：内容模板语法（新版）

概述

新版的内容模板语法完全兼容旧版，并支持新旧版混合使用。但在不同版本的内容模板语法中使用告警属性时，其类型、取值和展示形式等存在差异，因此建议您不要混合使用新旧版本的内容模板语法。推荐您使用新版本的内容模板语法。

快速开始

通过新版内容模板定义通知内容的示例如下：

• 告警内容

  {
      "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。但是分隔符外部的空字符（空格、Tab、换行等）会被保留，例如{{ 23 }} < {{ 45 }}的渲染结果为23 < 45，而不是23<45。

条件判断支持对参数或者逻辑比较表达式进行判断。通过条件判断，可以进行动态渲染。

• 如果if后面传入的是常量或者普通变量，则对该值进行真值判断。其中布尔值false、数字0、空字符串""、空值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 }}