Skip to content

Commit bf1c8b8

Browse files
authored
Merge pull request #7124 from JSONbored/docs/enrich-pagerduty-example-template
docs(observability): show enriched PagerDuty context fields in the template
2 parents 5e7f077 + dde8db4 commit bf1c8b8

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

alertmanager/alertmanager.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,28 @@ receivers:
123123
# Integration Key here. Keep the key out of git with routing_key_file (mount a file
124124
# at /etc/alertmanager/pagerduty_routing_key), or inline it with routing_key in a
125125
# non-committed deploy copy of this file.
126+
#
127+
# client/group/class + details give the incident real context beyond the bare
128+
# summary (which deployment paged, which alert rule, the runbook/description your
129+
# own alert rules already annotate, how many instances are firing) -- so triage
130+
# doesn't require opening Grafana first. Not setting a PagerDuty "Priority" (P1-P5)
131+
# here -- that's not a pagerduty_config field; it's PagerDuty's own Event
132+
# Orchestration feature, configured on their side, not Alertmanager's.
126133
# - name: "oncall-pager"
127134
# pagerduty_configs:
128135
# - routing_key_file: /etc/alertmanager/pagerduty_routing_key
129136
# send_resolved: true
130137
# severity: '{{ .CommonLabels.severity }}'
131138
# description: '{{ .CommonAnnotations.summary }}'
139+
# client: "loopover Alertmanager"
140+
# group: "loopover-selfhost"
141+
# class: '{{ .CommonLabels.alertname }}'
142+
# details:
143+
# summary: '{{ .CommonAnnotations.summary }}'
144+
# description: '{{ .CommonAnnotations.description }}'
145+
# runbook: '{{ .CommonAnnotations.runbook }}'
146+
# num_firing: '{{ .Alerts.Firing | len }}'
147+
# firing_instances: '{{ range .Alerts.Firing }}{{ .Labels.instance }} {{ end }}'
132148

133149
# ── Generic webhook (custom handler, a non-PagerDuty on-call tool, etc.) ──────
134150
# POSTs the Alertmanager JSON payload to any HTTP endpoint. Prefer a native

0 commit comments

Comments
 (0)