Referência do modelo

Este tópico de documentação foi desenvolvido para espaços de trabalho do Grafana que oferecem suporte ao Grafana versão 9.x.

Para espaços de trabalho do Grafana que suportam a versão 10.x do Grafana, consulte. Trabalhando na versão 10 do Grafana

Para espaços de trabalho do Grafana que suportam a versão 8.x do Grafana, consulte. Trabalhando na versão 8 da Grafana

Esta seção fornece informações de referência para criar seus modelos.

Dados do modelo

Os dados a seguir são passados para os modelos de mensagem.

Nome	Tipo	Observações
Receiver	string	Nome do ponto de contato para o qual a notificação está sendo enviada.
Status	string	disparando se pelo menos um alerta estiver sendo disparado, caso contrário, resolvido.
Alerts	Alerta	Lista de objetos de alerta incluídos nessa notificação (veja abaixo).
GroupLabels	KeyValue	Rótulos pelos quais esses alertas foram agrupados.
CommonLabels	KeyValue	Rótulos comuns a todos os alertas incluídos nessa notificação.
CommonAnnotations	KeyValue	Anotações comuns a todos os alertas incluídos nessa notificação.
ExternalURL	string	Link de retorno para a Grafana que enviou a notificação. Se estiver usando o Alertmanager externo, volte para esse Alertmanager.

O Alerts tipo expõe duas funções para filtrar os alertas retornados.

• Alerts.Firing— Retorna uma lista de alertas de disparo.

• Alerts.Resolved— Retorna uma lista de alertas resolvidos.

Alerta (tipo)

O tipo de alerta contém os seguintes dados.

Nome	Tipo	Observações
Status	string	firing ou resolved.
Rótulos	KeyValue	Um conjunto de etiquetas anexadas ao alerta.
Anotações	KeyValue	Um conjunto de anotações anexado ao alerta.
Valores	KeyValue	Os valores de todas as expressões, incluindo condições clássicas
StartsAt	Hora. Hora	Hora em que o alerta começou a disparar.
EndsAt	Hora. Hora	Definido somente se a hora de término de um alerta for conhecida. Caso contrário, defina um período de tempo limite configurável a partir do momento em que o último alerta foi recebido.
URL do gerador	string	Um link de retorno para o Grafana ou para o Alertmanager externo.
URL de silêncio	string	Um link para silenciar o alerta (com rótulos para esse alerta pré-preenchidos). Somente para alertas gerenciados pela Grafana.
URL do painel	string	Link para o painel do grafana, se a regra de alerta pertencer a uma. Somente para alertas gerenciados pela Grafana.
URL do painel	string	Link para o painel do painel do grafana, se a regra de alerta pertencer a uma. Somente para alertas gerenciados pela Grafana.
Impressão digital	string	Impressão digital que pode ser usada para identificar o alerta.
ValueString	string	Uma string que contém os rótulos e o valor de cada expressão reduzida no alerta.

ExtendedData

O ExtendedData objeto contém as seguintes propriedades.

Nome	Kind	Descrição	Exemplo
Receptor	string	O nome do ponto de contato que está enviando a notificação.	{{ .Receiver }}
Status	string	O status é firing if at least one alert is firing, otherwise resolved.	{{ .Status }}
Alertas	[]Alert	Lista de todos os alertas acionados e resolvidos nesta notificação.	There are {{ len .Alerts }} alerts
Alertas de disparo	[]Alert	Lista de todos os alertas de disparo nesta notificação.	There are {{ len .Alerts.Firing }} firing alerts
Alertas resolvidos	[]Alert	Lista de todos os alertas resolvidos nessa notificação.	There are {{ len .Alerts.Resolved }} resolved alerts
GroupLabels	KeyValue	Os rótulos que agrupam esses alertas nessa notificação.	{{ .GroupLabels }}
CommonLabels	KeyValue	Os rótulos comuns a todos os alertas nesta notificação.	{{ .CommonLabels }}
CommonAnnotations	KeyValue	As anotações comuns a todos os alertas nessa notificação.	{{ .CommonAnnotations }}
URL externo	string	Um link para o espaço de trabalho da Grafana ou para o Alertmanager que enviou essa notificação.	{{ .ExternalURL }}

KeyValue tipo

O KeyValue tipo é um conjunto de pares de cadeias de chave/valor que representam rótulos e anotações.

Além do acesso direto aos dados armazenados como umKeyValue, também existem métodos para classificar, remover e transformar os dados.

Nome	Argumentos	Retornos	Observações	Exemplo
SortedPairs		Lista ordenada de pares de cadeias de chaves e valores		{{ .Annotations.SortedPairs }}
Remover	[] string	KeyValue	Retorna uma cópia do mapa Chave/Valor sem as chaves fornecidas.	{{ .Annotations.Remove "summary" }}
Nomes		[] string	Lista de nomes de rótulos	{{ .Names }}
Valores		[] string	Lista de valores de rótulos	{{ .Values }}

Tempo

O tempo vem do timepacote Go. Você pode imprimir uma hora em vários formatos diferentes. Por exemplo, para imprimir a hora em que um alerta foi acionado no formatoMonday, 1st January 2022 at 10:00AM, você escreve o seguinte modelo:

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

Você pode encontrar uma referência para o formato de hora do Go aqui.

Funções de modelo

Usando funções de modelo, você pode processar rótulos e anotações para gerar notificações dinâmicas. As seguintes funções estão disponíveis.

Nome	Tipo de argumento	Tipo de retorno	Descrição
humanize	número ou string	string	Converte um número em um formato mais legível, usando prefixos métricos.
humanize1024	número ou string	string	Gosta de humanizar, mas usa 1024 como base em vez de 1000.
humanizeDuration	número ou string	string	Converte uma duração em segundos em um formato mais legível.
humanizePercentage	número ou string	string	Converte um valor de proporção em uma fração de 100.
humanizeTimestamp	número ou string	string	Converte um timestamp Unix em segundos em um formato mais legível.
title	string	string	strings.title, coloca em maiúscula o primeiro caractere de cada palavra.
toUpper	string	string	cordas. ToUpper, converte todos os caracteres em maiúsculas.
toLower	string	string	cordas. ToLower, converte todos os caracteres em minúsculas.
match	padrão, texto	Booleano	regexp. MatchString Testes para uma correspondência de expressão regular não ancorada.
reReplaceAll	padrão, substituição, texto	string	Regexp. ReplaceAllString Substituição Regexp, não ancorada.
graphLink	string - Objeto JSON com campos expr e datasource	string	Retorna o caminho para a exibição gráfica no Explore para a expressão e a fonte de dados fornecidas.
tableLink	string - Objeto JSON com campos expr e datasource	string	Retorna o caminho para a exibição tabular no Explore para a expressão e a fonte de dados fornecidas.
args	[] interface {}	interface de mapa [string] {}	Converte uma lista de objetos em um mapa com chaves, por exemplo, arg0, arg1. Use essa função para passar vários argumentos para modelos.
externalURL	nada	string	Retorna uma string representando o URL externo.
pathPrefix	nada	string	Retorna o caminho do URL externo.

A tabela a seguir mostra exemplos do uso de cada função.

Função	TemplateString	Entrada	Esperados
humanizar	{humanize $value}	1234567,0	1.235M
humanizar 1024	{humanize1024 $value}	1048576,0	1 mi
Humanize a duração	{humanizeDuration $value}	899,99	14m 59s
Porcentagem de humanização	{HumanizePercentage $ value}	0,1234567	12,35%
Humanize o carimbo de data/hora	{humanizeTimestamp $value}	1435065584.128	23/06/2015 13:19:44.128 +0000 UTC
title	{$value | título}	um B C	Aa Bb Cc
toUpper	{$value | toUpper}	um B C	A BB CC
toLower	{$value | toLower}	um B C	a bb cc
jogo	{match “a+” $labels.instance}	aa	verdadeiro
reReplaceAll	{{ reReplaceAll “localhost :( .*)” “meu.domínio: $1" $labels.instance}}	host local: 3000	meu.domínio:3000
GraphLink	{{GraphLink “{\" expr\”:\ "up\”,\ "fonte de dados\”:\ "gdev-prometheus\"}”}}		/explorar? left= ["now-1h”, "now”, "gdev-prometheus”, {"datasource” :"gdev-prometheus”, "expr” :"up”, "instant” :false, "range” :true}]
Link da tabela	{{TableLink “{\" expr\”:\ "up\”,\ "fonte de dados\”:\ "gdev-prometheus\"}”}}		/explorar? left= ["now-1h”, "now”, "gdev-prometheus”, {"datasource” :"gdev-prometheus”, "expr” :"up”, "instant” :true, "range” :false}]
args	{{define “x"}} {{.arg0}} {{.arg1}} {{end}} {{template “x” (args 1 “2")}}}		1 2
URL externo	{URL externo}		http://localhost/path/prefix
Prefixo do caminho	{PathPrefix}		/caminho/prefixo