Modèle JSON du tableau de bord

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Dans Amazon Managed Grafana, un tableau de bord est représenté par un objet JSON qui stocke les métadonnées de son tableau de bord. Les métadonnées du tableau de bord incluent les propriétés du tableau de bord, les métadonnées des panneaux, les variables de modèle et les requêtes des panneaux.

champs JSON

Lorsqu'un utilisateur crée un nouveau tableau de bord, un nouvel objet JSON de tableau de bord est initialisé avec les champs suivants.

{
  "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": []
}

Le tableau suivant fournit les détails d'utilisation pour chaque champ du tableau de bord JSON.

Panneaux

Les panneaux sont les éléments de base d'un tableau de bord. Il comprend des requêtes de source de données, des types de graphes, des alias et d'autres données. Le panneau JSON se compose d'un tableau d'objets JSON, chacun représentant un panneau différent. La plupart des champs sont communs à tous les panneaux, mais certains champs dépendent du type de panneau. L'exemple suivant montre le panneau JSON d'un panneau de texte.

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

Taille et position du panneau

La gridPos propriété décrit la taille et la position du panneau en coordonnées de la grille :

La grille a une gravité négative qui déplace les panneaux vers le haut s'il y a un espace vide au-dessus d'un panneau.

Sélecteur de temps

L'exemple suivant montre les timepicker options.

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

Le tableau suivant fournit des informations sur l'utilisation detimepicker.

Création de modèles

Le templating champ contient un tableau de variables de modèle avec leurs valeurs enregistrées et d'autres métadonnées. L'exemple suivant montre templating les métadonnées.

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

Le tableau suivant fournit les détails d'utilisation de la section de création de modèles.