通知模板示例
以下是各种告警及其对应的 Alertmanager 配置文件 (alertmanager.yml) 设置示例。它们均使用 Go 模板 系统。
自定义 Slack 通知
在此示例中,我们自定义了 Slack 通知,使其发送一个指向我们组织 Wiki 的 URL,说明如何处理已发送的特定告警。
global:
# Also possible to place this URL in a file.
# Ex: `slack_api_url_file: '/etc/alertmanager/slack_url'`
slack_api_url: '<slack_webhook_url>'
route:
receiver: 'slack-notifications'
group_by: [alertname, datacenter, app]
receivers:
- name: 'slack-notifications'
slack_configs:
- channel: '#alerts'
text: 'https://internal.myorg.net/wiki/alerts/{{ .GroupLabels.app }}/{{ .GroupLabels.alertname }}'
访问 CommonAnnotations 中的注释
在这个示例中,我们再次自定义发送给 Slack 接收器的文本,通过访问 Alertmanager 发送的数据中的 CommonAnnotations 来获取 summary(摘要)和 description(描述)。
告警
groups:
- name: Instances
rules:
- alert: InstanceDown
expr: up == 0
for: 5m
labels:
severity: page
# Prometheus templates apply here in the annotation and label fields of the alert.
annotations:
description: '{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 5 minutes.'
summary: 'Instance {{ $labels.instance }} down'
接收器
- name: 'team-x'
slack_configs:
- channel: '#alerts'
# Alertmanager templates apply here.
text: "<!channel> \nsummary: {{ .CommonAnnotations.summary }}\ndescription: {{ .CommonAnnotations.description }}"
遍历所有收到的告警
最后,假设与上一个示例中的告警相同,我们自定义接收器以遍历从 Alertmanager 收到的所有告警,并在新行中打印它们各自的注释摘要和描述。
接收器
- name: 'default-receiver'
slack_configs:
- channel: '#alerts'
title: "{{ range .Alerts }}{{ .Annotations.summary }}\n{{ end }}"
text: "{{ range .Alerts }}{{ .Annotations.description }}\n{{ end }}"
定义可重用模板
回到我们的第一个示例,我们还可以提供一个包含命名模板的文件,这些模板由 Alertmanager 加载,以避免使用跨越多行的复杂模板。在 /alertmanager/template/myorg.tmpl 下创建一个文件,并在其中创建一个名为 "slack.myorg.text" 的模板。
{{ define "slack.myorg.text" }}https://internal.myorg.net/wiki/alerts/{{ .GroupLabels.app }}/{{ .GroupLabels.alertname }}{{ end}}
配置现在会为 "text" 字段加载具有给定名称的模板,并且我们提供了自定义模板文件的路径。
global:
slack_api_url: '<slack_webhook_url>'
route:
receiver: 'slack-notifications'
group_by: [alertname, datacenter, app]
receivers:
- name: 'slack-notifications'
slack_configs:
- channel: '#alerts'
text: '{{ template "slack.myorg.text" . }}'
templates:
- '/etc/alertmanager/templates/myorg.tmpl'
此示例在这篇 博客文章 中有更详细的解释。