Modelo JSON de painel

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

Para espaços de trabalho do Grafana compatíveis com a versão 8.x do Grafana, consulteTrabalhando na versão 8 do 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 de painéis, variáveis de modelo e consultas de painel.

Para visualizar o JSON de um painel.

1. Navegue até um painel.

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

3. Clique em 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 nulo, 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 aoid campo.

{
  "id": null,
  "uid": "cLV5GDCkz",
  "title": "New dashboard",
  "tags": [],
  "style": "dark",
  "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 painel JSON.

Name (Nome)	Uso
id	identificador numérico exclusivo para o painel (gerado pelo banco de dados)
uid	identificador exclusivo do painel que pode ser gerado por qualquer pessoa. string (8-40)
título	título atual do painel
tags	tags associadas ao painel, uma matriz de cadeias de caracteres
estilo	tema do painel, como escuro ou claro
timezone	fuso horário do painel, como utc ou navegador
editável	se um painel é editável ou não
Dica de ferramenta gráfica	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 últimas 6 horas ou últimos 7 dias
seletor de tempo	metadados do timepicker, consulte a seção Timepicker para obter detalhes
modelagem	metadados de modelagem, consulte a seção de modelagem para obter detalhes
anotações	metadados de anotações, veja as anotações para saber como adicioná-las
refrescar	intervalo de atualização automática
schemaVersion	versão do esquema JSON (número inteiro), incrementada cada vez que uma atualização do Grafana traz alterações no referido esquema
versão	versão do painel (número inteiro), incrementada cada vez que o painel é atualizado
painéis	matriz de painéis (veja abaixo 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 para todos os painéis, mas alguns campos dependem do tipo de painel. A seguir está 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—24 (a largura do painel é dividida em 24 colunas)

• h: Nas 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 se move para cima dos painéis se houver espaço vazio acima de um painel.

Seletor de tempo

"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

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