告警模板配置教程¶
本教程专门介绍告警策略中的「告警内容模板」如何配置，包括标题、正文、正文格式、占位符与参数顺序。
适用页面：告警管理 → 新建 / 配置 → 告警内容模板。
1. 模板能做什么¶
告警邮件的标题与正文支持自定义文案，并通过 {0}、{1}、{2}… 占位符插入动态数据（如告警时间、资源域名、指标值等）。
你可以：
- 编辑标题与正文文案
- 选择正文为「文本」或「HTML」
- 从可用参数中挑选并排列参数顺序
- 让占位符编号与参数顺序一一对应
2. 界面区域说明¶
| 区域 | 作用 |
|---|---|
| 标题模板 | 邮件标题文案，可含占位符 |
| 正文模板 | 邮件正文文案，可含占位符 |
| 正文格式 | 文本 或 HTML |
| 可用参数 | 当前规则允许使用的参数（点击添加） |
| 已选参数顺序 | 决定 {0} {1}… 分别取哪个参数 |
页面「使用说明」与本教程一致，可对照阅读。
3. 占位符规则（必须遵守）¶
- 使用
{数字}作为动态占位符，例如{0}、{1}。 - 编号必须从
{0}开始，且连续，不能跳号。 - 正确：
{0}{1}{2} - 错误：只用
{1}，或出现{0}{2}却缺少{1} - 不要使用非数字占位符，例如
{name}、{a}。 - **已选参数顺序**中：
- 第 1 项 →
{0} - 第 2 项 →
{1} - 第 3 项 →
{2} - 以此类推
- 模板里用到的最大编号，必须能在已选参数列表中找到对应项；参数个数需覆盖所有用到的占位符。
- 标题模板长度有上限（约 200 字），正文模板长度有上限（约 2000 字）。
调整参数顺序后，请同步检查正文/标题中的占位符编号是否仍符合预期。
4. 可用参数说明¶
界面只展示中文名称，不展示内部字段名。参数集合会随「比较关系」变化。
4.1 公共参数（阈值型、波动型都可用）¶
| 界面名称 | 含义 |
|---|---|
| 告警时间 | 告警发生相关时间 |
| 资源域名 | 触发告警的资源对象 |
4.2 阈值型参数（比较关系为「大于 / 小于」）¶
| 界面名称 | 含义 |
|---|---|
| 指标聚合值（当前指标名） | 当前所选指标在统计窗口内的聚合结果 |
4.3 波动型参数（比较关系为「环比上升 / 环比下降 / 环比变化」）¶
| 界面名称 | 含义 |
|---|---|
| 当前峰值 | 当前窗口统计值 |
| 参考值 | 用于对比的参考窗口统计值 |
阈值型不能使用「当前峰值 / 参考值」；波动型不能使用「指标聚合值」。混用会导致保存校验失败。
5. 参数操作¶
5.1 添加¶
点击「可用参数」中的标签，将该参数加入「已选参数顺序」。同一参数不可重复添加。
5.2 调整顺序¶
使用 ↑ / ↓ 调整已选参数位置。顺序变化会改变 {n} 的含义，请同步改模板。
5.3 删除¶
删除不需要的参数。若模板中仍引用对应 {n}，需一并修改文案，避免编号与参数错位。
6. 正文格式：文本 vs HTML¶
| 格式 | 用途差异 |
|---|---|
| 文本 | 按纯文本发送告警邮件，内容原样展示，适合简洁通知 |
| HTML | 按富文本发送，可使用标签美化排版，由邮件客户端渲染 |
选择 HTML 后，可在正文中使用常见标签，例如：
<b>加粗<br>换行<p>段落
注意：
- 标题一般仍按普通文本理解，富文本重点在正文。
- 不同邮箱客户端对 HTML 支持程度不同，建议先用简单标签验证效果。
- 若保存后正文中的 HTML 标签消失，请联系管理员确认网关 XSS 白名单是否已放行告警配置接口。
7. 指标 / 比较关系变化时会发生什么¶
| 变更 | 对模板的影响 |
|---|---|
| 切换指标 | 「指标聚合值」绑定到新指标；可用参数展示名会更新；新建场景常会重置默认模板 |
| 切换比较关系 | 在阈值型与波动型之间切换时，可用参数集合变化；已选参数中不合法项会被清理；新建场景常会重置默认模板 |
建议：每次改指标或比较关系后，重新打开模板区域核对「可用参数」和「已选参数顺序」。
8. 完整示例¶
8.1 文本格式（阈值型）¶
标题模板：
正文模板：
已选参数顺序：
- 告警时间 →
{0} - 资源域名 →
{1} - 指标聚合值 →
{2}
8.2 HTML 格式（波动型）¶
标题模板：
正文格式： HTML
正文模板：
<p><b>资源异常告警</b> - 疑似攻击活动</p>
<p>告警时间: {0}<br>
资源: {1}<br>
当前峰值: {2}<br>
参考值: {3}</p>
<p>【安全提醒】：请及时查看流量波动原因。</p>
已选参数顺序：
- 告警时间 →
{0} - 资源域名 →
{1} - 当前峰值 →
{2} - 参考值 →
{3}
9. 校验失败常见原因¶
| 现象 / 提示方向 | 可能原因 | 处理建议 |
|---|---|---|
| 非法占位符 | 写了 {name} 等非数字占位符 |
改为 {0} {1}… |
| 占位符不连续 | 跳过了某个编号 | 保证从 0 连续使用 |
| 参数数量不匹配 | 模板用了 {2} 但只选了 2 个参数 |
补齐参数或减少占位符 |
| 参数不在白名单 | 波动型策略里仍使用指标聚合值等 | 按当前比较关系重选可用参数 |
| 标题/正文为空或超长 | 未填或超出长度限制 | 控制在标题约 200 字、正文约 2000 字内 |
10. 注意事项¶
- 以界面中文名为准，不要依赖内部字段名（如
server_name.keyword）。 - 标题参数通常以资源域名等公共信息为主；正文可组合更多参数。
- 正文中可使用 emoji 等特殊字符，但需保证系统按 UTF-8 正确保存与投递；若出现乱码或解码错误，请联系管理员排查编码配置。
- 模板仅影响告警邮件展示内容，不会改变触发逻辑本身；是否告警仍由触发条件决定。
- 修改模板后请保存策略，并用一次真实或测试触发验证邮件效果。
11. 推荐配置步骤¶
- 先确定比较关系与指标，让可用参数列表稳定。
- 选择正文格式（文本或 HTML）。
- 按需要点击添加参数，并用 ↑ / ↓ 排好顺序。
- 编写标题与正文，插入对应
{n}。 - 对照「已选参数顺序」逐项核对。
- 保存策略并验证一封实际告警邮件。