创建AOM告警消息模板
AOM提供消息模板功能,可通过创建消息模板自定义配置通知消息,当AOM触发已设定的告警通知策略时,可通过此功能以您自定义消息模板的邮件、短信、飞书、企业微信、钉钉、语音、welink、HTTP或HTTPS形式通知指定的人员。
功能介绍
- 支持邮件、短信、企业微信、钉钉、飞书、语音、welink、HTTP或HTTPS消息模板。
- 支持消息模板自定义,详情请参考自定义消息模板内容。
约束与限制
- 您最多可创建100个“指标或事件(Prometheus监控)”类型的消息模板,100个日志(日志监控)类型的消息模板,如果某种类型的消息模板数量已达上限100时,请删除不需要的消息模板。
- 系统默认预置多个消息模板供用户使用,预置消息模板不可删除与编辑。当用户未自定义消息模板时,默认采用预置消息模板发送通知。
- 如果您未创建任何消息模板,则采用默认消息模板。
- welink消息模板当前受限开放,如有需求可以通过提交工单,联系工程师为您开放此功能。
创建消息模板
- 登录AOM 2.0控制台。
- 在左侧导航栏中选择“告警中心 > 告警通知”。
- 在右侧区域的“消息模板”页签下,单击“创建消息模板”。
- 输入模板名称、模板描述、消息模板类型和企业项目信息。
表1 参数说明 参数名称
说明
模板名称
消息模板的名称,只能由中文、数字、字母、下划线和中划线组成,且不能以下划线或中划线开头和结尾,最多可输入100个字符。
模板描述
消息模板的描述信息,最多可输入1024个字符。
消息模板类型
消息模板的类型,当前支持“prometheus监控”和“日志监控”类型。
企业项目
所属的企业项目。
- 如果在全局页面设置为“ALL”,此处请从下拉列表中选择企业项目。
- 如果在全局页面已选择企业项目,则此处灰化不可选。
- 选择语言,当前仅支持选择中文简体和英文。
- 自定义模板内容(创建prometheus监控类消息模板时会自动填充默认字段),模板包括邮件、短信、企业微信、钉钉等。prometheus监控类消息模板具体请参见表2。日志监控类消息模板具体请参见表3。
- 除默认模板的消息字段外,消息模板还支持用户自定义字段,需用户在上报事件告警信息时在指定参数上传该字段。
- 自定义字段支持以JSONPath的方式取值,示例:$event.metadata.case1、$event.metadata.case[0]
- 在“正文”区域右上角,单击“添加变量”可复制需要的变量信息。
- 当在消息模板中添加“TMS标签: $event.annotations.tms_tags;”变量时,需要在配置告警消息内容显示资源的TMS标签开关配置中打开“告警消息内容显示资源的TMS标签开关”开关后,该变量才会生效。
- 选择“邮件”方式发送通知时,可单击“预览”查看设置的邮件消息模板效果。在预览界面,可根据需要修改消息主题。
表2 默认消息模板变量说明 变量名称
变量说明
变量定义
告警名称
触发的告警规则的名称。
${event_name}
告警ID
触发的告警规则的ID。
${id}
通知规则
发送告警通知的告警通知规则名称。
${action_rule}
触发时间
触发此告警或事件的时间。
${starts_at}
触发级别
创建告警规则时选择告警或事件级别:紧急、重要、次要、提示。
${event_severity}
告警内容
详细的告警信息说明。
${alarm_info}
资源标识
触发告警或事件对应的具体资源。
${resources_new}
自定义标签
标签扩展字段。
$event.metadata.key1
修复建议
修复建议,非自定义上报则展示"NA"。
${alarm_fix_suggestion_zh}
自定义标注
标注扩展字段。
$event.annotations.key2
表3 配置日志消息模板参数 参数名称
说明
校验规则
样例
主题
消息的主题
支持自定义主题名称和使用变量命名主题两种方式。主题名称长度不能超过512个字符。
仅邮件类型支持配置消息主题。
test
正文
消息的内容
添加变量:
- 规则原始名称:${event_name}
- 告警级别:${event_severity}
- 发生时间:${starts_at}
- 发生区域:${region_name}
- 华为云账号:${domain_name}
- 告警源:$event.metadata.resource_provider
- 资源类型:$event.metadata.resource_type
- 资源标识:${resources}
- 告警状态:$event.annotations.alarm_status
- 表达式:$event.annotations.condition_expression
- 当前值:$event.annotations.current_value
- 统计周期:$event.annotations.frequency
- 规则名称:$event.annotations.alarm_rule_alias
- 关键词变量
- SQL变量
${event_name}
${event_severity}
${starts_at}
${region_name}
- 设置完成,单击“确定”完成消息模板创建。
- 输入模板名称、模板描述、消息模板类型和企业项目信息。
更多操作
消息模板创建完成后,您还可以对消息模板列表执行表4中的相关操作。