Referencia de la plantilla

Este tema de documentación está diseñado para los espacios de trabajo de Grafana que admiten la versión 9.x de Grafana.

Para ver los espacios de trabajo de Grafana que admiten la versión 10.x de Grafana, consulte. Trabajando en Grafana versión 10

Para ver los espacios de trabajo de Grafana que admiten la versión 8.x de Grafana, consulte. Trabajando en Grafana versión 8

En esta sección se proporciona información de referencia para crear sus plantillas.

Datos de la plantilla

Los siguientes datos se transfieren a las plantillas de mensajes.

Nombre	Tipo	Notas
Receiver	cadena	Nombre del punto de contacto al que se envía la notificación.
Status	cadena	se activa si se está activando al menos una alerta; de lo contrario, se resuelve.
Alerts	Alerta	Lista de los objetos de alerta que se incluyen en esta notificación (véase más abajo).
GroupLabels	KeyValue	Etiquetas por las que se agruparon estas alertas.
CommonLabels	KeyValue	Etiquetas comunes a todas las alertas incluidas en esta notificación.
CommonAnnotations	KeyValue	Anotaciones comunes a todas las alertas incluidas en esta notificación.
ExternalURL	cadena	Enlace de vuelta a la Grafana que envió la notificación. Si utilizas un Alertmanager externo, enlaza de nuevo a este Alertmanager.

El Alerts tipo presenta dos funciones para filtrar las alertas devueltas.

• Alerts.Firing— Devuelve una lista de alertas de activación.

• Alerts.Resolved— Devuelve una lista de alertas resueltas.

Alerta (tipo)

El tipo de alerta contiene los siguientes datos.

Nombre	Tipo	Notas
Status	cadena	firing o bien resolved.
Etiquetas	KeyValue	Un conjunto de etiquetas adjuntas a la alerta.
Annotations	KeyValue	Un conjunto de anotaciones adjuntas a la alerta.
Valores	KeyValue	Los valores de todas las expresiones, incluidas las condiciones clásicas
StartsAt	Hora. Hora	Hora en que la alerta empezó a activarse.
EndsAt	Hora. Hora	Se establece solo si se conoce la hora de finalización de una alerta. De lo contrario, configúrelo en un período de tiempo de espera configurable a partir del momento en que se recibió la última alerta.
URL del generador	cadena	Un enlace posterior a Grafana o a un Alertmanager externo.
URL de silencio	cadena	Un enlace para silenciar la alerta (con las etiquetas de esta alerta rellenadas previamente). Solo para alertas gestionadas por Grafana.
URL del panel	cadena	Enlace al panel de grafana, si la regla de alerta pertenece a uno. Solo para alertas gestionadas por Grafana.
URL del panel	cadena	Enlace al panel del panel de control de grafana, si la regla de alerta pertenece a uno. Solo para alertas gestionadas por Grafana.
Huella digital	cadena	Huella digital que se puede utilizar para identificar la alerta.
ValueString	cadena	Cadena que contiene las etiquetas y el valor de cada expresión reducida de la alerta.

ExtendedData

El ExtendedData objeto contiene las siguientes propiedades.

Nombre	Tipo	Descripción	Ejemplo
Receptor	string	El nombre del punto de contacto que envía la notificación.	{{ .Receiver }}
Status	string	El estado es firing if at least one alert is firing, otherwise resolved.	{{ .Status }}
Alertas	[]Alert	Lista de todas las alertas de activación y resueltas de esta notificación.	There are {{ len .Alerts }} alerts
Alertas de disparo	[]Alert	Lista de todas las alertas de disparo de esta notificación.	There are {{ len .Alerts.Firing }} firing alerts
Alertas resueltas	[]Alert	Lista de todas las alertas resueltas de esta notificación.	There are {{ len .Alerts.Resolved }} resolved alerts
GroupLabels	KeyValue	Las etiquetas que agrupan estas alertas en esta notificación.	{{ .GroupLabels }}
CommonLabels	KeyValue	Las etiquetas comunes a todas las alertas de esta notificación.	{{ .CommonLabels }}
CommonAnnotations	KeyValue	Las anotaciones comunes a todas las alertas de esta notificación.	{{ .CommonAnnotations }}
URL externa	string	Un enlace al espacio de trabajo de Grafana o al administrador de alertas que envió esta notificación.	{{ .ExternalURL }}

KeyValue escriba

El KeyValue tipo es un conjunto de pares de cadenas clave/valor que representan etiquetas y anotaciones.

Además del acceso directo a los datos almacenados como unKeyValue, también hay métodos para ordenar, eliminar y transformar los datos.

Nombre	Argumentos	Devuelve	Notas	Ejemplo
SortedPairs		Lista ordenada de pares de cadenas de valores y claves		{{ .Annotations.SortedPairs }}
Remove	[] cadena	KeyValue	Devuelve una copia del mapa clave/valor sin las claves dadas.	{{ .Annotations.Remove "summary" }}
Nombres		[] cadena	Lista de nombres de etiquetas	{{ .Names }}
Valores		[] cadena	Lista de valores de etiquetas	{{ .Values }}

Tiempo

El tiempo proviene del timepaquete Go. Puede imprimir una hora en varios formatos diferentes. Por ejemplo, para imprimir la hora a la que se disparó una alerta en ese formatoMonday, 1st January 2022 at 10:00AM, escriba la siguiente plantilla:

{{ .StartsAt.Format "Monday, 2 January 2006 at 3:04PM" }}

Puedes encontrar una referencia del formato de hora de Go aquí.

Funciones de plantilla

Con las funciones de plantilla, puede procesar etiquetas y anotaciones para generar notificaciones dinámicas. Están disponibles las siguientes funciones.

Nombre	Tipo de argumento	Tipo de retorno	Descripción
humanize	número o cadena	cadena	Convierte un número a un formato más legible mediante prefijos métricos.
humanize1024	número o cadena	cadena	Como humanize, pero usa 1024 como base en lugar de 1000.
humanizeDuration	número o cadena	cadena	Convierte una duración en segundos a un formato más legible.
humanizePercentage	número o cadena	cadena	Convierte un valor de relación en una fracción de 100.
humanizeTimestamp	número o cadena	cadena	Convierte una marca de tiempo de Unix en segundos a un formato más legible.
title	cadena	cadena	Strings.title, pone en mayúscula el primer carácter de cada palabra.
toUpper	cadena	cadena	cadenas. ToUpper, convierte todos los caracteres a mayúsculas.
toLower	cadena	cadena	cadenas. ToLower, convierte todos los caracteres a minúsculas.
match	patrón, texto	Booleano	expresión regular. MatchString Pruebas para detectar una coincidencia de expresiones regulares no anclada.
reReplaceAll	patrón, reemplazo, texto	cadena	Regexp. ReplaceAllString Sustitución de expresiones regulares, sin anclaje.
graphLink	cadena: objeto JSON con campos y expr datasource	cadena	Devuelve la ruta a la vista gráfica en Explore para la expresión y la fuente de datos determinadas.
tableLink	cadena: objeto JSON con datasource campos expr y	cadena	Devuelve la ruta a la vista tabular en Explore para la expresión y la fuente de datos determinadas.
args	[] interfaz {}	mapa [cadena] interfaz {}	Convierte una lista de objetos en un mapa con claves, por ejemplo, arg0, arg1. Utilice esta función para pasar varios argumentos a las plantillas.
externalURL	nada	cadena	Devuelve una cadena que representa la URL externa.
pathPrefix	nada	cadena	Devuelve la ruta de la URL externa.

En la siguiente tabla se muestran ejemplos del uso de cada función.

Función	TemplateString	Entrada	Expected
humanizar	{humanizar $value}	1234567.0	1,235 M
humanizar 1024	{humanize1024 $ value}	1048576.0	1 Mi
Humanizar la duración	{humanizeDuration $value}	899,99	14 m 59 s
Porcentaje de humanización	{HumanizePercentage $ value}	0,134567	12,35%
Humaniza la marca de tiempo	{HumanizeTimeStamp $value}	1435065584.128	2015-06-23 13:19:44 .128 +0000 UTC
title	{$valor | título}	a B C	Aa Bb Cc
toUpper	{$value | ToUpper}	a bB C	A B C
toLower	{$valor | ToLower}	a B C	a b c
match	{coincide con «a+» $labels.instance}	aa	true
reReplaceAll	{{ reReplaceAll «localhost :( .*)» «mi.dominio: $1» $labels.instance}}	host local: 3000	mi.dominio:3000
GraphLink	{{GraphLink «{\" expr\»:\ "up\»,\ "fuente de datos\»:\ "gdev-prometheus\"}»}		/explorar? left= ["now-1h», "ahora», "gdev-prometheus», {"datasource» :"gdev-prometheus», "expr» :"up», "instant» :false, "range» :true}]
Enlace de tabla	{{TableLink «{\" expr\»:\ "up\»,\ "fuente de datos\»:\ "gdev-prometheus\"}»}		/explorar? left= ["now-1h», "ahora», "gdev-prometheus», {"datasource» :"gdev-prometheus», "expr» :"up», "instant» :true, "range» :false}]
args	{{define «x"} {{.arg0}} {{.arg1}} {{end}} {{template «x» (argumentos 1 «2")}}		1 2
URL externa	{ExternalUrl}		http://localhost/path/prefix
Prefijo de ruta	{pathPrefix}		/ruta/prefijo