通知模板参考
Prometheus 创建告警并将其发送到 Alertmanager,后者再根据标签将通知发送到不同的接收器。接收器可以是多种集成之一,包括:Slack、PagerDuty、电子邮件,或通过通用 webhook 接口的自定义集成。
发送给接收器的通知是通过模板构建的。Alertmanager 附带了默认模板,但也可以进行自定义。为避免混淆,需要注意的是 Alertmanager 模板不同于 Prometheus 中的模板,但 Prometheus 模板也包括告警规则标签/注释中的模板。
Alertmanager 的通知模板基于 Go 模板 系统。请注意,某些字段被评估为文本,而其他字段则为 HTML,这将影响转义。
数据结构
数据
Data
是传递给通知模板和 webhook 推送的结构。
名称 | 类型 | 注释 |
---|---|---|
接收器 | 字符串 | 定义将发送通知的接收器名称(slack、email 等)。 |
状态 | 字符串 | 如果至少有一个告警正在触发,则定义为 firing,否则为 resolved。 |
告警 | 告警 | 此组中所有告警对象的列表(见下文)。 |
GroupLabels | KV | 这些告警分组所依据的标签。 |
CommonLabels | KV | 所有告警的共同标签。 |
CommonAnnotations | KV | 所有告警的共同注释集。用于提供有关告警的更长的附加信息字符串。 |
ExternalURL | 字符串 | 返回到发送通知的 Alertmanager 的反向链接。 |
Alerts
类型公开了用于过滤告警的函数
Alerts.Firing
返回此组中当前正在触发的告警对象列表Alerts.Resolved
返回此组中已解决的告警对象列表
告警
Alert
为通知模板保存一个告警。
名称 | 类型 | 注释 |
---|---|---|
状态 | 字符串 | 定义告警是已解决还是当前正在触发。 |
标签 | KV | 要附加到告警的一组标签。 |
注释 | KV | 告警的一组注释。 |
StartsAt | time.Time | 告警开始触发的时间。如果省略,则由 Alertmanager 分配当前时间。 |
EndsAt | time.Time | 仅在告警结束时间已知时设置。否则,设置为从收到最后一次告警以来的可配置超时时间。 |
GeneratorURL | 字符串 | 一个反向链接,用于识别此告警的触发实体。 |
Fingerprint | 字符串 | 可用于识别告警的指纹。 |
KV
KV
是一组键/值字符串对,用于表示标签和注释。
type KV map[string]string
包含两个注释的注释示例
{
summary: "alert summary",
description: "alert description",
}
除了直接访问存储为 KV 的数据(标签和注释)外,还有用于排序、移除和查看 LabelSet 的方法。
KV 方法
名称 | 参数 | 返回 | 注释 |
---|---|---|---|
SortedPairs | - | Pairs(键/值字符串对列表) | 返回一个排序的键/值对列表。 |
移除 | []字符串 | KV | 返回不含给定键的键/值映射的副本。 |
名称 | - | []字符串 | 返回 LabelSet 中标签名称的名称。 |
值 | - | []字符串 | 返回 LabelSet 中值的列表。 |
函数
请注意 Go 模板也提供了默认函数。
字符串
名称 | 参数 | 返回 | 注释 |
---|---|---|---|
title | 字符串 | strings.Title,将每个单词的首字母大写。 | |
toUpper | 字符串 | strings.ToUpper,将所有字符转换为大写。 | |
toLower | 字符串 | strings.ToLower,将所有字符转换为小写。 | |
trimSpace | 字符串 | strings.TrimSpace,移除前导和尾随的空白字符。 | |
match | 模式,字符串 | Regexp.MatchString。使用正则表达式匹配字符串。 | |
reReplaceAll | 模式,替换,文本 | Regexp.ReplaceAllString 正则表达式替换,非锚定。 | |
join | 分隔符字符串,s []字符串 | strings.Join,连接 s 的元素以创建一个单一字符串。分隔符字符串 sep 放置在结果字符串的元素之间。(注意:为了在模板中更方便地进行管道操作,参数顺序已颠倒。) | |
safeHtml | 文本字符串 | html/template.HTML,将字符串标记为 HTML,无需自动转义。 | |
stringSlice | ...字符串 | 将传入的字符串作为字符串切片返回。 | |
date | 字符串, time.Time | 返回指定格式的时间的文本表示。有关格式的文档,请参考 pkg.go.dev/time。 | |
tz | 字符串, time.Time | 返回指定时区的时间。例如,Europe/Paris。 | |
since | time.Time | time.Duration,返回从提供的时间到当前系统时间所经过的时长。 | |
humanizeDuration | 数字或字符串 | 返回一个人类可读的字符串,表示持续时间,如果发生错误,则返回错误。 |