You need to enable JavaScript to run this app.
导航

内容模板

最近更新时间2023.12.21 18:01:27

首次发布时间2023.02.23 11:06:47

告警组的自定义接口回调渠道支持配置通知内容模板,日志服务将按照内容模板中定义的发送内容发送告警通知。

背景信息

日志服务的告警策略应与告警组绑定,告警组中定义了告警通知的发送渠道、发送方式及接收对象。如果指定以自定义接口回调的方式发送告警通知,则需要为告警组配置内容模板,日志服务将按照内容模板中定义的发送内容发送告警通知。
内容模板中定义了 WebHook HTTP 请求的请求体,格式应符合目标服务的回调接口要求。内容模板中支持配置 AccountID 等内容变量,自动将通知内容中的变量替换为对应的实际值,详细的内容变量列表请参考内容变量
日志服务提供默认内容模板,该模板不支持修改或删除,您可以在默认模板的基础上配置自定义的内容模板。

说明

  • 内容模板中应包含表示告警通知内容的字段,例如飞书群机器人的“content”字段。
  • 您可以直接在内容模板中定义完整的告警通知内容,并将告警策略的通知内容部分留空;对于告警触发类型的告警通知,您也可以在内容模板中配置通用的告警通知结构,并通过内容变量 NotifyMsg 引用告警策略中配置的通知内容

创建内容模板

  1. 登录日志服务控制台

  2. 在顶部导航栏中选择日志服务所在的地域。

  3. 在左侧目录中选择日志服务 > 通知内容模板

  4. 在页面左上角单击创建通知内容模板

  5. 填写内容模板的配置。

    配置

    说明

    模板名称

    通知内容模板的名称。

    自定义回调

    自定义回调渠道的通知内容,即自定义回调的 HTTP 请求体。通常为 JSON 格式,其字段格式应符合内容模板对应渠道的回调格式要求。支持通过引用内容变量展示告警相关的信息,内容变量列表请参考内容变量
    您可以直接在内容区域填写通知内容,也可以单击填入默认内容,直接使用日志服务预置的通知模板,或在默认内容的基础上进行自定义修改。

    说明

    • 默认内容适用于飞书群机器人通知消息,其他渠道使用默认模板时建议通过告警测试功能预览通知效果。
    • 发送内容设置为空,表示使用默认内容。
  6. 单击确定

内容模板示例

以观测某网站的访问情况为例,常见渠道的内容模板如下。

飞书机器人通知

{
  "msg_type": "interactive",
  "card": {
    "config": {
      "wide_screen_mode": true
    },
    "elements": [
      {
        "content": "尊敬的用户,您好!\n您的账号(主账户ID:{{AccountID}} )的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\n告警策略:{{Alarm}}\n告警日志主题:{{AlarmTopicName}}\n触发时间:{{StartTime}}\n触发条件:{{Condition}}\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}];\n通知内容:{{NotifyMsg|escapejs}}\n\n感谢对火山引擎的支持",
        "tag": "markdown"
      }
    ],
    "header": {
      "template": "{%if NotifyType==1%}red{%else%}green{%endif%}",
      "title": {
        "content": "【火山引擎】【日志服务】{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}",
        "tag": "plain_text"
      }
    }
  }
}

企业微信通知

{
    "msgtype": "text",
    "text": {
        "content": " [火山引擎][日志服务]{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}   \n尊敬的用户,您好!\n您的账号(主账户ID:{{AccountID}},用户名:{{UserName}})的日志服务触发告警\n告警策略:{{Alarm}}\n告警日志主题:{{AlarmTopicName}}\n触发时间:{{StartTime}}\n触发条件:{{Condition|safe}}\n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}}, {%-endfor-%}];\n通知内容:{{NotifyMsg}}\n\n\n感谢对火山引擎的支持"
    }
}

钉钉机器人通知

{
    "msgtype": "text",
    "text": {
        "content": " [火山引擎][日志服务]{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}   \n尊敬的用户,您好!    \n您的账号(主账户ID:{{AccountID}})的日志服务触发告警    \n告警策略:{{Alarm}}    \n告警日志主题:{{AlarmTopicName}}    \n触发时间:{{StartTime}}    \n触发条件:{{Condition|safe}}    \n当前查询结果:[{%-for x in TriggerParams-%}{{-x-}}, {%-endfor-%}]    \n通知内容:{{NotifyMsg}}    \n感谢对火山引擎的支持"
    },
    "at": {
        "isAtAll": true
    }
}

相关操作

  • 查看内容模板:在通知内容模板列表页中即可查看当前地域下的所有内容模板,包括日志服务提供的默认模板和自定义模板。单击模板名称可以查看模板的发送内容等基本信息。
  • 复制内容模板:在通知内容模板列表页中找到指定模板,在其对应的操作列单击复制即可快速复制出一个新的模板。您也可以在此模板的基础上修改配置,适用于快速创建相似模板的场景。
  • 编辑内容模板:在通知内容模板列表页中找到指定模板,在其对应的操作列单击编辑即可修改模板内容。默认模板不支持修改内容。
  • 删除内容模板:在通知内容模板列表页中找到指定模板,在其对应的操作列单击删除即可删除指定模板。默认模板不支持删除。