通知テンプレートの例

以下は、アラートと対応するAlertmanager設定ファイルのセットアップ（alertmanager.yml）のさまざまな例です。それぞれがGoテンプレートシステムを使用しています。

Slack通知のカスタマイズ

この例では、送信された特定のアラートに対処する方法について、組織のWikiへのURLを送信するようにSlack通知をカスタマイズしました。

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のアノテーションへのアクセス

この例では、Alertmanagerから送信されたデータのCommonAnnotationsに格納されているsummaryとdescriptionにアクセスして、Slackレシーバーに送信されるテキストを再びカスタマイズします。

アラート

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'

この例については、このブログ記事で詳しく説明しています。

このドキュメントはオープンソースです。問題の報告やプルリクエストを送信して、改善にご協力ください。