更新时间:2024-11-01 GMT+08:00
分享

在LTS页面创建消息模板

消息模板是告警通知消息的固定格式,系统发送告警通知消息必须使用消息模板向订阅者发送。默认内置消息模板分别为关键词模板、keywords_template、sql模板和sql_template。不同协议的订阅者优先选择模板名称对应的协议模板,如果对应的协议模板不存在,则采用内置的消息模板。使用消息模板发送告警通知消息时,系统会自动将模板变量替换为告警规则中的内容。

创建消息模板

  1. 登录云日志服务控制台
  2. 左侧导航选择“日志告警”,进入告警页面,选择“告警行动规则”。

    消息模板默认有以下内置模板,当您所选择的消息模板中未配置消息内容时,云日志服务默认使用内置模板。
    • 关键词模板:关键词告警模板
    • keywords_template:关键词告警英文模板
    • sql模板:sql告警模板
    • sql_template:sql告警英文模板

  3. 在消息模板页签,单击“创建”,在界面右侧弹出的“创建消息模板”页面中,配置消息模板的相关参数。

    • 邮件内容支持html标签和消息预览。
    • 企业微信、钉钉、飞书支持markdown语法和消息预览。
    • 针对AOM和LTS,最多可以创建100(包含)条消息模板,如果消息模板数量已达上限100个时,请删除不需要的消息模板后重新创建。
    表1 配置消息模板参数

    参数名称

    说明

    校验规则

    样例

    模板名称

    消息模板的名称

    输入内容只能是数字、字母、下划线、汉字、中划线,且不能以下划线、中划线等特殊符号开头和结尾。长度不能超过100个字符。

    LTS-test

    模板描述

    对消息模板的描述

    输入内容只能是数字、字母、下划线、汉字,且不能以下划线等特殊符号开头和结尾。长度不能超过1024个字符。

    -

    消息头语言

    系统在发送消息时会默认添加消息头

    • 中文(简体)
    • 英文
    • 中文:“尊敬的用户...”
    • 英文:“Dear User...”

    通知方式

    消息的通知方式类型

    • 邮件
    • 短信
    • HTTP/HTTPS
    • 钉钉
    • 飞书
    • 企业微信
    • 语音
      说明:

      语音和飞书的功能仅针对白名单用户提交工单申请使用。详细操作请参考提交工单

    -

    主题

    消息的主题

    支持自定义主题名称和使用变量命名主题两种方式。主题名称长度不能超过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.condition_expression_with_value
    • 统计周期:$event.annotations.frequency
    • 规则名称:$event.annotations.alarm_rule_alias
    • 通知频率:$event.annotations.notification_frequency
    • 日志组原始名称:$event.annotations.results[0].log_group_name
    • 日志流原始名称:$event.annotations.results[0].log_stream_name
    • 关键词告警支持的变量
      1. 查询时间:$event.annotations.results[0].time
      2. 查询日志:(日志长度最多2KB,超过2KB被截断丢弃

        $event.annotations.results[0].raw_results

      3. 查询URL:

        $event.annotations.results[0].url

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

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

      5. 日志流的企业项目ID:$event.annotations.results[0].eps_id
      6. 查询自定义字段$event.annotations.results[0].fields.xxx
        说明:

        xxx表示原始日志的结构化字段和内置字段(hostIP、hostName等),日志字段长度最多1KB,超过1KB被截断丢弃

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

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

        0代表第一个图表,1代表第二个图表,以此类推。

      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
      6. 图表0的日志流的企业项目ID:$event.annotations.results[0].eps_id

    复制模板:

    • keywords_template
    • sql_template
    • sql模板
    • 关键词模板
    • 自定义模板(用户通过添加变量创建的消息模板)

    ${event_name}

    ${event_severity}

    ${starts_at}

    ${region_name}

  4. 配置完成后,单击“确定”。

    在LTS页面创建消息模板时提示“创建消息模板失败,名称不能重复”,可以参考如下步骤进行排查处理。

    1. 请检查消息模板名称是否有重复。

      若有重复,请重新修改消息模板名称。因为,LTS的消息模板数据源与AOM消息模板数据源为同一个,消息模板名称不能重复,如果在AOM中创建了名称为test的消息模板,在LTS页面不能创建同名的消息模板。

    2. 请检查消息模板数量是否超过100个。

      针对AOM和LTS,最多可以创建100(包含)条消息模板,当消息模板数量已达上限100个时,请删除不需要的消息模板后重新创建。

编辑消息模板

  1. 在消息模板列表中,单击消息模板名称行后的“修改”,根据表1进行修改,其中“模板名称”不可修改。

    内置消息模板不支持编辑。

  2. 编辑完成后,单击“确认”。

复制消息模板

  1. 在消息模板列表中,单击消息模板名称行后的“复制”,修改消息模板的模板名称。
  2. 完成后,单击“确认”。

删除消息模板

  1. 在消息模板列表中,单击消息模板名称行后的“删除”。

    内置消息模板不支持删除。

  2. 在弹出的对话框中,单击“确认”删除该消息模板。

批量删除消息模板

  1. 在消息模板列表中,勾选待删除的消息模板,单击列表左上方“批量删除”。
  2. 在弹出的删除消息模板页面,单击“确定”,删除所勾选的消息模板。

导出消息模板

  1. 在消息模板列表中,勾选待导出的消息模板,单击列表左上方“导出”。
  2. 选择“导出全部数据到XLSX”或“导出已选中数据到XLSX”,导出成功后即可到本地查看消息模板数据。

相关文档