自定义 Alertmanager 模板

Alertmanager 处理 Prometheus 服务器发送的警报，并根据标签将警报通知发送给不同的接收器。

接收器可以是许多不同的集成之一，例如 PagerDuty、Slack、电子邮件，或者通过通用 webhook 接口的自定义集成（例如 JIRA）。

模板

发送到接收器的消息通过模板构建。Alertmanager 带有默认模板，但也允许定义自定义模板。

在这篇博文中，我们将介绍一个简单的 Slack 通知自定义示例。

我们使用这个简单的 Alertmanager 配置，将所有警报发送到 Slack

global:
  slack_api_url: '<slack_webhook_url>'

route:
  receiver: 'slack-notifications'
  # All alerts in a notification have the same value for these labels.
  group_by: [alertname, datacenter, app]

receivers:
- name: 'slack-notifications'
  slack_configs:
  - channel: '#alerts'

默认情况下，Alertmanager 发送的 Slack 消息如下所示

它向我们展示了一个正在触发的警报，后面跟着警报分组的标签值（alertname、datacenter、app）以及警报共有的其他标签值（critical）。

自定义

如果你有警报，你应该也有关于如何处理它们的文档——操作手册。一个好方法是建立一个 wiki，其中为每个你正在运行的应用程序设置一个部分，每个警报对应一个页面。

假设我们在 https://internal.myorg.net/wiki/alerts 运行这样一个 wiki。现在我们希望在我们的 Slack 消息中显示这些操作手册的链接。

在我们的模板中，我们需要访问 "alertname" 和 "app" 标签。由于这些是我们用来分组警报的标签，它们在我们的模板数据的 GroupLabels 映射中可用。

我们可以直接将自定义模板添加到 Alertmanager 的 Slack 配置中，该配置用于我们的 Slack 消息的 text 部分。模板语言是 Go 编程语言提供的。

global:
  slack_api_url: '<slack_webhook_url>'

route:
- receiver: 'slack-notifications'
  group_by: [alertname, datacenter, app]

receivers:
- name: 'slack-notifications'
  slack_configs:
  - channel: '#alerts'
    # Template for the text field in Slack messages.
    text: 'https://internal.myorg.net/wiki/alerts/{{ .GroupLabels.app }}/{{ .GroupLabels.alertname }}'

我们通过发送 SIGHUP 来重新加载 Alertmanager，或者重启它来加载更改后的配置。完成。

我们的 Slack 通知现在看起来像这样

模板文件

或者，我们还可以提供一个包含命名模板的文件，然后由 Alertmanager 加载。这对于跨越多行的更复杂的模板尤其有用。

我们创建一个文件 /etc/alertmanager/templates/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'

我们通过发送 SIGHUP 来重新加载 Alertmanager，或者重启它来加载更改后的配置和新的模板文件。完成。

要测试和迭代你的 Prometheus Alertmanager Slack 通知模板，你可以使用以下工具。