Modelo JSON do painel

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

Para espaços de trabalho do Grafana que suportam a versão 9.x do Grafana, consulte. Trabalhando na versão 9 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

Um painel no Grafana é representado por um objeto JSON, que armazena metadados de seu painel. Os metadados do painel incluem propriedades do painel, metadados dos painéis, variáveis do modelo e consultas do painel.

Para visualizar o JSON de um painel

1. Navegue até um painel.

2. No menu de navegação superior, selecione o ícone de configurações do painel (engrenagem).

3. Selecione o modelo JSON.

Campos JSON

Quando um usuário cria um novo painel, um novo objeto JSON do painel é inicializado com os seguintes campos.

nota

No JSON a seguir, id é mostrado como null, que é o valor padrão atribuído a ele até que um painel seja salvo. Depois que um painel é salvo, um valor inteiro é atribuído ao id campo.

{
  "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 painel.

Nome	Uso
id	identificador numérico exclusivo para o painel (gerado pelo banco de dados)
uid	identificador de painel exclusivo que pode ser gerado por qualquer pessoa. string (8-40)
title	título atual do painel
tags	tags associadas ao painel, uma matriz de strings
style	tema do painel, como dark ou light
timezone	fuso horário do painel, como ou utc browser
editable	se um painel é editável ou não
graphTooltip	0 para nenhuma mira ou dica de ferramenta compartilhada (padrão), 1 para mira compartilhada, 2 para mira compartilhada e dica de ferramenta compartilhada
time	intervalo de tempo para o painel, como last 6 hours ou last 7 days
timepicker	metadados do timepicker, consulte a seção timepicker para obter detalhes
templating	metadados de modelagem, consulte a seção de modelagem para obter detalhes
annotations	metadados de anotações, consulte as anotações para saber como adicioná-los
refresh	intervalo de atualização automática
schemaVersion	versão do esquema JSON (inteiro), incrementada cada vez que uma atualização do Grafana traz alterações nesse esquema
version	versão do painel (inteiro), incrementada cada vez que o painel é atualizado
panels	matriz de painéis (consulte a próxima seção para obter detalhes)

Painéis

Os painéis são os blocos de construção de um painel. Ele consiste em consultas de fontes de dados, tipos de gráficos, 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 do 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 painel é 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 move os painéis para cima se houver espaço vazio acima de um painel.

Seletor de horário

"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"
  }

Modelagem

O templating campo contém uma matriz de variáveis de modelo com seus 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 modelagem.

Nome	Uso
enable	se a modelagem está habilitada ou não
list	uma matriz de objetos, cada um representando uma variável de modelo
allFormat	formato a ser usado ao buscar todos os valores da fonte de dados, incluindowildcard,, globregex,pipe.
current	mostra o texto/valor da variável selecionada atualmente no painel
datasource	mostra a fonte de dados para as variáveis
includeAll	se todas as opções de valor estão disponíveis ou não
multi	se vários valores podem ser selecionados ou não da lista de valores variáveis
multiFormat	formato a ser usado ao buscar séries temporais da fonte de dados
name	nome da variável
options	matriz de pares variáveis de texto/valor disponíveis para seleção no painel
query	consulta de fonte de dados usada para buscar valores para uma variável
refresh	configura quando atualizar uma variável
regex	extrai parte do nome de uma série ou segmento de nó métrico
type	tipo de variável,custom,query, ou interval