Modelo JSON de painel - Amazon Managed Grafana
Campos JSONPainéis

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 de painel

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

Para espaços de trabalho do Grafana compatíveis com a versão 9.x do Grafana, consulteTrabalhando na versão 9 do Grafana.

Um painel no Amazon Managed 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. Abra um painel.

  2. Na barra de navegação, escolha Gerenciar painel.

  3. Selecione Exibir JSON no menu suspenso.

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 comonull, que é o valor padrão atribuído a ele até que um painel seja salvo. Depois de salvar um painel, um valor inteiro é atribuído aoid campo. 


{
  "id": null,
  "uid": "cLV5GDCkz",
  "title": "New dashboard",
  "tags": [],
  "style": "dark",
  "timezone": "browser",
  "editable": true,
  "hideControls": false,
  "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 tabela a seguir fornece detalhes de uso de cada campo no painel JSON do painel.

Name (Nome) Uso
id O identificador numérico exclusivo do painel (gerado pelo banco de dados).
uid O identificador exclusivo do painel que pode ser gerado por qualquer pessoa. Ouid é uma sequência de 8 a 40 caracteres.
título O título atual do painel.
tags As tags associadas ao painel. No JSON, as tags são uma matriz de strings.
style O tema do painel (por exemplo,dark oulight).
timezone O fuso horário do painel (utcoubrowser).
editable Se um painel pode ser editado.
graphTooltip O estilo da dica de ferramenta.

  • 0para nenhuma mira ou dica de ferramenta compartilhada (padrão)

  • 1para mira compartilhada

  • 2para mira compartilhada e dica de ferramenta compartilhada
time O intervalo de tempo do painel (por exemplo, últimas 6 horas, últimos 7 dias).
timepicker Os metadados do TimePicker. Para obter mais informações, consulte Seletor de horário.
templating Os metadados de modelagem. Para obter mais informações, consulte Modelos e variáveis.
annotations Os metadados das anotações. Para obter mais informações, consulte Anotações.
refresh O intervalo de atualização automática.
schemaVersion A versão do esquema JSON (número inteiro), que é incrementada toda vez que uma atualização do Amazon Managed Grafana altera o esquema.
version A versão do painel (número inteiro), que é incrementada sempre que o painel é atualizado.
panels A matriz de painéis. Para obter mais informações, consulte Painéis.

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 outros dados. 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. O exemplo a seguir mostra o 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

AgridPos propriedade 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— Em unidades de altura da grade. Cada unidade de altura da grade representa 30 pixels.

  • x— A posição x. A posição x usa a mesma unidade de coluna quew.

  • y— A posição y. A posição y usa a mesma unidade de altura da grade 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

O exemplo a seguir mostra astimepicker opções.


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

A tabela a seguir fornece detalhes de uso dotimepicker.

Name (Nome) Uso
collapse Setimepicker está colapsado
enable Setimepicker está ativado
notice TODO
now TODO
refresh_intervals TODO
status TODO
type TODO

Modelagem

Otemplating campo contém uma matriz de variáveis de modelo com seus valores salvos e outros metadados. O exemplo a seguir mostratemplating 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 fornece detalhes de uso para a seção de modelagem.

Name (Nome) Uso
habilitar Se a modelagem está ativada.
lista Uma matriz de objetos, cada um representando uma variável de modelo
Todos os formatos O formato a ser usado ao buscar todos os valores da fonte de dados (por exemplo,wildcard,glob,regex, epipe).
atual Mostra o texto ou o valor da variável selecionada atualmente no painel
fonte de dados Mostra a fonte de dados das variáveis
Incluir tudo Se a opção de todos os valores está disponível
multi Se vários valores podem ser selecionados da lista de valores variáveis
Multiformato O formato a ser usado ao buscar séries temporais da fonte de dados
name O nome de uma variável
options A matriz de pares de texto/valor variáveis disponíveis para seleção no painel
query A consulta da fonte de dados usada para buscar valores para uma variável
refrescar TODO
regex TODO
type O tipo de variável (custom,query, ouinterval)