跳到主要内容
版本:3.9.x

告警变量与模板

告警策略通知(电子邮件和消息)可以使用预定义变量进行自定义,以提供动态内容。

告警变量

告警变量是模板中的数据求值,由 {{}} 分隔。

在创建告警通知(告警消息、告警邮件主题、告警邮件内容)时,可以使用以下变量。

变量描述
{{ .AlertPolicyName }}告警策略的名称。
{{ .Description }}告警策略的描述。
{{ .Severity }}告警策略的严重级别。
{{ .TriggerGatewayGroup }}触发告警的网关组名称。可以指定多个组,用逗号分隔。
{{ .AlertTime }}告警时间。
{{ .AlertDetail }}触发告警的具体事件的详细描述。多个事件将分别列出。
{{ .AlertTime.Format "2024 Dec 31 17:00:00" }}
  • AlertDetail 字段是一个字符串,可以包含多个事件详情,由换行符(\n)分隔。要在 JSON 请求体中使用此字段,请确保正确转义换行符。
{{ .AlertDetail | escape }}

模板

配置告警通知的示例。

告警邮件主题

[API7 告警] {{.TriggerGatewayGroup}} 中没有足够的健康网关实例 - [{{.Severity}}]

告警邮件内容

尊敬的[收件人姓名]:

我们写信通知你,API7 网关在 {{.AlertTime.Format "2006 Jan 02 15:04:05"}} 触发了告警。具体告警严重级别为 {{.Severity}}。

告警详情:

网关组:{{.TriggerGatewayGroup}}
告警消息:{{.AlertDetail}}

建议操作:

进一步调查:请前往查看相关的日志和指标以获取更多详细信息。 重启服务:考虑重启服务。 升级至值班团队:如果问题仍然存在,请联系值班团队。

告警消息(JSON)

{
"text": "{{.AlertDetail | escape}}",
"timestamp": "{{.AlertTime.Format "2006 Jan 02 15:04:05"}}",
"system": "API7 Gateway, {{.TriggerGatewayGroup}}"
}