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.
Modèle JSON du tableau de bord
Cette rubrique de documentation est conçue pour les espaces de travail Grafana compatibles avec la version 9.x de Grafana.
Pour les espaces de travail Grafana compatibles avec la version 10.x de Grafana, voir. Travailler dans la version 10 de Grafana
Pour les espaces de travail Grafana compatibles avec la version 8.x de Grafana, voir. Travailler dans la version 8 de Grafana
Un tableau de bord dans Grafana 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.
Pour afficher le JSON d'un tableau de bord.
-
Accédez à un tableau de bord.
-
Dans le menu de navigation supérieur, cliquez sur l'icône des paramètres du tableau de bord (engrenage).
-
Cliquez sur Modèle JSON.
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.
Note
Dans le JSON suivant, id est affiché sous la forme null, qui est la valeur par défaut qui lui est attribuée jusqu'à ce qu'un tableau de bord soit enregistré. Une fois le tableau de bord enregistré, une valeur entière est attribuée au id champ.
{ "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": [] }
Ce qui suit décrit chaque champ du JSON du tableau de bord.
| Nom | Utilisation |
|---|---|
id |
identifiant numérique unique pour le tableau de bord (généré par la base de données) |
uid |
identifiant de tableau de bord unique pouvant être généré par n'importe qui. String (8-40) |
title |
titre actuel du tableau de bord |
tags |
balises associées au tableau de bord, un tableau de chaînes |
style |
thème du tableau de bord, tel que sombre ou clair |
timezone |
fuseau horaire du tableau de bord, tel que UTC ou navigateur |
modifiable |
si un tableau de bord est modifiable ou non |
Astuce graphique |
0 pour aucun réticule ou infobulle partagé (par défaut), 1 pour un réticule partagé, 2 pour un réticule partagé et une infobulle partagée |
time |
plage de temps pour le tableau de bord, telle que les 6 dernières heures ou les 7 derniers jours |
sélecteur de temps |
métadonnées du timepicker, voir la section timepicker pour plus de détails |
modélisation |
modélisation des métadonnées, voir la section relative aux modèles pour plus de détails |
annotations |
métadonnées des annotations, voir les annotations pour savoir comment les ajouter |
rafraîchir |
intervalle d'actualisation automatique |
schemaVersion |
version du schéma JSON (entier), incrémentée chaque fois qu'une mise à jour de Grafana apporte des modifications audit schéma |
Version |
version du tableau de bord (entier), incrémentée à chaque mise à jour du tableau de bord |
panneaux |
matrice de panneaux (voir ci-dessous pour plus de détails) |
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, etc. 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. Voici un exemple de 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 propriété GridPos décrit la taille et la position du panneau en coordonnées de la grille.
-
w: 1 à 24 (la largeur du tableau de bord est divisée en 24 colonnes) -
h: En unités de hauteur de grille, chacune représente 30 pixels. -
x: La position x, dans la même unité quew. -
y: La position y, dans la même unité queh.
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.
Timepicker
"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" }
Création de modèles
Le templating champ contient un tableau de variables de modèle avec leurs valeurs enregistrées ainsi que d'autres 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" } ] }
