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á.
Modelo JSON do dashboard
Este tópico de documentação foi desenvolvido para espaços de trabalho do Grafana compatíveis com o Grafana versão 10.x.
Para espaços de trabalho do Grafana compatíveis com o Grafana versão 9.x, consulte Trabalhar no Grafana versão 9.
Para espaços de trabalho do Grafana compatíveis com o Grafana versão 8.x, consulte Trabalhar no Grafana versão 8.
Um dashboard no Grafana é representado por um objeto JSON, que armazena metadados de seu dashboard. Os metadados do dashboard incluem propriedades do dashboard, metadados dos painéis, variáveis do modelo e consultas do painel.
Para visualizar o JSON de um dashboard
-
Navegue até um dashboard.
-
No menu de navegação superior, selecione o ícone de Configurações do dashboard (engrenagem).
-
Selecione o modelo JSON.
Campos JSON
Quando um usuário cria um novo dashboard, um novo objeto JSON do dashboard é inicializado com os campos a seguir.
nota
No JSON a seguir, o ID é mostrado como nulo, que é o valor padrão atribuído a ele até que um dashboard seja salvo. Depois que um dashboard é salvo, um valor inteiro é atribuído ao campo id.
{ "id": null, "uid": "cLV5GDCkz", "title": "New dashboard", "tags": [], "timezone": "browser", "editable": true, "graphTooltip": 1, "panels": [], "time": { "from": "now-6h", "to": "now" }, "timepicker": { "time_options": [], "refresh_intervals": [] }, "templating": { "list": [] }, "annotations": { "list": [] }, "refresh": "5s", "schemaVersion": 17, "version": 0, "links": [] }
A seguir, descrevemos cada campo no JSON do dashboard.
| Nome | Uso |
|---|---|
|
identificador numérico exclusivo para o dashboard (gerado pelo banco de dados) |
|
identificador de dashboard exclusivo que pode ser gerado por qualquer pessoa. string (8-40) |
|
título atual do dashboard |
|
tags associadas ao dashboard, uma matriz de strings |
|
tema do dashboard, como |
|
fuso horário do dashboard, como |
|
se um dashboard é editável ou não |
|
0 para nenhuma dica de ferramenta ou crosshair compartilhado (padrão), 1 para crosshair compartilhado, 2 para crosshair e dica de ferramenta compartilhados |
|
intervalo de tempo para o dashboard, como |
|
metadados do timepicker, consulte a seção timepicker para obter detalhes |
|
metadados de modelos, consulte a seção de modelos para obter detalhes |
|
metadados de anotações, consulte as anotações para saber como adicioná-los |
|
intervalo de atualização automática |
|
versão do esquema JSON (inteiro), incrementada toda vez que uma atualização do Grafana traz alterações para esse esquema |
|
versão do dashboard (inteiro), incrementada toda vez que o dashboard é atualizado |
|
matriz de painéis (consulte a próxima seção para obter detalhes) |
Painéis
Os painéis são os blocos de criação de um dashboard. Ele consiste em consultas de fontes de dados, tipos de grafos, aliases e muito mais. O painel JSON consiste em uma matriz de objetos JSON, cada um representando um painel diferente. A maioria dos campos é comum a todos os painéis, mas alguns campos dependem do tipo de painel. Veja a seguir um exemplo de painel JSON de um painel de texto.
"panels": [ { "type": "text", "title": "Panel Title", "gridPos": { "x": 0, "y": 0, "w": 12, "h": 9 }, "id": 4, "mode": "markdown", "content": "# title" }
Tamanho e posição do painel
A propriedade gridPos descreve o tamanho e a posição do painel nas coordenadas da grade.
-
w: 1 a 24 (a largura do dashboard é dividida em 24 colunas). -
h: em unidades de altura da grade, cada uma representa 30 pixels. -
x: a posição x, na mesma unidade quew. -
y: a posição y, na mesma unidade queh.
A grade tem uma gravidade negativa que moverá os painéis para cima se houver espaço vazio acima de um painel.
Timepicker
"timepicker": { "collapse": false, "enable": true, "notice": false, "now": true, "refresh_intervals": [ "5s", "10s", "30s", "1m", "5m", "15m", "30m", "1h", "2h", "1d" ], "status": "Stable", "type": "timepicker" }
Modelos
O campo templating contém uma matriz de variáveis de modelos com os valores salvos junto com alguns outros metadados.
"templating": { "enable": true, "list": [ { "allFormat": "wildcard", "current": { "tags": [], "text": "prod", "value": "prod" }, "datasource": null, "includeAll": true, "name": "env", "options": [ { "selected": false, "text": "All", "value": "*" }, { "selected": false, "text": "stage", "value": "stage" }, { "selected": false, "text": "test", "value": "test" } ], "query": "tag_values(cpu.utilization.average,env)", "refresh": false, "type": "query" }, { "allFormat": "wildcard", "current": { "text": "apache", "value": "apache" }, "datasource": null, "includeAll": false, "multi": false, "multiFormat": "glob", "name": "app", "options": [ { "selected": true, "text": "tomcat", "value": "tomcat" }, { "selected": false, "text": "cassandra", "value": "cassandra" } ], "query": "tag_values(cpu.utilization.average,app)", "refresh": false, "regex": "", "type": "query" } ] }
A tabela a seguir descreve o uso dos campos de modelos.
| Nome | Uso |
|---|---|
|
|
se modelos está habilitado ou não |
|
|
uma matriz de objetos, cada um representando uma variável de modelo |
|
|
formato a ser usado ao buscar todos os valores da fonte de dados, incluindo |
|
|
mostra o texto/valor da variável selecionada atualmente no dashboard |
|
|
mostra a fonte de dados para as variáveis |
|
|
se todas as opções de valor estão disponíveis ou não |
|
|
se vários valores podem ser selecionados ou não na lista de valores de variáveis |
|
|
formato a ser usado ao buscar séries temporais da fonte de dados |
|
|
nome da variável |
|
|
matriz de pares variáveis de texto/valor disponíveis para seleção no dashboard |
|
|
consulta de fonte de dados usada para buscar valores para uma variável |
|
|
configura quando atualizar uma variável |
|
|
extrai parte do nome de uma série ou segmento do nó de métricas |
|
|
tipo de variável, |
