Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Dashboard-JSON-Modell
Dieses Dokumentationsthema wurde für Grafana-Workspaces entwickelt, die Grafana-Version 10.x unterstützen.
Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 9.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 9
Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 8.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 8
Ein Dashboard in Grafana wird durch ein JSON-Objekt dargestellt, das Metadaten seines Dashboards speichert. Zu den Dashboard-Metadaten gehören Dashboard-Eigenschaften, Metadaten aus Panels, Vorlagenvariablen und Panel-Abfragen.
Um die JSON-Datei eines Dashboards anzuzeigen
-
Navigieren Sie zu einem Dashboard.
-
Wählen Sie im oberen Navigationsmenü das Symbol für die Dashboard-Einstellungen (Zahnrad) aus.
-
Wählen Sie JSON-Modell aus.
JSON-Felder
Wenn ein Benutzer ein neues Dashboard erstellt, wird ein neues Dashboard-JSON-Objekt mit den folgenden Feldern initialisiert.
Anmerkung
In der folgenden JSON-Datei wird id als Null angezeigt. Dies ist der Standardwert, der ihr zugewiesen wird, bis ein Dashboard gespeichert wird. Nach dem Speichern eines Dashboards wird dem id
Feld ein Ganzzahlwert zugewiesen.
{ "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": [] }
Im Folgenden wird jedes Feld im Dashboard-JSON beschrieben.
Name | Verwendung |
---|---|
|
eindeutiger numerischer Bezeichner für das Dashboard (generiert von der Datenbank) |
|
eindeutige Dashboard-ID, die von jedem generiert werden kann. string (8-40) |
|
aktueller Titel des Dashboards |
|
mit dem Dashboard verknüpfte Tags, eine Reihe von Zeichenketten |
|
Thema des Dashboards, wie |
|
Zeitzone des Dashboards, wie |
|
ob ein Dashboard editierbar ist oder nicht |
|
0 für kein gemeinsames Fadenkreuz oder Tooltip (Standard), 1 für gemeinsames Fadenkreuz, 2 für gemeinsames Fadenkreuz und gemeinsamen Tooltip |
|
Zeitbereich für das Dashboard, z. B. oder |
|
Timepicker-Metadaten, Einzelheiten finden Sie im Abschnitt Timepicker |
|
Metadaten mit Vorlagen erstellen, weitere Informationen finden Sie im Abschnitt Templating |
|
Metadaten zu Anmerkungen, wie Sie sie hinzufügen können, finden Sie unter Anmerkungen |
|
Intervall für automatische Aktualisierung |
|
Version des JSON-Schemas (Integer), die jedes Mal erhöht wird, wenn ein Grafana-Update Änderungen an diesem Schema vornimmt |
|
Version des Dashboards (Ganzzahl), die bei jeder Aktualisierung des Dashboards erhöht wird |
|
Anordnung der Bedienfelder (Einzelheiten finden Sie im nächsten Abschnitt) |
Felder
Panels sind die Bausteine eines Dashboards. Es besteht aus Datenquellenabfragen, Arten von Diagrammen, Aliasnamen und mehr. Panel-JSON besteht aus einer Reihe von JSON-Objekten, von denen jedes ein anderes Panel darstellt. Die meisten Felder sind für alle Panels gleich, aber einige Felder hängen vom Panel-Typ ab. Im Folgenden finden Sie ein Beispiel für das Panel-JSON eines Textfensters.
"panels": [ { "type": "text", "title": "Panel Title", "gridPos": { "x": 0, "y": 0, "w": 12, "h": 9 }, "id": 4, "mode": "markdown", "content": "# title" }
Größe und Position des Panels
Die GridPos-Eigenschaft beschreibt die Größe und Position des Panels in Rasterkoordinaten.
-
w
— 1 bis 24 (die Breite des Dashboards ist in 24 Spalten unterteilt) -
h
— In Rasterhöheneinheiten entspricht jede Einheit 30 Pixeln. -
x
— Die X-Position, in derselben Einheit wiew
. -
y
— Die Y-Position, in derselben Einheit wieh
.
Das Gitter hat eine negative Schwerkraft, die sich nach oben bewegt, wenn sich über einem Feld ein leerer Bereich befindet.
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" }
Vorlagen erstellen
Das templating
Feld enthält eine Reihe von Vorlagenvariablen mit ihren gespeicherten Werten sowie einigen anderen Metadaten.
"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" } ] }
In der folgenden Tabelle wird die Verwendung der Vorlagenfelder beschrieben.
Name | Verwendung |
---|---|
|
ob Templating aktiviert ist oder nicht |
|
ein Array von Objekten, die jeweils eine Vorlagenvariable repräsentieren |
|
Format, das beim Abrufen aller Werte aus der Datenquelle verwendet werden soll, einschließlich |
|
zeigt den aktuell ausgewählten Variablentext/Wert auf dem Dashboard an |
|
zeigt die Datenquelle für die Variablen |
|
ob die Option „Alle Werte“ verfügbar ist oder nicht |
|
ob mehrere Werte aus der Variablenwerteliste ausgewählt werden können oder nicht |
|
Format, das beim Abrufen von Zeitreihen aus der Datenquelle verwendet werden soll |
|
Name der Variablen |
|
Array von variablen Text-Wert-Paaren, die im Dashboard ausgewählt werden können |
|
Datenquellenabfrage, die zum Abrufen von Werten für eine Variable verwendet wird |
|
konfiguriert, wann eine Variable aktualisiert werden soll |
|
extrahiert einen Teil eines Seriennamens oder eines metrischen Knotensegments |
|
Typ der Variablen |