使用场景
手动创建故障、自动生成故障、重新分派、升级分派和重开分派时,系统都会使用模板渲染通知。系统使用 Golang 模板语法 解析数据,支持逻辑判断、循环、pipeline 及常用函数。更多函数请参考 sprig 函数库。
配置模板
1
创建自定义模板
进入 配置中心 → 通知模板,点击 创建。也可以在已有模板的操作菜单中选择 复制。填写模板名称、管理团队和可选的模板描述,点击 保存。
2
编辑模板内容
在模板详情页左侧选择通知渠道,编辑正文内容。可引用下方变量列表中的字段。
3
保存模板
点击当前渠道的 保存,保存该渠道的内容与设置。修改其他渠道后,也需分别保存。
应用模板
变量引用
引用示例
Incident 变量
故障对象的完整变量列表:关联对象
Person - 人员信息
Person - 人员信息
Assignment - 分派配置
Assignment - 分派配置
Responder - 处理人
Responder - 处理人
Alert - 告警详情
Alert - 告警详情
预览与发送测试
模板详情页右侧是预览区:按所选故障渲染当前渠道的内容,下方带一行诊断信息和预览给出的警告。预览区标题栏还有 发送测试,可以把编辑器里的当前内容真实发到渠道里看效果。预览会提示什么
预览按 用这个故障的数据渲染 里选中的故障渲染当前渠道的内容;没选故障时用系统默认数据。编辑器内容为空时,预览按该渠道的系统默认模板渲染,并提示「未设置模板内容,将使用系统默认模板」。 预览下方一行元信息说明这条内容是怎么渲染出来的:
元信息上方的黄色提示说明这条模板在真实发送时会变形或超限,出现任意一条,保存前按提示精简:
内容超过渠道大小上限时,提示分 3 种:
发送测试
发送测试 在预览区标题栏。它把编辑器当前内容(含未保存的修改)按预览里选中的故障渲染后,真实发到渠道里,用来确认接收方看到的样子。需要「通知模板管理」权限;系统预置模板也可以发送测试。模板校验没通过时按钮不可点。 支持的渠道:5 个 IM 应用(飞书、钉钉、企业微信、Slack、Teams)、6 个群聊机器人(飞书、钉钉、企业微信、Slack、Telegram、Zoom)和邮件。短信和语音不提供发送测试——它们按条计费,而预览内容就等于实际发出的内容。 发送内容与预览是同一份:编辑器当前内容 + 选中的故障数据(未选故障时用系统默认数据),渠道渲染开关(卡片字段显隐、飞书卡片 2.0 的表格与空白行开关、企业微信机器人的 Markdown v2)也一致。编辑器内容为空时,发的是该渠道的系统默认模板。 各渠道的发送目标:- 我自己:要求当前账号已关联该 IM 集成,未关联时发送按钮不可点,有权限的成员可以点 去关联 到接入向导完成关联。Slack 应用例外,不需要逐人关联(按工作区成员直接私信),但发送时仍要把您解析成该工作区的成员,解析不到会提示「你的账号还没有关联这个 IM,无法私信」。
- 群聊:只列出该机器人在这个集成里已加入的群(Slack 按频道,Teams 按团队下的频道或群聊)。群里所有成员都会收到这条测试消息。
- 同一渠道配了多个集成时,先在 集成 里选一个;只列已启用的集成。
- 故障标题前加
[测试](英文账户为[Test])。 - 正文末尾加脚注「测试消息 · 模板「模板名」· 由 发送人 发送」。
- 卡片上的按钮点击后只回一句「这是测试消息,按钮不会改动故障。」,不会认领或关闭任何故障;创建作战室 按钮在测试消息里不出现。
IM 应用提示「已发送」才表示消息已送达;机器人和邮件的「已提交发送」只表示已提交,地址填错时不会有即时报错。
限制与常见失败原因:
- 每个成员每分钟最多发 5 条测试消息,超过会提示「发送太频繁,请稍后再试」。
- 失败时控制台给出下面的提示:
测试发送与真实通知的差别:模板语法有错时,真实通知会回退成系统默认模板继续发,机器人和应用渠道的消息末尾会附一行「【🔴 自定义模板渲染异常,已降级为默认模板】」,而发送测试直接提示「模板渲染失败,请先修正模板」,把模板问题暴露出来。反过来,测试发送不会在故障上留下通知记录,所以它不会认领、关闭故障或创建作战室。
渠道模板
不同通知渠道支持的模板格式和限制不同。卡片字段与底部操作按钮
正文内容 旁的 附加信息 页签用于控制卡片底部展示哪些系统内容。各渠道支持的开关如下:- 创建作战室(默认关闭):开启后,故障未关闭、尚无作战室且有处理人员时,卡片底部显示 👥 创建作战室 按钮,点击即可建群。
- 故障关闭后保留自定义操作(默认关闭):开启后,故障关闭后 3 天内仍可在消息卡片上执行已配置的自定义操作;关闭时或超过 3 天,请到故障详情页执行。
- 飞书应用
- 钉钉应用
- 企业微信应用
- Slack 应用
- Microsoft Teams
需预先配置 飞书集成。支持消息卡片格式,系统会自动删除因标签不存在导致的渲染空行。默认模板(渲染全部标签):精简模板(仅展示关键标签):飞书应用卡片底部的 更多操作 是一个下拉菜单,包含自定义操作、暂缓时长与取消认领等选项;👥 创建作战室 按钮单独显示,不在该菜单中。
表格转原生表格
飞书卡片 2.0 下另有一个开关 表格转原生表格(默认关闭,随模板保存)。开启后,模板里的 GFM Markdown 表格会被识别出来,渲染成飞书卡片的原生表格组件,接收方看到的是可翻页的表格,而不是一行行带| 的文本。原生表格有以下限额。单张卡片的原生表格超过 5 个,或卡片超过 30 KB 时,这张卡片上的所有表格都按 Markdown 文本发送;其余限额只影响超限的那一张表,它按 Markdown 文本发送,其他表格不受影响:触发退回时,预览会给出对应提示(见预览会提示什么):
飞书卡片整体上限是 30 KB。超过时飞书直接拒收这条消息,预览会提示「内容超过渠道大小上限,发送会失败,真实告警也一样。请精简模板。」,需要精简模板后再发。按 Markdown 文本发送的表格另有一条限制:单个飞书 Markdown 组件最多 4 张表格,超出的表格可能不显示。表格较多时开启 表格转原生表格,或把内容拆到多个 Markdown 组件里。
机器人模板
群聊机器人支持的模板格式。短信、语音、App 推送和各群聊机器人的消息末尾,系统会在故障抖动(
IsFlapping)、告警风暴(IsInStorm)或 30 天内首次出现同类故障时自动追加提示行,模板里不用写,也无法去掉。应用卡片和邮件不追加。以下渠道不渲染 Markdown 表格,会把表格按带
| 的原文发出去,预览里也会给出提示:钉钉、Slack、Telegram 机器人,企业微信机器人(Markdown v1),以及钉钉、Slack、企业微信、Teams 应用。发给这些渠道的模板建议把表格改写成列表。- 飞书机器人
- 钉钉机器人
- 企业微信机器人
- Slack 机器人
- Telegram 机器人
支持消息卡片、富文本和普通文本三种格式。消息最大 4000 字节,超出后截断。
消息卡片(msg_type: interactive)
消息卡片(msg_type: interactive)
富文本(msg_type: post)
富文本(msg_type: post)
普通文本
普通文本
其他渠道
- 短信
- 语音
- 邮件
默认模板:
常见问题
如何知道 Labels 有哪些标签?
如何知道 Labels 有哪些标签?
- 手动创建的故障没有标签
- 自动创建的故障存在标签,与合入的第一条告警的标签相同
配置了自定义模板,实际却使用了默认模板?
配置了自定义模板,实际却使用了默认模板?
创建自定义模板时,保存模板时的语法检查通过,不代表所有故障都能渲染成功。实际发送时渲染失败,系统将改用默认模板,机器人和应用渠道的消息末尾会附一行「【🔴 自定义模板渲染异常,已降级为默认模板】」。
故障标题含有字符转义(如 >)?
故障标题含有字符转义(如 >)?
使用
toHtml 函数处理:如何转换时间格式?
如何转换时间格式?
如何在 for 循环内部引用外部变量?
如何在 for 循环内部引用外部变量?
在外部变量前增加
$:如何提取带 . 的字段值(如 obj.instance)?
如何提取带 . 的字段值(如 obj.instance)?
使用
index 函数:如何提取关联告警中的 label 并去重?
如何提取关联告警中的 label 并去重?
如何遍历并打印 Labels?
如何遍历并打印 Labels?
如何从 JSON 字段中提取信息?
如何从 JSON 字段中提取信息?
使用
jsonGet 函数从合法 JSON 中按 path 提取值。语法参考 gjson.dev。如何在发送应用消息时携带图片?
如何在发送应用消息时携带图片?
通过 imageSrcToURL 获取图片 URLimageSrcToURL 函数用于将图片的 通过 transferImage 上传图片到第三方平台transferImage 函数用于将图片转换并上传到第三方通知平台。参数说明:
Src 属性转换为可访问的 URL。参数说明:$root:根上下文对象Src:图片源,可以是image_key或 http/https URL
- 如果
Src是从图片上传界面获取的image_key,会转换为可访问的 URL(短期有效) - 如果
Src是 http/https 地址,直接返回该地址
$root:根上下文对象Src:图片源,可以是image_key或 http/https URL
- 最大图片大小:10 MB
- 支持格式:JPG、JPEG、PNG、WEBP、GIF、BMP、ICO、TIFF、HEIC
如何让查询语句里的 ~ 原样显示?
如何让查询语句里的 ~ 原样显示?
codeBlock 函数用于把值包进代码块,让聊天端原样显示。Slack 的 mrkdwn 把单个 空值和已经含有三个反引号围栏的值会原样返回,值本身不做转义。
~ 当作删除线标记,module=~"api|worker" 这类匹配条件不包进代码块就会渲染成删除线。如何使用逻辑运算?
如何使用逻辑运算?
延伸阅读
配置分派策略
定义故障的通知规则和升级机制
配置个人偏好
设置各通知场景的渠道偏好