Skip to content

Commit b45d71d

Browse files
committed
docs(observability): show native pagerduty_configs, not just a generic webhook
The committed alertmanager.yml template's only PagerDuty-shaped example was the generic webhook_configs bridge, labeled "PagerDuty bridge, custom handler, etc." Alertmanager has a first-class pagerduty_configs receiver (Events API v2, routing_key_file) that self-hosters should reach for instead -- add it as its own example, matching the existing Slack/Discord/Email sections' style, and narrow the generic webhook's framing to genuinely custom/non-native integrations.
1 parent 29a4ab6 commit b45d71d

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

alertmanager/alertmanager.yml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,23 @@ receivers:
118118
# # auth_username: "alertmanager@example.com"
119119
# # auth_password: "CHANGEME"
120120

121-
# ── Generic webhook (PagerDuty bridge, custom handler, etc.) ──────────────────
122-
# POSTs the Alertmanager JSON payload to any HTTP endpoint.
121+
# ── PagerDuty (native — prefer this over the generic webhook below) ───────────
122+
# Create a PagerDuty Service with an "Events API v2" integration, then use its
123+
# Integration Key here. Keep the key out of git with routing_key_file (mount a file
124+
# at /etc/alertmanager/pagerduty_routing_key), or inline it with routing_key in a
125+
# non-committed deploy copy of this file.
123126
# - name: "oncall-pager"
127+
# pagerduty_configs:
128+
# - routing_key_file: /etc/alertmanager/pagerduty_routing_key
129+
# send_resolved: true
130+
# severity: '{{ .CommonLabels.severity }}'
131+
# description: '{{ .CommonAnnotations.summary }}'
132+
133+
# ── Generic webhook (custom handler, a non-PagerDuty on-call tool, etc.) ──────
134+
# POSTs the Alertmanager JSON payload to any HTTP endpoint. Prefer a native
135+
# integration (slack_configs / discord_configs / pagerduty_configs / …) over this
136+
# when your on-call tool has one — this is the fallback for anything that doesn't.
137+
# - name: "custom-webhook"
124138
# webhook_configs:
125139
# - url: "https://your-endpoint.example.com/alerts"
126140
# send_resolved: true

0 commit comments

Comments
 (0)