新版内容模板语法_日志服务(SLS)-阿里云帮助中心

新版告警支持两个版本的内容模板语法。本文介绍新版内容模板语法。

概述

相对于旧版的内容模板语法，新版通过类似 Python 语法的方式，提供更加灵活且高级的自定义渲染逻辑，在定制通知内容（例如 Markdown 转义）、自定义内容样式等方面都做了优化，满足更多样化的定制内容需求。例如：

根据告警的严重度进行动态的内容渲染，不同严重度使用不同颜色的文字进行区分。
对告警的查询结果进行迭代渲染，在邮件中渲染为列表或者表格。
通过函数对某个字段进行 BASE64 编码和解码、对数值进行数学运算等。

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

快速开始

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

告警内容

{
    "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

基本语法

数据类型

内容模板语法类似于 Python 语法，支持如下数据类型。

数据类型	说明
数字	包含整数和浮点数。例如 3、-1。
字符串	需要使用单引号（''）或者双引号（""）包裹。例如"foo"、'bar'。当字符串中存在特殊字符时，需使用反斜线（\）进行转义。例如 `\foo` 需写为 `"\\foo"` 。
布尔值	True、False。
空值	None。
列表	不同编程语言中的叫法不同，可以为列表、数组、Slice 等。例如['foo', 'bar']。
字典	不同编程语言中的叫法不同，可以为字典、对象等。例如{'foo': 'bar'}。

分隔符

分隔符	使用场景	示例
`{{ }}`	在变量或表达式中使用。	数字： `{{ 123 }}` 字符串： `{{ "abc" }}或{{ 'xyz' }}` 需要使用双引号（""）或单引号（''）。变量： `{{ alert.alert_name }}` 表达式： `{{ alert.project + '/' + alert.alert_id }}`
`{% %}`	用于控制语句。	`{% if alert.status == 'firing' %}FIRING{% else %}RESOLVED{% endif %` }
`{# #}`	用于注释，不会出现在通知内容中。	`{# this is a comment #}`

清除空字符

默认情况下，在分隔符内部，分隔符与表达式之间的空格会被忽略。例如 {{ 23 }} < {{ 45 }} 等同于 {{23}} < {{45}} ，渲染结果都为 23 < 45 。但是分隔符外部的空字符（空格、Tab、换行等）会被保留，例如 {{ 23 }} < {{ 45 }} 的渲染结果为 23 < 45 ，而不是 23<45 。

当您需要删除多余的空字符时，可以使用清除空字符操作。在分隔符开始或结束的地方添加一个短划线（-），用于清除该分隔符前面和后面所有紧连着的空字符。例如 {{ 23 -}} < {{- 45 }} 的渲染结果为 23<45 。

{{- 、 {{%- 、 {#- 用于删除分隔符左侧紧连着的所有空字符。
-}} 、 -%} 、 -%} 用于删除分隔符右侧紧连着的所有空字符。

使用方式	示例
if	`{% if alert.severity >= 8 %} {% endif %}`
if-else	`{% if alert.severity >= 8 %} {% else %} {% endif %}`
if-elif	`{% if alert.severity >= 8 %} {% elif alert.severity >= 4 %} {% endif %}`
if-elif-else	`{% 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 %}`
数组迭代，包含下标	使用 enumerate 函数对数组进行下标迭代。关于 enumerate 函数的更多信息，请参见 enumerate 函数。 `{% for index, result in enumerate(alert.results) %} {{ index }}: {{ result }} {% endfor %}` 下标默认从 0 开始。您也可以通过 enumerate 函数中的 start 参数自定义起始下标。例如： `{% for index, result in enumerate(alert.results, start=1) %} {{ index }}: {{ result }} {% endfor %}`
对象迭代	通过 items()方法将对象转为 `Key:Value` 形式的数组进行迭代。 `{% 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 %}
{% for result in alert.results %}
{{ result }}
{% endfor %}
{% endraw %}

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

```
* |
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 格式合法

类别	操作符	说明
算数	+	加法
	-	减法
	*	乘法
	/	除法，返回值是一个浮点数。
	//	除法，返回整数。
	%	取模
比较	==	等于
	!=	不等于
	>	大于
	>=	大于等于
	<	小于
	<=	小于等于
逻辑	and	且操作
	or	或操作
	not	取反
其它	in	判断是否包含，返回布尔类型的结果。数组： `{{ 1 in [1, 2, 3] }}` 。对象： `{{ "foo" in {"foo": "bar" } }}` 。字符串： `{{ "ll" in "hello" }}` 。
其它	()	操作组合，例如：{{ a > b and (a > c or b > c) }}

{% if alert.status == "firing" %}
- 状态: <font color="#E03C39">触发</font>
- 严重度：{{ alert.severity | format_severity }}
- Results: {{ alert.results | to_json }}
{% else %}
- 状态: <font color="#72C140">恢复</font>
{% endif %}

- 状态: {{ alert.status | format_status }}
{% if alert.status == "firing" %}
- 严重度：{{ alert.severity | format_severity }}
- Results: {{ alert.results | to_json }}
{% endif %}

- 项目: {{ alert.project }}
- 告警名称: {{ alert.alert_name }}
- 告警标签:
{%- for key, val in alert.labels.items() %}
> - {{ key }}: {{ val }}
{%- endfor %}

- 项目: {{ alert.project }}
- 告警名称: {{ alert.alert_name }}
- 告警标签:
{{ alert.labels | to_list | blockquote }}

内容模板语法（新版）

概述

快速开始

基本语法

数据类型

分隔符

清除空字符

条件语句

迭代

转义

函数

过滤器

操作符

使用告警变量

配置示例