Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation Alerting Explore Alerting Labels and annotations Templating labels and annotations

Templating labels and annotations

In Grafana you template labels and annotations just like you would in Prometheus. If you have used Prometheus before then you should be familiar with the $labels and $value variables which contain the labels and value of the alert. You can use the same variables in Grafana, even if the alert does not use a Prometheus datasource. If you haven’t used Prometheus before then don’t worry as each of these variables, and how to template them, will be explained as you follow the rest of this page.

Go’s templating language

Templates for labels and annotations are written in Go’s templating language, text/template.

Opening and closing tags

In text/template, templates start with {{ and end with }} irrespective of whether the template prints a variable or executes control structures such as if statements. This is different from other templating languages such as Jinja where printing a variable uses {{ and }} and control structures use {% and %}.

Print

To print the value of something use {{ and }}. You can print the the result of a function or the value of a variable. For example, to print the $labels variable you would write the following:

Copy

{{ $labels }}

Iterate over labels

To iterate over each label in $labels you can use a range. Here $k refers to the name and $v refers to the value of the current label. For example, if your query returned a label instance=test then $k would be instance and $v would be test.

Copy

{{ range $k, $v := $labels }}
{{ $k }}={{ $v }}
{{ end }}

The labels, value and values variables

The labels variable

The $labels variable contains the labels from the query. For example, a query that checks if an instance is down might return an instance label with the name of the instance that is down. For example, suppose you have an alert rule that fires when one of your instances has been down for more than 5 minutes. You want to add a summary to the alert that tells you which instance is down. With the $labels variable, you can create a summary that prints the instance label in the summary:

Copy

Instance {{ $labels.instance }} has been down for more than 5 minutes

Labels with dots

If the label you want to print contains a dot (full stop or period) in its name using the same dot in the template will not work:

Copy

Instance {{ $labels.instance.name }} has been down for more than 5 minutes

This is because the template is attempting to use a non-existing field called name in $labels.instance. You should instead use the index function, which prints the label instance.name in the $labels variable:

Copy

Instance {{ index $labels "instance.name" }} has been down for more than 5 minutes

The value variable

The $value variable works different from Prometheus. In Prometheus $value is a floating point number containing the value of the expression, but in Grafana it is a string containing the labels and values of all Threshold, Reduce and Math expressions, and Classic Conditions for this alert rule. It does not contain the results of queries, as these can return anywhere from 10s to 10,000s of rows or metrics.

If you were to use the $value variable in the summary of an alert:

Copy

{{ $labels.service }} has over 5% of responses with 5xx errors: {{ $value }})

The summary might look something like the following:

Copy

api has an over 5% of responses with 5xx errors: [ var='B' labels={service=api} value=6.789 ]

Here var='B' refers to the expression with the RefID B. In Grafana, all queries and expressions are identified by a RefID that identifies each query and expression in an alert rule. Similarly labels={service=api} refers to the labels, and value=6.789 refers to the value.

You might have observed that there is no RefID A. That is because in most alert rules the RefID A refers to a query, and since queries can return many rows or time series they are not included in $value.

The values variable

If the $value variable contains more information than you need, you can instead print the labels and value of individual expressions using $values. Unlike $value, the $values variable is a table of objects containing the labels and floating point values of each expression, indexed by their RefID.

If you were to print the value of the expression with RefID B in the summary of the alert:

Copy

{{ $labels.service }} has over 5% of responses with 5xx errors: {{ $values.B }}%

The summary will contain just the value:

Copy

api has an over 5% of responses with 5xx errors: 6.789%

However, while {{ $values.B }} prints the number 6.789, it is actually a string as you are printing the object that contains both the labels and value for RefID B, not the floating point value of B. To use the floating point value of RefID B you must use the Value field from $values.B. If you were to humanize the floating point value in the summary of an alert:

Copy

{{ $labels.service }} has over 5% of responses with 5xx errors: {{ humanize $values.B.Value }}%

No data, execution errors and timeouts

If the query in your alert rule returns no data, or fails because of a datasource error or timeout, then any Threshold, Reduce or Math expressions that use that query will also return no data or an error. When this happens these expression will be absent from $values. It is good practice to check that a RefID is present before using it as otherwise your template will break should your query return no data or an error. You can do this using an if statement:

Copy

{{ if $values.B }}{{ $labels.service }} has over 5% of responses with 5xx errors: {{ humanizePercentage $values.B.Value }}{{ end }}

Classic Conditions

If the rule uses Classic Conditions instead of Threshold, Reduce and Math expressions, then the $values variable is indexed by both the Ref ID and position of the condition in the Classic Condition. For example, if you have a Classic Condition with RefID B containing two conditions, then $values will contain two conditions B0 and B1.

Copy

The first condition is {{ $values.B0 }}, and the second condition is {{ $values.B1 }}

Functions

The following functions are also available when expanding labels and annotations:

args

The args function translates a list of objects to a map with keys arg0, arg1 etc. This is intended to allow multiple arguments to be passed to templates.

Example

Copy

{{define "x"}}{{.arg0}} {{.arg1}}{{end}}{{template "x" (args 1 "2")}}

Copy

1 2

externalURL

The externalURL function returns the external URL of the Grafana server as configured in the ini file(s).

Example

Copy

{{ externalURL }}

Copy

https://example.com/grafana

graphLink

The graphLink function returns the path to the graphical view in Explore for the given expression and data source.

Example

Copy

{{ graphLink "{\"expr\": \"up\", \"datasource\": \"gdev-prometheus\"}" }}

Copy

/explore?left=["now-1h","now","gdev-prometheus",{"datasource":"gdev-prometheus","expr":"up","instant":false,"range":true}]

humanize

The humanize function humanizes decimal numbers.

Example

Copy

{{ humanize 1000.0 }}

Copy

1k

humanize1024

The humanize1024 works similar to humanize but but uses 1024 as the base rather than 1000.

Example

Copy

{{ humanize1024 1024.0 }}

Copy

1ki

humanizeDuration

The humanizeDuration function humanizes a duration in seconds.

Example

Copy

{{ humanizeDuration 60.0 }}

Copy

1m 0s

humanizePercentage

The humanizePercentage function humanizes a ratio value to a percentage.

Example

Copy

{{ humanizePercentage 0.2 }}

Copy

20%

humanizeTimestamp

The humanizeTimestamp function humanizes a Unix timestamp.

Example

Copy

{{ humanizeTimestamp 1577836800.0 }}

Copy

2020-01-01 00:00:00 +0000 UTC

match

The match function matches the text against a regular expression pattern.

Example

Copy

{{ match "a.*" "abc" }}

Copy

true

pathPrefix

The pathPrefix function returns the path of the Grafana server as configured in the ini file(s).

Example

Copy

{{ pathPrefix }}

Copy

/grafana

tableLink

The tableLink function returns the path to the tabular view in Explore for the given expression and data source.

Example

Copy

{{ tableLink "{\"expr\": \"up\", \"datasource\": \"gdev-prometheus\"}" }}

Copy

/explore?left=["now-1h","now","gdev-prometheus",{"datasource":"gdev-prometheus","expr":"up","instant":true,"range":false}]

title

The title function capitalizes the first character of each word.

Example

Copy

{{ title "hello, world!" }}

Copy

Hello, World!

toLower

The toLower function returns all text in lowercase.

Example

Copy

{{ toLower "Hello, world!" }}

Copy

hello, world!

toUpper

The toUpper function returns all text in uppercase.

Example

Copy

{{ toUpper "Hello, world!" }}

Copy

HELLO, WORLD!

reReplaceAll

The reReplaceAll function replaces text matching the regular expression.

Example

Copy

{{ reReplaceAll "localhost:(.*)" "example.com:$1" "localhost:8080" }}

Copy

example.com:8080