You need to enable JavaScript to run this app.
导航
创建内容模板
最近更新时间:2024.12.05 11:58:37首次发布时间:2023.02.23 11:06:47

日志服务会按照内容模板中定义的内容向指定的通知渠道发送告警通知。本文档介绍创建内容模板的操作步骤。

背景信息

告警通知内容模板是一种预定义的文本模板,用于指定告警通知的内容及格式。内容模板支持添加变量、函数、文本等内容。在发送告警通知时,日志服务会自动将通知内容中的变量替换为对应的实际值,详细的内容变量列表请参考内容变量
日志服务提供默认的内容模板(default-template),该模板不支持修改和删除,您可以在默认模板的基础上创建自定义的内容模板。

说明

您可以直接在内容模板中定义完整的告警通知内容,并将告警策略中的通知内容留空;对于告警触发类型的告警通知,您也可以在内容模板中配置通用的告警通知结构,并通过变量 {{NotifyMsg}} 引用告警策略中配置的通知内容

操作步骤

  1. 登录日志服务控制台

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

  3. 在左侧导航栏中,选择常用功能 > 日志告警 > 通知管理

  4. 内容模板页签下,单击创建内容模板

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

    1. 设置模板名称
    2. 为各个通知渠道设置内容模板。
      • 邮件

        配置

        说明

        固定内容语言

        告警通知中固定内容的语言,可选值为中文、英文。

        • 中文

          尊敬的用户,您好! 您的账号(主账户ID:${AccountID},用户名:${AccountName})的日志服务有一条告警:
          
        • 英文

          Dear Customer: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}).
          

        通知内容

        • 主题:邮件主题。
        • 正文:告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
          您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考邮件

          说明

          • 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。
          • 正文留空,表示使用默认内容。
      • 短信

        配置

        说明

        固定内容语言

        告警通知中固定内容的语言,可选值为中文、英文。

        • 中文

          日志服务告警: 您的账号(主账户ID:${AccountID},用户名:${AccountName})的日志服务有一条告警:
          
        • 英文

          TLS Alarm: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}).
          

        通知内容

        告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
        您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考短信

        说明

        • 建议将变量渲染后的通知内容长度控制在 256 个字符以内,超过限制长度后可能会被截断。
        • 正文留空,表示使用默认内容。
      • 电话

        配置

        说明

        固定内容语言

        告警通知中固定内容的语言,可选值为中文、英文。

        • 中文

          日志服务告警:您的账号(主账户ID:${AccountID},用户名:${AccountName})的日志服务有一条告警,请及时查看。
          
        • 英文

          TLS Alarm: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}). Please log in to TLS console to view details.
          

        通知内容

        告警通知内容,支持普通文本格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
        您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考电话

        说明

        • 建议将变量渲染后的通知内容长度控制在 256 个字符以内,超过限制长度后可能会被截断。
        • 正文留空,表示使用默认内容。
      • 飞书

        配置

        说明

        通知内容

        • 标题:告警通知内容的主题。
        • 正文:告警通知内容,支持 Markdown 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
          您也可以单击填入默认内容,使用内置的通知内容。飞书所支持的内容语法,请参考飞书富文本。飞书告警模板内容,请参考飞书、钉钉、企业微信

          说明

          • 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。
          • 正文留空,表示使用默认内容。
      • 钉钉

        配置

        说明

        通知内容

        告警通知内容,支持 Markdown 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
        您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考飞书、钉钉、企业微信

        说明

        • 变量渲染后的通知内容长度最长为 8 KB,超过限制长度后会被截断。
        • 正文留空,表示使用默认内容。
      • 企业微信

        配置

        说明

        通知内容

        告警通知内容,支持 Markdown 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
        您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考飞书、钉钉、企业微信

        说明

        • 变量渲染后的通知内容长度最长为 4 KB,超过限制长度后会被截断。
        • 正文为空,表示使用默认内容。
        • 当您在通知组中设置提醒方式所有人指定人时,发送到企业微信的通知内容将为普通文本格式,不支持 Markdown 格式。
      • 自定义 Webhook

        配置

        说明

        通知内容

        告警通知内容,通常为 JSON 格式,支持插入内容变量、内容函数等。详情说明请参考内容变量内容函数
        您也可以单击填入默认内容,使用内置的通知内容。具体内容请参考自定义 Webhook

        说明

        • 变量渲染后的通知内容长度最长为 16 KB,超过限制长度后会被截断。
        • 正文留空,表示使用默认内容。
  6. 单击确定
    单击确定后,系统会自动校验您所配置的内容变量及语法。如果提示错误信息,请根据错误信息修改内容。

默认内容

日志服务提供默认的通知内容,您可以基于默认内容设置自定义的通知内容。

邮件

告警策略:{{Alarm}}<br> 
告警日志项目:{{ProjectName}}<br> 
告警日志主题:{{AlarmTopicName}}<br> 
告警级别:{{Severity}}<br> 
触发时间:{{StartTime}}<br> 
触发条件:{{Condition}}<br> 
通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}<br> 
告警持续时间:{{Duration}}<br> 
通知内容:{{NotifyMsg}}

短信

告警策略{{Alarm}}, 告警日志项目:{{ProjectName}}, 告警日志主题:{{AlarmTopicName}}, 告警级别:{{Severity}}, 通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%},触发时间:{{StartTime}}, 触发条件:{{Condition}}, 当前查询结果:[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}], 通知内容:{{NotifyMsg}}

电话

通知类型:{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}

飞书、钉钉、企业微信

尊敬的用户,您好!\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日志检索详情:[查看详情]({{QueryUrl}})\n告警详情:[查看详情]({{SignInUrl}})\n\n感谢对火山引擎的支持

自定义 Webhook

{
  "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"
      }
    }
  }
}

定制内容格式

日志服务支持定制通知内容,相关内容格式说明如下:

邮件

邮件渠道的通知内容支持 HTML 标签。更多信息,请参见HTML elements reference

元素

数据格式

换行

<br>

添加链接

<a href="https://example.com">链接</a>

加粗

<strong>加粗</strong>

斜体

<i>This can't be real!</i>

飞书

飞书渠道的通知内容支持 Markdown 语法,相关元素格式如下表所示。更多信息,请参考飞书富文本

元素

数据格式

换行

第一行<br />第二行
第一行<br>第二行

斜体

*斜体*

加粗

**粗体**
或
__粗体__

删除线

~~删除线~~

超链接

<a href='https://open.feishu.cn'></a>

@所有人

<at id=all></at>

彩色文本样式

<font color='green'>
  这是一个绿色文本
</font>
<font color='red'>
  这是一个红色文本
</font>
<font color='grey'>
  这是一个灰色文本
</font>

文字链接

[开放平台](https://open.feishu.cn/)

图片

![hover_text](image_key)

分割线

\n ---\n

有序列表

1. 有序列表1
    1. 有序列表 1.1
2. 有序列表2

无序列表

- 无序列表1
    - 无序列表 1.1
- 无序列表2

标签

<text_tag color='red'>标签文本</text_tag>

钉钉

钉钉渠道的通知内容支持 Markdown 语法,相关元素格式如下表所示。更多信息,请参见自定义机器人发送消息的消息类型

元素

数据格式

标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

引用

> A man who stands for nothing will fall for anything.

文字加粗、斜体

**bold**
*italic*

链接

[this is a link](http://name.com)

图片

![](http://name.com/pic.jpg)

建议不要超过 20 张图片。

无序列表

- item1
- item2

有序列表

1. item1
2. item2

企业微信

企业微信渠道的通知内容支持 Markdown 语法,相关元素格式如下表所示。更多信息,请参见企业微信通知内容 Markdown 语法

元素

数据格式

标题

# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六

加粗

**bold**

链接

[这是一个链接](http://work.weixin.qq.com/api/doc)

行内代码段

`code`

引用

> 引用文字

字体颜色

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