IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Fix numbering in templating docs (#63577)

Browse Source
This commit is contained in:
George Robinson 2023-02-22 17:36:00 +00:00 committed by GitHub
parent e013366db3
commit 18fec707fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 96 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
docs/sources/alerting/manage-notifications/template-notifications/create-notification-templates.md
View File

@ -30,9 +30,9 @@ To create a template, complete the following steps.
3. Write the content of the template in the content field. 3. Write the content of the template in the content field.
{{< figure max-width="940px" src="/static/img/docs/alerting/unified/new-notification-template-email-subject-9-4.png" caption="New notification template email.subject" >}} {{< figure max-width="940px" src="/static/img/docs/alerting/unified/new-notification-template-email-subject-9-4.png" caption="New notification template email.subject" >}}
5. Click Save. 4. Click Save.
`{{ define "email.subject" }}` and `{{ end }}` is automatically added to the start and end of the content: `{{ define "email.subject" }}` and `{{ end }}` is automatically added to the start and end of the content:
@ -46,9 +46,9 @@ To create a notification template that contains more than one template:
3. Write each template in the Content field, including `{{ define "name-of-template" }}` and `{{ end }}` at the start and end of each template. 3. Write each template in the Content field, including `{{ define "name-of-template" }}` and `{{ end }}` at the start and end of each template.
{{< figure max-width="940px" src="/static/img/docs/alerting/unified/new-notification-template-email-9-4.png" caption="New notification template" >}} {{< figure max-width="940px" src="/static/img/docs/alerting/unified/new-notification-template-email-9-4.png" caption="New notification template" >}}
5. Click Save. 4. Click Save.
## Template the subject of an email ## Template the subject of an email
@ -60,17 +60,17 @@ Template the subject of an email to contain the number of firing and resolved al
1. Create a template called `email.subject` with the following content: 1. Create a template called `email.subject` with the following content:
``` ```
{{ define "email.subject" }} {{ define "email.subject" }}
{{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s) {{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s)
{{ end }} {{ end }}
``` ```
2. Execute the template from the subject field in your contact point integration: 2. Execute the template from the subject field in your contact point integration:
``` ```
{{ template "email.subject" . }} {{ template "email.subject" . }}
``` ```
## Template the message of an email ## Template the message of an email
@ -93,37 +93,37 @@ Resolved alerts:
The `email.message_alert` template is used to print the labels and values for each firing and resolved alert while the `email.message` template contains the structure of the email. The `email.message_alert` template is used to print the labels and values for each firing and resolved alert while the `email.message` template contains the structure of the email.
``` ```
{{- define "email.message_alert" -}} {{- define "email.message_alert" -}}
{{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s) {{- range .Labels.SortedPairs }}{{ .Name }}={{ .Value }} {{ end }} has value(s)
{{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }} {{- range $k, $v := .Values }} {{ $k }}={{ $v }}{{ end }}
{{- end -}} {{- end -}}
{{ define "email.message" }} {{ define "email.message" }}
There are {{ len .Alerts.Firing }} firing alert(s), and {{ len .Alerts.Resolved }} resolved alert(s) There are {{ len .Alerts.Firing }} firing alert(s), and {{ len .Alerts.Resolved }} resolved alert(s)
{{ if .Alerts.Firing -}} {{ if .Alerts.Firing -}}
Firing alerts: Firing alerts:
{{- range .Alerts.Firing }} {{- range .Alerts.Firing }}
- {{ template "email.message_alert" . }} - {{ template "email.message_alert" . }}
{{- end }} {{- end }}
{{- end }} {{- end }}
{{ if .Alerts.Resolved -}} {{ if .Alerts.Resolved -}}
Resolved alerts: Resolved alerts:
{{- range .Alerts.Resolved }} {{- range .Alerts.Resolved }}
- {{ template "email.message_alert" . }} - {{ template "email.message_alert" . }}
{{- end }} {{- end }}
{{- end }} {{- end }}
{{ end }} {{ end }}
``` ```
2. Execute the template from the message field in your contact point integration: 2. Execute the template from the message field in your contact point integration:
``` ```
{{ template "email.message" . }} {{ template "email.message" . }}
``` ```
## Template the title of a Slack message ## Template the title of a Slack message
@ -135,17 +135,17 @@ Template the title of a Slack message to contain the number of firing and resolv
1. Create a template called `slack.title` with the following content: 1. Create a template called `slack.title` with the following content:
``` ```
{{ define "slack.title" }} {{ define "slack.title" }}
{{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s) {{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s)
{{ end }} {{ end }}
``` ```
2. Execute the template from the title field in your contact point integration: 2. Execute the template from the title field in your contact point integration:
``` ```
{{ template "slack.title" . }} {{ template "slack.title" . }}
``` ```
## Template the content of a Slack message ## Template the content of a Slack message
@ -179,48 +179,48 @@ Go to dashboard: https://example.com/d/dlhdLqF4z?orgId=1
The `slack.print_alert` template is used to print the labels, annotations, SilenceURL and DashboardURL while the `slack.message` template contains the structure of the notification. The `slack.print_alert` template is used to print the labels, annotations, SilenceURL and DashboardURL while the `slack.message` template contains the structure of the notification.
``` ```
{{ define "slack.print_alert" -}} {{ define "slack.print_alert" -}}
[{{.Status}}] {{ .Labels.alertname }} [{{.Status}}] {{ .Labels.alertname }}
Labels: Labels:
{{ range .Labels.SortedPairs -}} {{ range .Labels.SortedPairs -}}
- {{ .Name }}: {{ .Value }} - {{ .Name }}: {{ .Value }}
{{ end -}} {{ end -}}
{{ if .Annotations -}} {{ if .Annotations -}}
Annotations: Annotations:
{{ range .Annotations.SortedPairs -}} {{ range .Annotations.SortedPairs -}}
- {{ .Name }}: {{ .Value }} - {{ .Name }}: {{ .Value }}
{{ end -}} {{ end -}}
{{ end -}} {{ end -}}
{{ if .SilenceURL -}} {{ if .SilenceURL -}}
Silence: {{ .SilenceURL }} Silence: {{ .SilenceURL }}
{{ end -}} {{ end -}}
{{ if .DashboardURL -}} {{ if .DashboardURL -}}
Go to dashboard: {{ .DashboardURL }} Go to dashboard: {{ .DashboardURL }}
{{- end }} {{- end }}
{{- end }} {{- end }}
{{ define "slack.message" -}} {{ define "slack.message" -}}
{{ if .Alerts.Firing -}} {{ if .Alerts.Firing -}}
{{ len .Alerts.Firing }} firing alert(s): {{ len .Alerts.Firing }} firing alert(s):
{{ range .Alerts.Firing }} {{ range .Alerts.Firing }}
{{ template "slack.print_alert" . }} {{ template "slack.print_alert" . }}
{{ end -}} {{ end -}}
{{ end }} {{ end }}
{{ if .Alerts.Resolved -}} {{ if .Alerts.Resolved -}}
{{ len .Alerts.Resolved }} resolved alert(s): {{ len .Alerts.Resolved }} resolved alert(s):
{{ range .Alerts.Resolved }} {{ range .Alerts.Resolved }}
{{ template "slack.print_alert" .}} {{ template "slack.print_alert" .}}
{{ end -}} {{ end -}}
{{ end }} {{ end }}
{{- end }} {{- end }}
``` ```
2. Execute the template from the text body field in your contact point integration: 2. Execute the template from the text body field in your contact point integration:
``` ```
{{ template "slack.message" . }} {{ template "slack.message" . }}
``` ```
## Template both email and Slack with shared templates ## Template both email and Slack with shared templates
@ -234,20 +234,20 @@ For example, if you want to send an email with this subject and Slack message wi
1. Create a template called `common.subject_title` with the following content: 1. Create a template called `common.subject_title` with the following content:
``` ```
{{ define "common.subject_title" }} {{ define "common.subject_title" }}
{{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s) {{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s)
{{ end }} {{ end }}
``` ```
2. For email, execute the template from the subject field in your email contact point integration: 2. For email, execute the template from the subject field in your email contact point integration:
``` ```
{{ template "common.subject_title" . }} {{ template "common.subject_title" . }}
``` ```
3. For Slack, execute the template from the title field in your Slack contact point integration: 3. For Slack, execute the template from the title field in your Slack contact point integration:
``` ```
{{ template "common.subject_title" . }} {{ template "common.subject_title" . }}
``` ```

6
docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md
View File

@ -22,8 +22,8 @@ In the Contact points tab, you can see a list of your contact points.
2. Execute a template from one or more fields such as Message and Subject: 2. Execute a template from one or more fields such as Message and Subject:
{{< figure max-width="940px" src="/static/img/docs/alerting/unified/use-notification-template-9-4.png" caption="Use notification template" >}} {{< figure max-width="940px" src="/static/img/docs/alerting/unified/use-notification-template-9-4.png" caption="Use notification template" >}}
For more information on how to write and execute templates, refer to [Using Go's templating language]({{< relref "./using-go-templating-language" >}}) and [Create notification templates]({{< relref "./create-notification-templates" >}}). For more information on how to write and execute templates, refer to [Using Go's templating language]({{< relref "./using-go-templating-language" >}}) and [Create notification templates]({{< relref "./create-notification-templates" >}}).
4. Click Save template. 3. Click Save template.