更新时间:2024-09-06 GMT+08:00

创建消息模板

AOM提供消息模板功能,可通过创建消息模板自定义配置通知消息,当AOM触发已设定的告警通知策略时,可通过此功能以您自定义消息模板的邮件、短信、飞书、企业微信、钉钉、语音、welink、HTTP或HTTPS形式通知指定的人员。如果您未创建任何消息模板,则采用默认消息模板。

功能介绍

  • 支持邮件、短信、企业微信、钉钉、飞书、语音、welink、HTTP或HTTPS消息模板。

    welink消息模板当前受限开放,如有需求可以通过提交工单,联系工程师为您开放此功能。

  • 支持消息模板自定义。参考自定义消息模板内容

注意事项

  • 您最多可创建100个“指标或事件”类型的消息模板,100个日志类型的消息模板,如果某种类型的消息模板数量已达上限100时,请删除不需要的消息模板。
  • 系统默认预置6个消息模板,预置消息模板不可删除与编辑。当用户未自定义消息模板时,默认采用预置消息模板发送通知。

创建消息模板

  1. 登录AOM 2.0控制台。
  2. 在左侧导航栏中选择“告警管理 > 告警行动规则”。
  3. 在右侧区域的“消息模板”页签下,单击“创建消息模板”。

    图1 创建消息模板
    1. 输入模板名称、模板描述、消息模板类型和企业项目信息。
      表1 参数说明

      参数名称

      说明

      模板名称

      消息模板的名称,只能由中文、数字、字母、下划线和中划线组成,且不能以下划线或中划线开头和结尾,最多可输入100个字符。

      模板描述

      消息模板的描述信息,最多可输入1024个字符。

      消息模板类型

      消息模板的类型,当前支持“指标或事件模板”和“日志模板”类型。

      企业项目

      所属的企业项目。

      • 如果在全局页面设置为“ALL”,此处请从下拉列表中选择企业项目。
      • 如果在全局页面已选择企业项目,则此处灰化不可选。
    2. 选择语言(目前仅支持中文简体和英文)。
    3. 自定义模板内容(创建指标或事件类消息模板时会自动填充默认字段),模板包括邮件、短信、企业微信、钉钉等。指标或事件模板具体请参见表2。日志模板具体请参见表3
      • 除默认模板的消息字段外,消息模板还支持用户自定义字段,需用户在上报事件告警信息时在指定参数上传该字段。对应参数见下方消息模板告警上报结构体。
      • 自定义字段支持以JSONPath的方式取值,示例:$event.metadata.case1、$event.metadata.case[0]
      • 在“正文”区域右上角,单击“添加变量”可添加需要的变量信息。
      • 选择“邮件”方式发送通知时,可单击“预览”查看设置的邮件消息模板效果。在预览界面,可根据需要修改消息主题。
      表2 默认消息模板变量说明

      变量名称

      变量说明

      变量定义

      告警名称

      触发的告警规则的名称。

      ${event_name}

      告警ID

      触发的告警规则的ID。

      ${id}

      告警行动规则

      发送告警通知的告警行动规则名称。

      ${action_rule}

      触发时间

      触发此告警或事件的时间。

      ${starts_at}

      触发级别

      创建告警规则时选择告警或事件级别:紧急、重要、次要、提示。

      ${event_severity}

      告警内容

      详细的告警信息说明。

      ${alarm_info}

      资源标识

      触发告警或事件对应的具体资源。

      ${resources}

      自定义标签

      标签扩展字段。

      $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
      • 关键词变量
        1. 查询时间:$event.annotations.results[0].time
        2. 查询日志:

          $event.annotations.results[0].raw_results

        3. 查询URL:

          $event.annotations.results[0].url

        4. 日志组/日志流名称:$event.annotations.results[0].resource_id
          说明:

          只支持添加首次创建的日志组/日志流原始名称,不支持添加修改后的日志组/日志流名称。

      • SQL变量
        1. 图表0的日志组/流名称:$event.annotations.results[0].resource_id
          说明:

          只支持添加首次创建的日志组/日志流原始名称,不支持添加修改后的日志组/日志流名称。

        2. 图表0的查询语句:$event.annotations.results[0].sql
        3. 图表0的查询时间:$event.annotations.results[0].time
        4. 图表0的查询URL:$event.annotations.results[0].url
        5. 图表0的查询日志:$event.annotations.results[0].raw_results

      ${event_name}

      ${event_severity}

      ${starts_at}

      ${region_name}

    4. 设置完成,单击“确定”完成消息模板创建。

更多操作

消息模板创建完成后,您还可以对消息模板列表执行表4中的相关操作。

表4 相关操作

操作

说明

编辑消息模板

单击“操作”列的“编辑”。

复制消息模板

单击“操作”列的“复制”。

删除消息模板

  • 删除单条消息模板:单击对应规则“操作”列的“删除”,随后在提示页面单击“确定”即可删除。
  • 删除单条或多条消息模板:勾选对应规则前的复选框,单击“批量删除”,随后在提示页面单击“确定”即可删除。
    说明:

    删除消息模板前需要先删除消息模板绑定的告警行动规则。

搜索消息模板

在右上角的搜索框中输入模板名称关键字,单击后显示匹配对象。