通知模板
通知模板是一个由自定义内容、内容变量和内容格式参数组成的标准化的结构体。用于为通知策略,标准化定制告警通知消息的内容及格式。
项目管理员或运维人员通过设置通知模板,可基于不同的告警通知方式自定义通知消息的内容及格式,帮助用户快速获取关键的告警信息,提升运维效率。
创建通知模板
基于实际的监控告警运维场景,提供了丰富的用于设置通知消息的内容的变量。创建通知模板时,可基于实际的监控告警运维场景,增减内容变量并设置消息内容的格式。一个通知模板可被一个或多个相同通知类型的通知策略使用,所有使用该模板的通知策略,可基于模板标准化输出发送给通知对象的通知消息。
操作步骤
-
在 项目管理 视图,单击 项目名称。
-
在左侧导航栏中,单击 通知。
-
切换至 通知模板 标签页。
-
单击 创建通知模板。
-
在 基本信息 区域,配置以下参数。
参数 说明 消息类型 根据通知的用途选择消息的类型。
告警消息:结合项目的告警功能,发送由告警规则触发的告警消息;
组件异常消息:组件异常消息提醒,发送由某些组件异常触发的通知信息。 -
在 模板配置 区域,参考不同类型的模板说明配置变量、内容格式相关参数。
提示:
-
模板的内容仅能由平台支持的变量、变量显示名称、特殊格式标记语言组成。在符合语法规范的前提下,可自由组合变量及其他组成要素。
-
平台基于实际运维场景,提供了针对不同通知类型(邮箱、短信、接口回调)的默认通知模板内容,能够满足大部分通知消息设置需求。如无特殊需求,您可直接使用默认的模板内容。
本文以邮箱通知模板为例进行说明。
-
通知主题:邮件主题。也可使用平台预置的默认主题,如需修改,仅替换变量
{{}}
(变量) 或修改变量之外的文本内容即可。预置主题为:
【{{.externalLabels.status}}】PAAS 平台告警:{{.externalLabels.object}}的{{.externalLabels.summary}}
。显示效果:
【告警中】PAAS 平台告警:节点192.168.16.53的节点的CPU使用率超过80%
。 -
通知内容:邮件通知的内容,默认显示预置的 HTML 格式通知模板内容,您可根据自己的需要增减变量或设置格式标签,模板内容支持 HTML 格式和文本格式,且支持填写中/英文文本。
提示:
-
输入框右侧默认展开当前格式内容的编写说明区域框,编写过程中,可参考右侧的说明信息或 特殊格式标记语言 编写内容。单击编写说明区域框底部的 收起帮助信息 按钮,可收起编写说明区域框;单击
可再次展开编写说明区域框。
-
单击输入框下方的 预览通知 按钮,可在弹出的对话框中,预览基于当前设置的邮件主题、通知内容生成的通知消息的展示效果。
-
单击 样例 右侧的 查看 按钮,可在弹出的对话框中,查看示例内容;单击
图标,在弹出的确认提示框中单击 替换 按钮后,可将输入框中当前内容快速替换为示例内容。
-
-
-
单击 创建。
参考信息
变量
变量是通知消息(NotificationMessage)的标签(labels)或注释(annotations)的键,格式如 {{.标签键}}
。通常为了方便用户快速获取关键信息,可为变量自定义显示名称,例如:告警等级:{{ .externalLabels.severity }}
。
当通知策略基于通知模板向用户发送通知消息时,模板中的变量会引用通知消息中相应标签的值(实际的监控数据)。最终将监控数据以标准化的内容形式发送给用户。
平台支持的变量如下:
显示名称 | 变量 | 说明 |
---|---|---|
告警状态 | {{ .externalLabels.status }} | 例如:告警中。更多告警状态请参考 状态说明 。 |
告警等级 | {{ .externalLabels.severity }} | 例如:严重。更多告警等级请参考 创建告警策略 。 |
告警集群 | {{ .labels.alert_cluster }} | 发生告警的资源所在集群,例如:集群 1。 |
告警对象 | {{ .externalLabels.object }} | 发生告警的资源的类型及名称,例如:节点192.168.16.53。 |
策略名称 | {{ .labels.alert_resource }} | 告警策略的名称。例如:cpaas-node-rules。 |
告警描述 | {{ .externalLabels.summary }} | 告警策略的描述信息。 |
触发数值 | {{ .externalLabels.currentValue }} | 触发告警的监控数值。 |
告警时间 | {{ dateFormatWithZone .startsAt “2006-01-02 15:04:05” “Asia/Chongqing” }} | 告警的开始时间。 |
恢复时间 | {{ dateFormatWithZone .endsAt “2006-01-02 15:04:05” “Asia/Chongqing” }} | 告警的结束时间。 |
指标名称 | {{ .labels.alert_indicator }} | 监控指标的名称。 |
聚合时间 | {{ .labels.alert_indicator_aggregate_range }} | 采集监控指标数据的持续时间。 |
规则符号 | {{ .labels.alert_indicator_comparison }} | 告警触发条件中的比较运算符。 |
规则阈值 | {{ .labels.alert_indicator_threshold }} | 告警触发条件中的告警阈值。 |
对象类型 | {{ .labels.alert_involved_object_kind }} | 发生告警的资源的类型。 |
对象名称 | {{ .labels.alert_involved_object_name }} | 发生告警的资源的名称。 |
规则名称 | {{ .labels.alertname }} | 发生告警的告警规则的名称。 |
主机 IP | {{ .labels.host_ip }} | 发生告警的资源所在节点的 IP。特定变量,不支持预览。 |
主机名称 | {{ .labels.node_name }} | 发生告警的资源所在节点的名称。特定变量,不支持预览。 |
特殊格式标记语言
常见的 HTML 格式标签及使用说明参见下表:
内容要素 | 标签 | 说明 |
---|---|---|
文本 | - | 支持输入中/英文文本内容。 |
字体 | <font color="#FF0000">设置字体颜色</font> <b>字体加粗</b> |
设置字体格式。 |
标题 | <h1>一级标题</h1> ,支持到 h6(六级标题)。 |
设置标题层级。 |
段落 | <p>段落</p> |
插入普通段落文本。 |
引用 | <q>引用</q> |
插入短引用内容。 |
超链接 | <a href="//www.example.com">超链接</a> |
插入超链接。 |