Reference
Data
Alert
Name | Kind | Description | Example |
---|---|---|---|
Status |
|
Firing or resolved |
|
Labels |
|
The labels for this alert |
|
Annotations |
|
The annotations for this alert |
|
Values |
|
The values of all expressions, including Classic Conditions |
|
StartsAt |
|
The time the alert fired |
|
EndsAt |
|
|
|
GeneratorURL |
|
A link to Grafana, or the Alertmanager if using an external Alertmanager |
|
SilenceURL |
|
A link to silence the alert |
|
DashboardURL |
|
A link to the Grafana Dashboard if the alert has a Dashboard UID annotation |
|
PanelURL |
|
A link to the panel if the alert has a Panel ID annotation |
|
Fingerprint |
|
A unique string that identifies the alert |
|
ValueString |
|
A string that contains the labels and value of each reduced expression in the alert. |
|
ExtendedData
Name | Kind | Description | Example |
---|---|---|---|
Receiver |
|
The name of the contact point sending the notification |
|
Status |
|
The status is |
|
Alerts |
|
List of all firing and resolved alerts in this notification |
|
Firing alerts |
|
List of all firing alerts in this notification |
|
Resolved alerts |
|
List of all resolved alerts in this notification |
|
GroupLabels |
|
The labels that group these alerts in this |
|
CommonLabels |
|
The labels common to all alerts in this notification |
|
CommonAnnotations |
|
The annotations common to all alerts in this notification |
|
ExternalURL |
|
A link to Grafana, or the Alertmanager that sent this notification if using an external Alertmanager |
|
KV
KV
is a set of key value pairs, where each key and value is a string. If a KV happens to contain numbers or bools then these are string representations of the numeric or boolean value.
Here is an example of a KV, the annotations of an alert:
summary: 'A summary of the alert'
description: 'A description of the alert'
In addition to iterating over each key value pair, you can sort the pairs, remove keys, and iterate over just the keys or the values.
Name | Description | Arguments | Returns | Example |
---|---|---|---|---|
SortedPairs |
Sorts |
|
||
Remove |
Returns a copy of the KV with the keys removed |
[]string |
|
|
Names |
A list of the names |
|
||
Values |
A list of the values |
|
Time
Time is from the Go time
package. You can print a time in a number of different formats. For example, to print the time that an alert fired in the format Monday, 1st January 2022 at 10:00AM
you would write the following template:
{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}
You can find a reference for Go’s time format here.