Modelo JSON del panel de control - Amazon Managed Grafana
Campos JSONPaneles

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 del panel de control

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

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

Para los espacios de trabajo de Grafana que admiten la versión 8.x de Grafana, consulte Uso de la versión 8 de Grafana.

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

Visualización del JSON de un panel de control

  1. Vaya a un panel de control.

  2. En el menú de navegación superior, seleccione el icono de Configuración del panel (engranaje).

  3. Seleccione Modelo JSON.

Campos JSON

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

nota

En el siguiente JSON, el ID se muestra como null, que es el valor predeterminado que se le asigna hasta que se guarde un panel de control. Tras guardar un panel de control, se asigna un valor entero al 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 continuación, se describe cada campo del JSON del panel de control.

Nombre Uso

id

identificador numérico único del panel de control (generado por la base de datos).

uid

identificador único del panel de control que cualquier persona puede generar. cadena (8-40).

title

título actual del panel de control.

tags

etiquetas asociadas al panel de control, una matriz de cadenas.

style

tema del panel de control, como dark o light

timezone

zona horaria del panel de control, como utc o browser.

editable

si un panel de control es editable o no

graphTooltip

0 si no se comparte el punto de mira o la información sobre herramientas (predeterminado), 1 si se comparte el punto de mira, 2 si se comparte el punto de mira o la información sobre herramientas compartida.

time

intervalo de tiempo para el panel de control, como last 6 hours o last 7 days.

timepicker

metadatos del selector de tiempo; consulte la sección del selector de tiempo para obtener más información.

templating

metadatos de plantillas; consulte la sección de plantillas para obtener más información.

annotations

metadatos de anotaciones; consulte las anotaciones para saber cómo agregarlos.

refresh

intervalo de actualización automática.

schemaVersion

versión del esquema JSON (entero), que se incrementa cada vez que una actualización de Grafana cambia el esquema.

version

versión del panel de control (entero), que se incrementa cada vez que se actualiza el panel de control.

panels

matriz de paneles (consulte la siguiente sección para obtener más información).

Paneles

Los paneles son los componentes básicos de un panel de control. Consiste en consultas de orígenes de datos, tipos de gráficos, alias, etc. El JSON del panel 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 es un ejemplo del JSON del panel 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 propiedad gridPos describe el tamaño y la posición del panel en las coordenadas de la cuadrícula.

  • w: de 1 a 24 (el ancho del panel de control se divide en 24 columnas).

  • h: cada unidad de altura de la tabla representa 30 píxeles.

  • x: la posición x utiliza la misma unidad que w.

  • y: la posición y utiliza la misma unidad que h.

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

Selector de tiempo

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

Plantillas

El campo templating contiene un conjunto de variables de plantilla con los valores guardados junto con otros 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"
      }
    ]
  }

En la siguiente tabla se describe el uso de los campos de creación de plantillas.

Nombre Uso

enable

si la creación de plantillas está habilitada o no.

list

una matriz de objetos, cada uno de los cuales representa una variable de plantilla

allFormat

formato que se utilizará al obtener todos los valores del origen de datos, incluidos wildcard, glob, regex y pipe.

current

muestra el texto/valor de la variable seleccionada actualmente en el panel de control.

datasource

muestra el origen de datos de las variables

includeAll

si la opción de todos los valores está disponible o no.

multi

si se pueden seleccionar varios valores de la lista de valores variables.

multiFormat

formato que se utilizará al obtener series temporales del origen de datos.

name

nombre de la variable.

options

matriz de pares de texto y valor de variables disponibles para su selección en el panel de control.

query

consulta del origen de datos que se utiliza para obtener los valores de una variable.

refresh

configura cuándo actualizar una variable.

regex

extrae parte del nombre de una serie o de un segmento de nodo métrico.

type

tipo de la variable (custom, query o interval).