日志服务会按照内容模板中定义的内容向指定的通知渠道发送告警通知。本文档介绍创建内容模板的操作步骤。 ## 背景信息告警通知内容模板是一种预定义的文本模板，用于指定告警通知的内容及格式。内容模板支持添加变量、函数、文本等内容。在发送告警通知时，日志服务会自动将通知内容中的变量替换为对应的实际值，详细的内容变量列表请参考[内容变量](/docs/6470/163075)。日志服务提供默认的内容模板（default\-template），该模板不支持修改和删除，您可以在默认模板的基础上创建自定义的内容模板。 :::tip 您可以直接在内容模板中定义完整的告警通知内容，并将告警策略中的**通知内容**留空；对于**告警触发**类型的告警通知，您也可以在内容模板中配置通用的告警通知结构，并通过变量 `{{NotifyMsg}}` 引用告警策略中配置的**通知内容**。 ::: ## 操作步骤 1. 登录[日志服务控制台](https://console.volcengine.com/tls)。 2. 在顶部导航栏中，选择日志服务所在的地域。 3. 在左侧导航栏中，选择**常用功能** \> **日志告警** \> **通知管理**。 4. 在**内容模板**页签下，单击**创建内容模板**。 5. 填写内容模板的配置。 1. 设置**模板名称**。 2. 为各个通知渠道设置内容模板。 * 邮件 |配置 |说明 | |---|---| |固定内容语言 |告警通知中固定内容的语言，可选值为中文、英文。|\ | ||\ | |* 中文|\ | | ```Plain|\ | | 尊敬的用户，您好！您的账号（主账户ID：${AccountID}，用户名：${AccountName}）的日志服务有一条告警：|\ | | ```|\ | | |\ | |* 英文|\ | | ```Plain|\ | | Dear Customer: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}).|\ | | ```|\ | | | |主题 |邮件主题。 | |发送内容 |告警通知内容，支持普通文本格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[邮件](/docs/6470/181424#bcf3b252)。|\ | |:::tip|\ | ||\ | |* 变量渲染后的通知内容长度最长为 8 KB，超过限制长度后会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | ||\ | |:::| * 短信 |配置 |说明 | |---|---| |固定内容语言 |告警通知中固定内容的语言，可选值为中文、英文。|\ | ||\ | |* 中文|\ | | ```Plain|\ | | 日志服务告警：您的账号（主账户ID：${AccountID}，用户名：${AccountName}）的日志服务有一条告警：|\ | | ```|\ | | |\ | |* 英文|\ | | ```Plain|\ | | TLS Alarm: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}).|\ | | ```|\ | | | |发送内容 |告警通知内容，支持普通文本格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[短信](/docs/6470/181424#30f8f388)。|\ | |:::tip|\ | ||\ | |* 建议将变量渲染后的通知内容长度控制在 256 个字符以内，超过限制长度后可能会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | ||\ | |:::| * 电话 |配置 |说明 | |---|---| |固定内容语言 |告警通知中固定内容的语言，可选值为中文、英文。|\ | ||\ | |* 中文|\ | | ```SQL|\ | | 日志服务告警：您的账号（主账户ID：${AccountID}，用户名：${AccountName}）的日志服务有一条告警，请及时查看。|\ | | ```|\ | | |\ | |* 英文|\ | | ```SQL|\ | | TLS Alarm: Your account has an alarm ( Account ID:${AccountID}, User name :${AccountName}). Please log in to TLS console to view details.|\ | | ```|\ | | | |发送内容 |告警通知内容，支持普通文本格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[电话](/docs/6470/181424#4bab6c2d)。|\ | |:::tip|\ | ||\ | |* 建议将变量渲染后的通知内容长度控制在 256 个字符以内，超过限制长度后可能会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | ||\ | |:::| * 飞书 |配置 |说明 | |---|---| |标题 |告警通知内容的主题。 | |发送内容 |告警通知内容，支持 Markdown 格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。飞书所支持的内容语法，请参考[飞书富文本](https://open.larkoffice.com/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-components/content-components/rich-text)。飞书告警模板内容，请参考[飞书、钉钉、企业微信](/docs/6470/181424#204b8f67)。|\ | |:::tip|\ | ||\ | |* 变量渲染后的通知内容长度最长为 8 KB，超过限制长度后会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | |* 由于飞书侧限制，当通知内容中包含明文电话号码、明文邮箱地址等敏感信息时，可能导致飞书渠道的告警通知发送失败。详细说明，请参考 [230028 错误](https://open.larkoffice.com/search?from=header&page=1&pageSize=10&q=%E8%B0%83%E7%94%A8%E6%9C%8D%E5%8A%A1%E7%AB%AF%20API%20%E6%8A%A5%E9%94%99%EF%BC%9A230028&topicFilter=&type=history)。|\ | ||\ | |:::| * 钉钉 |配置 |说明 | |---|---| |发送内容 |告警通知内容，支持 Markdown 格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[飞书、钉钉、企业微信](/docs/6470/181424#204b8f67)。|\ | |:::tip|\ | ||\ | |* 变量渲染后的通知内容长度最长为 8 KB，超过限制长度后会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | ||\ | |:::| * 企业微信 |配置 |说明 | |---|---| |发送内容 |告警通知内容，支持 Markdown 格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[飞书、钉钉、企业微信](/docs/6470/181424#204b8f67)。|\ | |:::tip|\ | ||\ | |* 变量渲染后的通知内容长度最长为 4 KB，超过限制长度后会被截断。|\ | |* **正文**为空，表示使用默认内容。|\ | |* 当您在通知组中设置**提醒方式**为**所有人**或**指定人**时，发送到企业微信的通知内容将为普通文本格式，不支持 Markdown 格式。|\ | ||\ | |:::| * 自定义 Webhook |配置 |说明 | |---|---| |发送内容 |告警通知内容，通常为 JSON 格式，支持插入内容变量、内容函数等。详情说明请参考[内容变量](/docs/6470/163075)、[内容函数](/docs/6470/163078)。|\ | |您也可以单击**填入默认内容**，使用内置的通知内容。具体内容请参考[自定义 Webhook](/docs/6470/181424#8af98848)。|\ | |:::tip|\ | ||\ | |* 变量渲染后的通知内容长度最长为 16 KB，超过限制长度后会被截断。|\ | |* **正文**留空，表示使用默认内容。|\ | ||\ | |:::| 6. 单击**确定**。系统会自动校验您所配置的内容变量及语法。如果提示错误信息，请根据错误信息修改内容。 ## 默认内容日志服务提供默认的通知内容，您可以基于默认内容设置自定义的通知内容。 ### 邮件 ```Plain 告警策略：{{Alarm}}
告警日志项目：{{ProjectName}}
告警日志主题：{{AlarmTopicName}}
告警级别：{{Severity}}
触发时间：{{StartTime}}
触发条件：{{Condition}}
通知类型：{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}
告警持续时间：{{Duration}}
附加通知内容：{{NotifyMsg}}
日志检索详情：[查看详情]({{QueryUrl|safe}})
告警详情：[查看详情(链接12小时后失效)]({{SignInUrl|safe}})
``` ### 短信 ```Plain 告警策略{{Alarm}}，告警日志项目：{{ProjectName}}，告警日志主题：{{AlarmTopicName}}，告警级别：{{Severity}}，通知类型：{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}，首次触发时间：{{StartTime}}，触发条件：{{Condition}}，当前查询结果：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]，\n附加通知内容：{{NotifyMsg}} ``` ### 电话 ```Plain 通知类型：{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%} ``` ### 飞书、钉钉、企业微信 ```Plain 尊敬的用户，您好！\n您的账号（主账户ID：{{AccountID}} ）的日志服务{%if NotifyType==1%}触发告警{%else%}告警恢复{%endif%}\n告警策略：{{Alarm}}\n告警日志主题：{{AlarmTopicName}}\n告警级别：{{Severity}}\n首次触发时间：{{StartTime}}\n触发条件：{{Condition}}\n当前查询结果：[{%-for x in TriggerParams-%}{{-x-}} {%-endfor-%}]\n附加通知内容：{{NotifyMsg|escapejs}}\n日志检索详情：[查看详情]({{QueryUrl|safe}})\n告警详情：[查看详情(链接12小时后失效)]({{SignInUrl|safe}})\n\n感谢对火山引擎的支持 ``` ### 自定义 Webhook ```JSON { "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](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)。 |元素 |数据格式 | |---|---| |换行 |```HTML|\ | |
|\ | |```|\ | | | |添加链接 |```HTML|\ | |链接|\ | |```|\ | | | |加粗 |```HTML|\ | |加粗|\ | |```|\ | | | |斜体 |```HTML|\ | |This can't be real!|\ | |```|\ | | | ### 飞书飞书渠道的通知内容支持 Markdown 语法，相关元素格式如下表所示。更多信息，请参考[飞书富文本](https://open.larkoffice.com/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-components/content-components/rich-text)。 |元素 |数据格式 | |---|---| |换行 |```Markdown|\ | |第一行
第二行|\ | |第一行
第二行|\ | |```|\ | | | |斜体 |```Markdown|\ | |*斜体*|\ | |```|\ | | | |加粗 |```Markdown|\ | |**粗体**|\ | |或|\ | |__粗体__|\ | |```|\ | | | |删除线 |```Markdown|\ | |~~删除线~~|\ | |```|\ | | | |超链接 |```Markdown|\ | ||\ | |```|\ | | | |@所有人 |```Markdown|\ | ||\ | |```|\ | | | |@指定人 |```Markdown|\ | ||\ | |```|\ | ||\ | |指定人的`user_id`获取方式，请参考[如何实现 @ 指定人](https://open.larkoffice.com/document/client-docs/bot-v3/add-custom-bot#272b1dee)。 | |彩色文本样式 |```Markdown|\ | ||\ | | 这是一个绿色文本|\ | ||\ | ||\ | | 这是一个红色文本|\ | ||\ | ||\ | | 这是一个灰色文本|\ | ||\ | |```|\ | | | |文字链接 |```Markdown|\ | |[开放平台](https://open.feishu.cn/)|\ | |```|\ | | | |图片 |```Markdown|\ | |![hover_text](image_key)|\ | |```|\ | | | |分割线 |```Markdown|\ | |\n ---\n|\ | |```|\ | | | |有序列表 |```Markdown|\ | |1. 有序列表1|\ | | 1. 有序列表 1.1|\ | |2. 有序列表2|\ | |```|\ | | | |无序列表 |```Markdown|\ | |- 无序列表1|\ | | - 无序列表 1.1|\ | |- 无序列表2|\ | |```|\ | | | |标签 |```Markdown|\ | |标签文本|\ | |```|\ | | | ### 钉钉钉钉渠道的通知内容支持 Markdown 语法，相关元素格式如下表所示。更多信息，请参见[自定义机器人发送消息的消息类型](https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type#66407430cd5xr)。 |元素 |数据格式 | |---|---| |标题 |```Markdown|\ | |# 一级标题|\ | |## 二级标题|\ | |### 三级标题|\ | |#### 四级标题|\ | |##### 五级标题|\ | |###### 六级标题|\ | |```|\ | | | |引用 |```Markdown|\ | |> A man who stands for nothing will fall for anything.|\ | |```|\ | | | |文字加粗、斜体 |```Markdown|\ | |**bold**|\ | |*italic*|\ | |```|\ | | | |链接 |```Markdown|\ | |[this is a link](http://name.com)|\ | |```|\ | | | |图片 |```Markdown|\ | |![](http://name.com/pic.jpg)|\ | |```|\ | ||\ | |建议不要超过 20 张图片。 | |无序列表 |```Markdown|\ | |- item1|\ | |- item2|\ | |```|\ | | | |有序列表 |```Markdown|\ | |1. item1|\ | |2. item2|\ | |```|\ | | | ### 企业微信企业微信渠道的通知内容支持 Markdown 语法，相关元素格式如下表所示。更多信息，请参见[企业微信通知内容 Markdown 语法](https://developer.work.weixin.qq.com/document/path/91770#markdown%E7%B1%BB%E5%9E%8B)。 |元素 |数据格式 | |---|---| |标题 |```Markdown|\ | |# 标题一|\ | |## 标题二|\ | |### 标题三|\ | |#### 标题四|\ | |##### 标题五|\ | |###### 标题六|\ | |```|\ | | | |加粗 |```Markdown|\ | |**bold**|\ | |```|\ | | | |链接 |```Markdown|\ | |[这是一个链接](http://work.weixin.qq.com/api/doc)|\ | |```|\ | | | |行内代码段 |```Markdown|\ | |`code`|\ | |```|\ | | | |引用 |```Markdown|\ | |> 引用文字|\ | |```|\ | | | |字体颜色 |```Markdown|\ | |绿色|\ | |灰色|\ | |橙红色|\ | |```|\ | | |