Modelo JSON de panel - Amazon Managed Grafana

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Modelo JSON de panel

Este tema de documentación está diseñado para los espacios de trabajo de Grafana que admiten la versión 8.x de Grafana.

Para ver los espacios de trabajo de Grafana que admiten la versión 9.x de Grafana, consulte. Trabajando en Grafana versión 9

Un panel en Amazon Managed Grafana está representado por un objeto JSON, que almacena los metadatos de su panel. Los metadatos del panel incluyen las propiedades del panel, los metadatos de los paneles, las variables de plantilla y las consultas de los paneles.

Para ver el JSON de un panel
  1. Abre un panel de control.

  2. En la barra de navegación superior, selecciona Administrar panel.

  3. Selecciona Ver JSON en el menú desplegable.

Campos JSON

Cuando un usuario crea un panel nuevo, se inicializa un nuevo objeto JSON del panel con los siguientes campos.

nota

En el siguiente JSON, id se muestra comonull, que es el valor predeterminado que se le asigna hasta que se guarde un panel. Tras guardar un cuadro de mando, se asigna un valor entero al id 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": [] }

En la siguiente tabla, se proporcionan detalles de uso de cada campo del JSON del panel.

Name Uso
id El identificador numérico único del panel (generado por la base de datos).
uid El identificador único del panel de control que cualquier persona puede generar. uidEs una cadena de 8 a 40 caracteres.
title El título actual del panel de control.
etiquetas Las etiquetas que están asociadas al panel de control. En el JSON, las etiquetas son un conjunto de cadenas.
style El tema del panel de control (por ejemplo, dark olight).
timezone La zona horaria del panel (utcobrowser).
editable Si se puede editar un cuadro de mando.
graphTooltip El estilo de la información sobre herramientas.
  • 0para que no se comparta ningún punto de mira o información sobre herramientas (predeterminado)

  • 1para un punto de mira compartido

  • 2para el punto de mira compartido y la información sobre herramientas compartida

time El intervalo de tiempo del panel (por ejemplo, últimas 6 horas, últimos 7 días).
timepicker Los metadatos del selector de tiempo. Para obtener más información, consulte Selector de tiempo.
templating Los metadatos de la plantilla. Para obtener más información, consulte Plantillas y variables.
annotations Los metadatos de las anotaciones. Para obtener más información, consulte Annotations.
refresh El intervalo de actualización automática.
schemaVersion La versión del esquema JSON (entero), que se incrementa cada vez que una actualización de Grafana gestionada por Amazon cambia el esquema.
version La versión del panel (entero), que se incrementa cada vez que se actualiza el panel.
panels La matriz de paneles. Para obtener más información, consulte Paneles.

Paneles

Los paneles son los componentes básicos de un cuadro de mandos. Consiste en consultas de fuentes de datos, tipos de gráficos, alias y otros datos. El panel JSON consta de una matriz de objetos JSON, cada uno de los cuales representa un panel diferente. La mayoría de los campos son comunes a todos los paneles, pero algunos campos dependen del tipo de panel. El siguiente ejemplo muestra el panel JSON de un panel de texto.

"panels": [ { "type": "text", "title": "Panel Title", "gridPos": { "x": 0, "y": 0, "w": 12, "h": 9 }, "id": 4, "mode": "markdown", "content": "# title" }

Tamaño y posición del panel

La gridPos propiedad describe el tamaño y la posición del panel en las coordenadas de la cuadrícula:

  • w— 1-24. El ancho del salpicadero se divide en 24 columnas.

  • h— En unidades de altura de rejilla. Cada unidad de altura de rejilla representa 30 píxeles.

  • x— La posición x. La posición x utiliza la misma unidad de columna quew.

  • y— La posición y. La posición y utiliza la misma unidad de altura de rejilla queh.

La rejilla tiene una gravedad negativa que mueve los paneles hacia arriba si hay un espacio vacío por encima de un panel.

Selector de tiempo

En el siguiente ejemplo se muestran las timepicker opciones.

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

En la siguiente tabla se proporcionan detalles de uso detimepicker.

Name Uso
collapse Si timepicker está colapsado
enable Si timepicker está activado
notice TODO
now TODO
refresh_intervals TODO
status TODO
type TODO

Creación de plantillas

El templating campo contiene una matriz de variables de plantilla con sus valores guardados y otros metadatos. En el siguiente ejemplo, se muestran templating los metadatos.

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

La siguiente tabla proporciona detalles de uso de la sección de plantillas.

Name Uso
habilitar Si la creación de plantillas está activada.
list Conjunto de objetos, cada uno de los cuales representa una variable de plantilla
AllFormat El formato que se utilizará al obtener todos los valores de la fuente de datos (por ejemplo,wildcard, globregex, ypipe).
actual Muestra el texto o el valor de la variable seleccionada actualmente en el panel
origen de datos Muestra la fuente de datos de las variables
Incluir todo Si la opción de todos los valores está disponible
múltiple Si se pueden seleccionar varios valores de la lista de valores variables
Multiformato El formato que se utilizará al obtener series temporales de la fuente de datos
name El nombre de una variable
options El conjunto de pares de texto/valor de variables disponibles para su selección en el panel
consulta La consulta de la fuente de datos que se utiliza para obtener los valores de una variable
actualizar TODO
regex TODO
type El tipo de variable (custom,query, ointerval)