Adicionar e gerenciar variáveis

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

A tabela a seguir lista os tipos de variáveis no Grafana.

Inserir opções gerais

Você deve inserir opções gerais para qualquer tipo de variável que você criar.

Adicionar uma variável de consulta.

As variáveis de consulta permitem que você escreva uma consulta de fonte de dados que pode retornar uma lista de nomes de métricas, valores de tags ou chaves. Por exemplo, uma variável de consulta pode retornar uma lista de nomes de servidores IDs, sensores ou data centers. Os valores das variáveis mudam à medida que elas buscam opções dinamicamente com uma consulta à fonte de dados.

Geralmente, as variáveis de consulta são compatíveis apenas com strings. Se sua consulta retornar números ou qualquer outro tipo de dados, talvez seja necessário convertê-los em strings para usá-los como variáveis. Para a fonte de dados Azure, por exemplo, você pode usar a função tostring para essa finalidade.

As expressões de consulta podem conter referências a outras variáveis e, na verdade, criar variáveis vinculadas. O Grafana detecta isso e atualiza automaticamente uma variável quando uma de suas variáveis vinculadas é alterada.

Adicionar uma variável personalizada

Use uma variável personalizada para um valor que não muda, como um número ou uma string.

Por exemplo, se você tiver nomes de servidores ou nomes de regiões que nunca mudam, talvez queira criá-los como variáveis personalizadas em vez de variáveis de consulta. Como elas não mudam, você pode usá-las em variáveis encadeadas em vez de outras variáveis de consulta. Isso reduziria o número de consultas que o Grafana deve enviar quando as variáveis encadeadas são atualizadas.

Adicionar uma variável de caixa de texto

As variáveis da caixa de texto exibem um campo de entrada de texto livre com um valor padrão opcional. Esta é a variável mais flexível, pois você pode inserir qualquer valor. Use esse tipo de variável se você tiver métricas com alta cardinalidade ou se quiser atualizar vários painéis em um dashboard ao mesmo tempo.

Adicionar uma variável constante

Variáveis constantes permitem que você defina uma constante oculta. Isso é útil para prefixos de caminhos de métricas para dashboards que você deseja compartilhar. Quando você exporta um dashboard, as variáveis constantes são convertidas em opções de importação.

Variáveis constantes não são flexíveis. Cada variável constante contém apenas um valor e não pode ser atualizada a menos que você atualize as configurações da variável.

Variáveis constantes são úteis quando você tem valores complexos que precisa incluir nas consultas, mas não quer digitar novamente em todas as consultas. Por exemplo, se você tivesse um caminho de servidor chamado i-0b6a61efe2ab843gg, você poderia substituí-lo por uma variável chamada $path_gg.

Adicionar uma variável de fonte de dados

As variáveis da fonte de dados permitem que você altere rapidamente a fonte de dados de todo um dashboard. Elas serão úteis se você tiver várias instâncias de uma fonte de dados, talvez em ambientes diferentes.

Adicionar uma variável de intervalo

Use uma variável de intervalo para representar períodos de tempo como 1m,1h ou 1d. Você pode pensar neles como um comando abrangente do dashboard de agrupar por hora. As variáveis de intervalo mudam a forma como os dados são agrupados na visualização. Você também pode usar a opção Automático para retornar um número definido de pontos de dados por período de tempo.

Você pode usar uma variável de intervalo como parâmetro para agrupar por hora (para InfluxDB), intervalo do histograma de datas (para Elasticsearch) ou como um parâmetro de função de resumo (para Graphite).

Exemplos de variáveis de intervalo

O exemplo a seguir mostra uma variável de modelo myinterval em uma função do Graphite:

summarize($myinterval, sum, false)

Adicionar filtros ad hoc

Os filtros ad hoc permitem que você adicione filtros de valor/chave que são adicionados automaticamente a todas as consultas de métricas que usam a fonte de dados especificada. Ao contrário de outras variáveis, você não usa filtros ad hoc nas consultas. Em vez disso, você usa filtros ad hoc para gravar filtros para consultas existentes.

Criar filtros ad hoc

Os filtros ad hoc são uma das opções de variáveis mais complexas e flexíveis disponíveis. Em vez de uma lista regular de opções de variáveis, essa variável permite criar uma consulta ad hoc em todo o dashboard. Os filtros que você aplica dessa maneira são aplicados a todos os painéis no dashboard.

Configurar opções de seleção de variáveis

As opções de seleção são um recurso que você pode usar para gerenciar seleções de opções variáveis. Todas as opções de seleção são opcionais e estão desativadas por padrão.

Variáveis de vários valores

Interpolar uma variável com vários valores selecionados é complicado, pois não é simples formatar os vários valores em uma string válida no contexto em que a variável é usada. O Grafana tenta resolver isso permitindo que cada plug-in de fonte de dados informe ao mecanismo de interpolação de modelos qual formato usar para vários valores.

Variáveis de vários valores com uma fonte de dados Graphite

O Graphite usa expressões globais. Uma variável com vários valores deve, nesse caso, ser interpolada como {host1,host2,host3} se o valor da variável atual fosse host1, host2 e host3.

Variáveis de vários valores com uma fonte de dados Prometheus ou InfluxDB

O InfluxDB e o Prometheus usam expressões regex, então a mesma variável é interpolada como (host1|host2|host3). Todo valor também tem escape regex. Do contrário, um valor com um caractere de controle regex dividiria a expressão regex.

Variáveis de vários valores com uma fonte de dados elástica

O Elasticsearch usa a sintaxe de consulta do Lucene, então a mesma variável é formatada como ("host1" OR "host2" OR "host3"). Nesse caso, todo valor deve ser de escape para que o valor contenha apenas palavras de controle e aspas do Lucene.

Solucionar problemas de variáveis de vários valores

O escape e a formatação automáticos podem causar problemas e pode ser difícil entender a lógica por trás disso. Especialmente para InfluxDB e Prometheus, em que o uso da sintaxe regex requer que a variável seja usada no contexto do operador regex.

Se você não quiser que o Grafana faça esse escape e formatação automáticos de regex, faça o seguinte:

Incluir todas as opções

O Grafana adiciona uma opção All à lista suspensa de variáveis. Se um usuário selecionar essa opção, então todas as opções de variáveis serão selecionadas.

Personalizar todos os valores

Essa opção só estará visível se Incluir todas as opções estiver selecionado.

Insira a sintaxe regex, globs ou lucene no campo Personalizar todos os valores para definir o valor da opção All.

Por padrão, o valor All inclui todas as opções em uma expressão combinada. Isso pode se tornar muito longo e causar problemas de performance. Às vezes, pode ser melhor especificar um valor personalizado para todos, como um regex curinga.

Para ter uma sintaxe personalizada de regex, globs ou lucene na opção Personalizar todos os valores, ela nunca é de escape, então você terá que pensar sobre qual será um valor válido para a fonte de dados.

Variáveis globais

O Grafana tem variáveis globais integradas que podem ser usadas em expressões no editor de consultas. Este tópico as lista em ordem alfabética e as define. Essas variáveis são úteis em consultas, links de dashboards, links de painéis e links de dados.

$__dashboard

Esta variável é o nome do dashboard atual.

$__from e $__to

O Grafana tem duas variáveis de intervalo de tempo integradas: $__from e $__to. Atualmente, elas são sempre interpoladas como milissegundos epoch por padrão, mas você pode controlar a formatação da data.

A sintaxe acima também funciona com ${__to}.

$__interval

Você pode usar a variável $__interval como um parâmetro para agrupar por hora (para InfluxDB, MySQL, Postgres, MSSQL), intervalo do histograma de datas (para Elasticsearch) ou como um parâmetro de função de resumo (para Graphite).

O Grafana calcula automaticamente um intervalo que pode ser usado para agrupar por hora nas consultas. Quando há mais pontos de dados do que os mostrados em um grafo, as consultas podem ser mais eficientes agrupando por um intervalo maior. Por exemplo, se você estiver vendo um grafo de três meses de dados, talvez não consiga ver os detalhes no nível de minutos. O agrupamento por hora ou dia torna a consulta mais eficiente sem afetar o que o grafo mostra. O $__interval é calculado usando o intervalo de tempo e a largura do grafo (o número de pixels).

Cálculo aproximado: (to - from) / resolution

Por exemplo, quando o intervalo de tempo é de uma hora e o grafo está em tela cheia, então o intervalo pode ser calculado em 2m. Os pontos são agrupados em intervalos de dois minutos. Se o intervalo de tempo for de seis meses e o grafo estiver em tela cheia, o intervalo poderá ser 1d (1 dia). Os pontos são agrupados por dia.

Na fonte de dados InfluxDB, a variável legada $interval é a mesma variável. $__intervaldeve ser usado em vez disso.

As fontes de dados InfluxDB e Elasticsearch têm os campos Group by time interval que são usados para codificar de forma rígida o intervalo ou definir o limite mínimo para a variável $__interval (usando a sintaxe >, por exemplo >10m).

$__interval_ms

Essa variável é a variável $__interval em milissegundos, não uma string formatada com intervalo de tempo. Por exemplo, se $__interval for 20m então $__interval_ms será 1200000.

$__org

Essa variável é o ID da organização atual. ${__org.name} é o nome da organização atual.

$__user

${__user.id} é o ID do usuário atual. ${__user.login} é o identificador de login do usuário atual. ${__user.email}é o e-mail do usuário atual.

$__range

Compatível apenas com as fontes de dados Prometheus e Loki. Essa variável representa o intervalo do dashboard atual. É calculado por to - from. Tem um milissegundo e uma segunda representação chamada $__range_ms e $__range_s.

$__rate_interval

Compatível somente com as fontes de dados Prometheus. A variável $__rate_interval deve ser usada na função de taxa.

$timeFilter ou $__timeFilter

A variável $timeFilter retorna o intervalo de tempo atualmente selecionado como uma expressão. Por exemplo, a expressão Last 7 days do intervalo de tempo é time > now() - 7d.

Isso é usado em vários lugares, incluindo:

$__timezone

A variável $__timezone retorna o fuso horário atualmente selecionado, ou utc ou uma entrada do banco de dados de fuso horário do IANA (por exemplo, America/New_York).

Se o fuso horário atualmente selecionado for Hora do navegador, o Grafana tentará determinar o fuso horário do seu navegador.

Variáveis encadeadas

Variáveis encadeadas, também chamadas de variáveis vinculadas ou variáveis aninhadas, são variáveis de consulta outras variáveis na consulta de variável.

As consultas de variáveis encadeadas são diferentes para cada fonte de dados, mas a premissa é a mesma para todas. Você pode usar consultas variáveis encadeadas em qualquer fonte de dados que as permita.

Dashboards com modelos vinculados extremamente complexos são possíveis, com cinco ou dez níveis de profundidade. Tecnicamente, não há limite para o quão profundo ou complexo você pode ir, mas quanto mais links você tiver, maior será a carga de consultas.

Dicas e práticas recomendadas

As práticas a seguir facilitarão o uso dos dashboards e variáveis.

Criar novas variáveis vinculadas

Ordem das variáveis

Você pode alterar a ordem das variáveis na lista de variáveis do dashboard clicando nas setas para cima e para baixo no lado direito de cada entrada. O Grafana lista os menus suspensos de variáveis da esquerda para a direita de acordo com essa lista, com a variável na parte superior, na extrema esquerda.

Considerações sobre complexidade

Quanto mais camadas de dependência você tiver nas variáveis, mais tempo será necessário para atualizar os dashboards após a alteração das variáveis.

Por exemplo, se você tiver uma série de quatro variáveis vinculadas (país, região, servidor, métrica) e alterar o valor da variável raiz (país), o Grafana então deverá executar consultas para todas as variáveis dependentes antes de atualizar as visualizações no dashboard.

Gerenciar variáveis

A página de variáveis permite adicionar variáveis e gerenciar as variáveis existentes. Também permite inspecionar variáveis e identificar se uma variável está sendo referenciada (ou usada) em outras variáveis ou no dashboard.

Mover: você pode mover uma variável para cima ou para baixo na lista usando arrastar e soltar.

Clonar: para clonar uma variável, clique no ícone de clonar no conjunto de ícones à direita. Isso cria uma cópia da variável com o nome da variável original prefixada com copy_of_.

Excluir: para excluir uma variável, clique no ícone da lixeira no conjunto de ícones à direita.

Filtrar variáveis com regex

Usando a opção de consulta regex, você filtra a lista de opções retornadas pela consulta da variável ou modifica as opções retornadas.

Esta página mostra como usar regex para filtrar e modificar valores no menu suspenso de variáveis.

Usando a opção de consulta regex, você filtra a lista de opções retornadas pela consulta da variável ou modifica as opções retornadas. Para obter mais informações, consulte o guia do Mozilla sobre expressões regulares.

Os exemplos a seguir mostram a filtragem na seguinte lista de opções

backend_01
backend_02
backend_03
backend_04

Filtrar para que somente as opções que terminam com 01 ou 02 sejam retornadas

Regex:

/
(
01|02 
) 
$/

Resultado:

backend_01
backend_02

Filtrar e modificar as opções usando um grupo de captura regex para retornar parte do texto

Regex:

/.* 
(
01|02 
)
/

Resultado:

01
02

Filtrar e modificar: exemplo do Prometheus

Para esta lista de opções:

up{instance="demo.robustperception.io:9090",job="prometheus"} 1 1521630638000
up{instance="demo.robustperception.io:9093",job="alertmanager"} 1 1521630638000
up{instance="demo.robustperception.io:9100",job="node"} 1 1521630638000

Este regex:

/. *instance="
(
[^"]*
)
.*/

Retorna estes resultados:

demo.robustperception.io:9090
demo.robustperception.io:9093
demo.robustperception.io:9100

Filtrar e modificar usando grupos nomeados de captura de texto e valor

Usando grupos de captura nomeados, você pode capturar partes separadas de “texto” e “valor” das opções retornadas pela consulta da variável. Isso permite que a lista suspensa de variáveis contenha um nome amigável para cada valor que possa ser selecionado.

Por exemplo, ao consultar a métrica node_hwmon_chip_names do Prometheus, o chip_name é muito mais amigável do que o valor chip. Portanto, o seguinte resultado da consulta de variável:

node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_0",chip_name="enp216s0f0np0"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_1",chip_name="enp216s0f0np1"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_2",chip_name="enp216s0f0np2"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_3",chip_name="enp216s0f0np3"} 1

Passou pelo seguinte regex:

/chip_name="(?<text>[ ^ " ] + ) |chip=" (?<value >[ ^ " ] + )/g

Produziria a seguinte lista suspensa:

Display Name          Value
------------          -------------------------
enp216s0f0np0         0000:d7:00_0_0000:d8:00_0
enp216s0f0np1         0000:d7:00_0_0000:d8:00_1
enp216s0f0np2         0000:d7:00_0_0000:d8:00_2
enp216s0f0np3         0000:d7:00_0_0000:d8:00_3

Somente nomes de grupos de captura text e value são compatíveis.