Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Alertmanager notification template #1764

Merged
merged 3 commits into from
Dec 17, 2024
Merged

Update Alertmanager notification template #1764

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
204cdf9
Update Alertmanager notification template
TheoBrigitte Dec 2, 2024
fef5920
update CHANGELOG
TheoBrigitte Dec 2, 2024
1b2ed8b
update tests
TheoBrigitte Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- Update Alertmanager notification template
- Update alert and query URLs for Mimir to point to the Active notification rather than the rule page
- Move link section (runbook, dashboard, explors) before instance to avoid them being lost due to OpsGenie max description being reached
- Move the warnings for missing runbook and dashboard up into the link section


### Removed

- Get rid of useless `prometheus-agent` after the migration to the new `monitoring-agent` inhibitions.
Expand Down
25 changes: 12 additions & 13 deletions files/templates/alertmanager/notification-template.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{{ define "__alerturl" }}
[[- if .MimirEnabled -]]
[[ .GrafanaAddress ]]/alerting/Mimir/{{ .CommonLabels.alertname }}/find
[[ .GrafanaAddress ]]/alerting/groups?queryString=alertname%3D%22{{ .CommonLabels.alertname}}%22&alertmanager=Alertmanager
[[- else -]]
{{ .ExternalURL }}/#/alerts?receiver={{ .Receiver }}&silenced=false&inhibited=false&active=true&filter=%7Balertname%3D%22{{ .CommonLabels.alertname }}%22%7D
[[- end -]]
Expand All @@ -13,7 +13,7 @@

{{ define "__queryurl" }}
[[- if .MimirEnabled -]]
[[ .GrafanaAddress ]]/alerting/Mimir/{{ .CommonLabels.alertname }}/find
[[ .GrafanaAddress ]]/alerting/groups?queryString=alertname%3D%22{{ .CommonLabels.alertname}}%22&alertmanager=Alertmanager
[[- else -]]
{{ (index .Alerts 0).GeneratorURL }}
[[- end -]]
Expand Down Expand Up @@ -42,19 +42,16 @@

{{ define "opsgenie.default.message" }}{{ .GroupLabels.installation }} / {{ .GroupLabels.cluster_id }}{{ if (index .Alerts 0).Labels.service }} / {{ (index .Alerts 0).Labels.service }}{{ end }} - {{ index (index .Alerts.Firing 0).Labels `alertname`}}{{ end }}
{{ define "opsgenie.default.source" }}{{ template "__alertmanager" . }}{{ end }}
{{ define "opsgenie.default.description" }}* Team: {{ (index .Alerts 0).Labels.team }}
* Area: {{ (index .Alerts 0).Labels.area }} / {{ (index .Alerts 0).Labels.topic }}

* Instances:{{ range .Alerts.Firing }}
🔥 {{ if .Labels.instance }}{{ .Labels.instance }}: {{ end }}{{ .Annotations.description }}{{ end }}

---

{{ define "opsgenie.default.description" }}
{{ if (index .Alerts 0).Annotations.opsrecipe -}}
📗 Runbook: {{ template "__runbookurl" . }}
{{ end -}}
{{ else -}}
📗 Runbook: ⚠️ There is no **runbook** for this alert, time to get your pen.
{{- end }}
{{ if (index .Alerts 0).Annotations.dashboard -}}
📈 Dashboard: {{ template "__dashboardurl" . }}
{{ else -}}
📈 Dashboard: ⚠️ There is no **dashboard** for this alert, time to sketch.
{{ end -}}
[[- if .MimirEnabled ]]
👀 Explore: {{ template "__queryurl" . }}
Expand All @@ -65,8 +62,10 @@

---

{{ if not (index .Alerts 0).Annotations.opsrecipe }}⚠️ There is no **runbook** for this alert, time to get your pen.{{- end }}
{{ if not (index .Alerts 0).Annotations.dashboard }}⚠️ There is no **dashboard** for this alert, time to sketch.{{- end }}
* Team: {{ (index .Alerts 0).Labels.team }}
* Area: {{ (index .Alerts 0).Labels.area }} / {{ (index .Alerts 0).Labels.topic }}
* Instances:{{ range .Alerts.Firing }}
🔥 {{ if .Labels.instance }}{{ .Labels.instance }}: {{ end }}{{ .Annotations.description }}{{ end }}
{{- end }}

# This builds the silence URL. We exclude the alertname in the range
Expand Down