全部产品
Search
文档中心

日志服务:通知内容定制

更新时间:Aug 02, 2023

日志服务支持您在配置内容模板时,定制通知内容。

使用模板变量丰富通知内容

您在配置内容模板时,可在标题或消息内容中添加模板变量。日志服务发送告警通知时,会将消息内容和标题中的模板变量替换为真实值。例如{{ alert.project }}替换为实际的Project名称。

每次产生告警时,系统自动生成告警上下文信息,存储于Results字段中。Results字段中的子字段都可作为模板变量。更多信息,请参见内容模板语法(新版)内容模板变量说明(新版)

新旧版内容模板对比

新版告警支持两个版本的内容模板语法。相对于旧版的内容模板语法,新版提供更加灵活且高级的自定义渲染逻辑。

功能

新版

旧版

引用方式

  • 普通字段:{{ alert.project }}

  • 嵌套字段:{{ alert.policy.alert_policy_id }}

  • 数组元素:{{ alert.results[0] }}

  • 数组元素字段:{{ alert.results[0].query }}

  • 普通字段:${project}

  • 嵌套字段:${policy.alert_policy_id}

  • 数组元素:${results[0]}

  • 数组元素字段:${results[0].query}

模板变量

内容和样式分离。由告警变量提供内容,通过控制流和函数实现多样化的样式。更多信息,请参见内容模板变量说明(新版))。

内容和样式不分离,都由告警变量提供。更多信息,请参见内容模板变量说明(旧版)

控制流(条件判断、迭代等)

支持。更多信息,请参见内容模板语法(新版)

不支持。

过滤器处理

支持。更多信息,请参见内置模板函数

不支持。

内容格式

  • 钉钉

    钉钉渠道的内容支持Markdown语法,具体支持的元素如下。

    • 标题

      # 一级标题
      ## 二级标题
      ### 三级标题
      #### 四级标题
      ##### 五级标题
      ###### 六级标题
    • 引用

      > A man who stands for nothing will fall for anything.
    • 文字加粗、斜体

      **bold**
      *italic*
    • 链接

      [this is a link](http://example.com)
    • 图片

      ![](http://example.com/pic.jpg)
    • 无序列表

      - item1
      - item2
    • 有序列表

      1. item1
      2. item2
  • 企业微信

    企业微信渠道的内容支持Markdown语法,具体支持的元素如下。

    重要

    \n\n在企业微信的消息内容中会被渲染为\n,因此如果您需要空行效果,请使用\n\n\n

    • 标题

      # 标题一
      ## 标题二
      ### 标题三
      #### 标题四
      ##### 标题五
      ###### 标题六
    • 加粗

      **bold**
    • 链接

      [这是一个链接](http://work.weixin.qq.com/api/doc)
    • 行内代码段

      `code`
    • 引用

      > 引用文字
    • 字体颜色

      只支持3种内置颜色。

      <font color="info">绿色</font>
      <font color="comment">灰色</font>
      <font color="warning">橙红色</font>
  • 飞书

    飞书渠道的内容支持Markdown语法,具体支持的元素如下。

    • 加粗

      **粗体**
    • 斜体

      *斜体*
    • 删除线

      ~~删除线~~
    • 超链接

      <a>https://open.feishu.cn</a>
    • 文字链接

      [开发文档](https://open.feishu.cn)
    • 图片

      ![hover_text](image_key)
    • 分割线

      ---
  • Slack

    Slack应用中的Incoming Webhook支持Markdown类型的消息,但只支持部分Markdown语法。更多信息,请参见Slack Markdown Reference

  • Webhook

    Webhook渠道支持逐条发送和合并发送。

    • 内容模板:

      {
        "项目": "${project}",
        "告警名称": "${alert_name}"
      }
    • 合并发送的通知内容:

      [
        {
          "项目": "project-name1",
          "告警名称": "alert-name1"
        },
        {
          "项目": "project-name2",
          "告警名称": "alert-name2"
        }
      ]
  • 邮件

    邮件渠道的内容支持HTML标签。更多信息,请参见HTML。例如:

    • 使用<br>换行。

    • 使用<a href="${query_url}">查看详情</a>添加链接。您可以单击该链接查看触发告警的详细信息。

    • 使用<strong>${severity}</strong>加粗显示告警严重度。