Modello JSON del pannello di controllo - Grafana gestito da Amazon

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Modello JSON del pannello di controllo

Questo argomento della documentazione è progettato per le aree di lavoro Grafana che supportano la versione 10.x di Grafana.

Per le aree di lavoro Grafana che supportano la versione 9.x di Grafana, vedere. Lavorare nella versione 9 di Grafana

Per le aree di lavoro Grafana che supportano la versione 8.x di Grafana, vedere. Funzionamento in Grafana versione 8

Una dashboard in Grafana è rappresentata da un oggetto JSON, che memorizza i metadati della relativa dashboard. I metadati della dashboard includono le proprietà della dashboard, i metadati dei pannelli, le variabili del modello e le query dei pannelli.

Per visualizzare il codice JSON di una dashboard
  1. Passa a una dashboard.

  2. Nel menu di navigazione in alto, seleziona l'icona delle impostazioni della dashboard (a forma di ingranaggio).

  3. Seleziona il modello JSON.

Campi JSON

Quando un utente crea un nuovo dashboard, viene inizializzato un nuovo oggetto JSON del dashboard con i seguenti campi.

Nota

Nel seguente codice JSON, id viene visualizzato come null, che è il valore predefinito assegnato ad esso fino al salvataggio di un dashboard. Dopo il salvataggio di un pannello di controllo, al campo viene assegnato un valore intero. 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": [] }

Di seguito viene descritto ogni campo del dashboard JSON.

Nome Utilizzo

id

identificatore numerico univoco per la dashboard (generato dal db)

uid

identificatore univoco del dashboard che può essere generato da chiunque. String (8-40)

title

titolo attuale del pannello di controllo

tags

tag associati alla dashboard, una serie di stringhe

style

tema del pannello di controllo, ad esempio o dark light

timezone

fuso orario del pannello di controllo, ad esempio o utc browser

editable

se una dashboard è modificabile o meno

graphTooltip

0 per nessun mirino o tooltip condiviso (impostazione predefinita), 1 per mirino condiviso, 2 per mirino condiviso e tooltip condiviso

time

intervallo di tempo per il pannello di controllo, ad esempio o last 6 hours last 7 days

timepicker

metadati timepicker, consulta la sezione timepicker per i dettagli

templating

metadati basati sui modelli, consulta la sezione relativa ai modelli per i dettagli

annotations

metadati delle annotazioni, vedi le annotazioni per sapere come aggiungerli

refresh

intervallo di aggiornamento automatico

schemaVersion

versione dello schema JSON (numero intero), incrementata ogni volta che un aggiornamento Grafana apporta modifiche a questo schema

version

versione della dashboard (numero intero), incrementata ogni volta che la dashboard viene aggiornata

panels

array di pannelli (vedi la sezione successiva per i dettagli)

Riquadri

I pannelli sono gli elementi costitutivi di una dashboard. Consiste in interrogazioni sull'origine dei dati, tipi di grafici, alias e altro. Il pannello JSON è costituito da una serie di oggetti JSON, ognuno dei quali rappresenta un pannello diverso. La maggior parte dei campi è comune a tutti i pannelli, ma alcuni campi dipendono dal tipo di pannello. Quello che segue è un esempio di pannello JSON di un pannello di testo.

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

Dimensioni e posizione del pannello

La proprietà gridPos descrive le dimensioni e la posizione del pannello nelle coordinate della griglia.

  • w— da 1 a 24 (la larghezza del pannello di controllo è suddivisa in 24 colonne)

  • h— Nelle unità di altezza della griglia, ciascuna rappresenta 30 pixel.

  • x— La posizione x, nella stessa unità diw.

  • y— La posizione y, nella stessa unità dih.

La griglia ha una gravità negativa che si sposta verso l'alto dei pannelli se c'è spazio vuoto sopra un pannello.

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

Modellazione

Il templating campo contiene una serie di variabili modello con i relativi valori salvati insieme ad altri metadati.

"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 tabella seguente descrive l'utilizzo dei campi di modello.

Nome Utilizzo

enable

se il template è abilitato o meno

list

una matrice di oggetti, ciascuno dei quali rappresenta una variabile di modello

allFormat

formato da utilizzare durante il recupero di tutti i valori dalla fonte di dati, tra cuiwildcard, globregex,pipe.

current

mostra il testo/valore della variabile attualmente selezionata sulla dashboard

datasource

mostra la fonte di dati per le variabili

includeAll

se tutte le opzioni di valore sono disponibili o meno

multi

se è possibile selezionare o meno più valori dalla lista di valori variabili

multiFormat

formato da usare durante il recupero delle serie temporali dalla fonte di dati

name

nome della variabile

options

matrice di coppie testo/valore variabili disponibili per la selezione sulla dashboard

query

query sull'origine dei dati utilizzata per recuperare i valori di una variabile

refresh

configura quando aggiornare una variabile

regex

estrae parte del nome di una serie o di un segmento di nodo metrico

type

tipo di variabilecustom, o query interval