Jack Baldry
3c68684dd2
* Use relative aliases for all non-current Grafana aliases Prevents non-latest documentation "stealing" the page away from latest and through permanent redirects for latest pages that no longer exist. The redirected pages are indexed by search engines but our robots.txt forbids them crawling the non-latest page. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove all current page aliases find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/latest/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \; Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
68 lines
1.4 KiB
Markdown
68 lines
1.4 KiB
Markdown
---
|
|
aliases:
|
|
- ../../message-templating/
|
|
- ../../unified-alerting/message-templating/
|
|
- ./
|
|
keywords:
|
|
- grafana
|
|
- alerting
|
|
- guide
|
|
- contact point
|
|
- templating
|
|
title: Example message template
|
|
weight: 115
|
|
---
|
|
|
|
# Example of a custom template
|
|
|
|
Here's an example of how to use a custom template. You can also use the default template included in the setup.
|
|
|
|
Step 1: Configure a template to render a single alert.
|
|
|
|
```
|
|
{{ define "myalert" }}
|
|
[{{.Status}}] {{ .Labels.alertname }}
|
|
|
|
Labels:
|
|
{{ range .Labels.SortedPairs }}
|
|
{{ .Name }}: {{ .Value }}
|
|
{{ end }}
|
|
|
|
{{ if gt (len .Annotations) 0 }}
|
|
Annotations:
|
|
{{ range .Annotations.SortedPairs }}
|
|
{{ .Name }}: {{ .Value }}
|
|
{{ end }}
|
|
{{ end }}
|
|
|
|
{{ if gt (len .SilenceURL ) 0 }}
|
|
Silence alert: {{ .SilenceURL }}
|
|
{{ end }}
|
|
{{ if gt (len .DashboardURL ) 0 }}
|
|
Go to dashboard: {{ .DashboardURL }}
|
|
{{ end }}
|
|
{{ end }}
|
|
```
|
|
|
|
Step 2: Configure a template to render entire notification message.
|
|
|
|
```
|
|
{{ define "mymessage" }}
|
|
{{ if gt (len .Alerts.Firing) 0 }}
|
|
{{ len .Alerts.Firing }} firing:
|
|
{{ range .Alerts.Firing }} {{ template "myalert" .}} {{ end }}
|
|
{{ end }}
|
|
{{ if gt (len .Alerts.Resolved) 0 }}
|
|
{{ len .Alerts.Resolved }} resolved:
|
|
{{ range .Alerts.Resolved }} {{ template "myalert" .}} {{ end }}
|
|
{{ end }}
|
|
{{ end }}
|
|
```
|
|
|
|
Step 3: Add `mymessage` in the notification message field.
|
|
|
|
```
|
|
Alert summary:
|
|
{{ template "mymessage" . }}
|
|
```
|