21 Kreisdiagramm

Beschreibung

Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Dashboard-Widget-Feldobjekte ermöglichen die Konfiguration des Widgets Kreisdiagramm in den Methoden dashboard.create und dashboard.update.

Die fields-Eigenschaften des Widgets werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert. Dies ermöglicht Benutzern, integrierte Widgets zu ändern und benutzerdefinierte Widgets zu erstellen, birgt jedoch auch das Risiko, Widgets fehlerhaft zu erstellen oder zu aktualisieren. Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Kreisdiagramm sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.

Parameter

Die folgenden Parameter werden für das Widget Kreisdiagramm unterstützt.

Parameter type name value
Aktualisierungsintervall 0 rf_rate 0 - Keine Aktualisierung;
10 - 10 Sekunden;
30 - 30 Sekunden;
60 - (Standard) 1 Minute;
120 - 2 Minuten;
600 - 10 Minuten;
900 - 15 Minuten.

Datensatz

Die folgenden Parameter werden für die Konfiguration eines Datensatzes unterstützt.

Die erste Zahl im Eigenschaftsnamen (z. B. ds.0.hosts.0, ds.0.items.0) steht für den jeweiligen Datensatz, während die zweite Zahl, sofern vorhanden, den konfigurierten Host oder Datenpunkt darstellt.

Parameter type name value
Datensatztyp 0 ds.0.dataset_type 0 - Datenpunktliste;
1 - (Standard) Datenpunktmuster.
Datenpunkte 4 ds.0.itemids.0 Datenpunkt-ID.
Wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird, sollten nur die auf der Vorlage konfigurierten Datenpunkte gesetzt werden.

Hinweis: Um mehrere Datenpunkte zu konfigurieren, erstellen Sie für jeden Datenpunkt ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.

Parameterverhalten:
- erforderlich, wenn Datensatztyp auf "Datenpunktliste" gesetzt ist und Datenpunkte (Widget) nicht gesetzt ist
Datenpunkte (Widget) 1 ds.0.itemids.0._reference Anstelle der Datenpunkt-ID:
ABCDE._itemid - setzen Sie ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE" gesetzt) als Datenquelle für Datenpunkte.

Hinweis: Um mehrere Widgets zu konfigurieren, erstellen Sie für jedes Widget ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.

Parameterverhalten:
- erforderlich, wenn Datensatztyp auf "Datenpunktliste" gesetzt ist und Datenpunkte nicht gesetzt ist
Farbe 1 ds.0.color.0 Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- erforderlich, wenn Datensatztyp auf "Datenpunktliste" gesetzt ist
Datenpunkttyp 0 ds.0.type.0 0 - (Standard) Normal;
1 - Gesamt.

Der Wert "Gesamt" kann nur für einen Datenpunkt im gesamten Diagramm gesetzt werden.

Parameterverhalten:
- unterstützt, wenn Datensatztyp auf "Datenpunktliste" gesetzt ist
Hostmuster 1 ds.0.hosts.0 Host-Name oder -Muster (z. B. "Zabbix*").

Parameterverhalten:
- erforderlich, wenn Datensatztyp auf "Datenpunktmuster" gesetzt ist

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Datenpunktmuster 1 ds.0.items.0 Datenpunkt-Name oder -Muster (z. B. "*: Number of processed *values per second").

Wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird, sollten nur die Muster für die auf der Vorlage konfigurierten Datenpunkte gesetzt werden.

Parameterverhalten:
- erforderlich, wenn Datensatztyp auf "Datenpunktmuster" gesetzt ist
Farbe 1 ds.0.color Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- unterstützt, wenn Datensatztyp auf "Datenpunktmuster" gesetzt ist und Farbpalette nicht gesetzt ist
Farbpalette 0 ds.0.color_palette Index der Farbpalette.

Mögliche Werte liegen zwischen 0 und 11.

Standard: 0.

Parameterverhalten:
- unterstützt, wenn Datensatztyp auf "Datenpunktmuster" gesetzt ist und Farbe nicht gesetzt ist
Aggregationsfunktion 0 ds.0.aggregate_function 1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - (Standard) last.
Datensatzaggregation 0 ds.0.dataset_aggregation 0 - (Standard) keine;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum.

Parameterverhalten:
- unterstützt, wenn Datenpunkttyp auf "Gesamt" gesetzt ist
Datensatzbezeichnung 1 ds.0.data_set_label Beliebiger Zeichenfolgenwert.

Standard: "" (leer).

Anzeigeoptionen

Die folgenden Parameter werden für die Konfiguration von Anzeigeoptionen unterstützt.

Parameter type name value
Auswahl der Verlaufsdaten 0 source 0 - (Standard) Auto;
1 - Verlauf;
2 - Trends.
Zeichnen 0 draw_type 0 - (Standard) Kreisdiagramm;
1 - Ringdiagramm.
Breite 0 width 20 - 20 % des Radius;
30 - 30 % des Radius;
40 - 40 % des Radius;
50 - (Standard) 50 % des Radius.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf „Ringdiagramm“ gesetzt ist
Strichbreite 0 stroke Mögliche Werte liegen im Bereich von 0-10.

Standard: 0.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf „Ringdiagramm“ gesetzt ist
Gesamtwert anzeigen 0 total_show 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf „Ringdiagramm“ gesetzt ist
Größe 0 value_size_type 0 - (Standard) Auto;
1 - Benutzerdefiniert.

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Größe (Wert für benutzerdefinierte Größe) 0 value_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 20.

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Dezimalstellen 0 decimal_places Mögliche Werte liegen im Bereich von 0-6.

Standard: 2.

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Einheiten (Kontrollkästchen) 0 units_show 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Einheiten (Wert) 1 units Beliebiger Zeichenfolgenwert.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf „Aktiviert“ gesetzt ist
Fett 0 value_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Farbe 1 value_color Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- unterstützt, wenn Gesamtwert anzeigen auf „Aktiviert“ gesetzt ist
Abstand zwischen Sektoren 0 space Mögliche Werte liegen im Bereich von 0-10.

Standard: 1.
Sektoren kleiner als N % zusammenführen (Kontrollkästchen) 0 merge 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Sektoren kleiner als N % zusammenführen (Wert) 0 merge_percent Mögliche Werte liegen im Bereich von 1-10.

Standard: 1.

Parameterverhalten:
- unterstützt, wenn Sektoren kleiner als N % zusammenführen (Kontrollkästchen) auf „Aktiviert“ gesetzt ist
Sektoren kleiner als N % zusammenführen (Farbe) 1 merge_color Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- unterstützt, wenn Sektoren kleiner als N % zusammenführen (Kontrollkästchen) auf „Aktiviert“ gesetzt ist

Zeitperiode

Die folgenden Parameter werden für die Konfiguration von Zeitperiode unterstützt.

Parameter type name value
Zeitperiode 1 time_period._reference DASHBOARD._timeperiod - legt den Zeitperioden-Selektor als Datenquelle fest;
ABCDE._timeperiod - legt ein kompatibles Widget (mit auf "ABCDE" gesetztem Parameter Reference) als Datenquelle fest.

Standard: DASHBOARD._timeperiod

Alternativ können Sie die Zeitperiode nur in den Parametern From und To festlegen.
From 1 time_period.from Gültiger Zeitstring in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).

Parameterverhalten:
- unterstützt, wenn Zeitperiode nicht gesetzt ist
- erforderlich, wenn time_period.to gesetzt ist
To 1 time_period.to Gültiger Zeitstring in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).

Parameterverhalten:
- unterstützt, wenn Zeitperiode nicht gesetzt ist
- erforderlich, wenn time_period.from gesetzt ist

Legende

Die folgenden Parameter werden für die Konfiguration der Legende unterstützt.

Parameter type name value
Legende anzeigen 0 legend 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Wert anzeigen 0 legend_value 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf „Aktiviert“ gesetzt ist
Aggregationsfunktion anzeigen 0 legend_aggregation 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf „Aktiviert“ gesetzt ist
Zeilen 0 legend_lines_mode 0 - (Standard) Fest;
1 - Variabel.

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf „Aktiviert“ gesetzt ist
Anzahl der Zeilen/
Maximale Anzahl der Zeilen
0 legend_lines Mögliche Werte liegen im Bereich von 1-10.

Standard: 1.

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf „Aktiviert“ gesetzt ist
Anzahl der Spalten 0 legend_columns Mögliche Werte liegen im Bereich von 1-4.

Standard: 4.

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf „Aktiviert“ gesetzt ist und Wert anzeigen auf „Deaktiviert“ gesetzt ist

Beispiele

Die folgenden Beispiele beschreiben nur die Konfiguration der Dashboard-Widget-Feldobjekte für das Kuchendiagramm Widget. Für weitere Informationen zur Konfiguration eines Dashboards siehe dashboard.create.

Konfiguration eines Kreisdiagramm-Widgets

Konfigurieren Sie ein Kreisdiagramm-Widget wie folgt:

  • 2 Datensätze mit insgesamt 9 Datenpunkten auf 1 Host.
  • Der erste Datensatz ist vom Typ „Datenpunktliste“ und besteht aus 3 Datenpunkten, die alle vom Typ „Normal“ sind und jeweils durch eine andere Farbe dargestellt werden.
  • Der zweite Datensatz ist vom Typ „Datenpunktmuster“, besteht aus 6 Datenpunkten, hat für jeden Datenpunkt eine konfigurierte Aggregation und wird durch eine benutzerdefinierte Farbe dargestellt.
  • Der zweite Datensatz hat außerdem eine benutzerdefinierte Datensatzbeschriftung.
  • Die Daten im Kreisdiagramm werden als Ringdiagramm mit einer benutzerdefinierten Breite und dem Gesamtwert mit Einheiten in der Mitte angezeigt.
  • Die Daten im Kreisdiagramm werden für einen benutzerdefinierten Zeitraum der letzten 3 Stunden angezeigt und aggregiert.
  • Die Legende des Kreisdiagramms zeigt konfigurierte Datenpunkte in 4 Zeilen an.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "piechart",
                        "name": "Pie chart",
                        "x": 0,
                        "y": 0,
                        "width": 24,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "ds.0.dataset_type",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.0",
                                "value": 23264
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.0",
                                "value": "FF0000"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.type.0",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.1",
                              "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                              "type": 0,
                              "name": "ds.0.type.2",
                              "value": 0
                            },
                            {
                                "type": 1,
                                "name": "ds.1.hosts.0",
                                "value": "Zabbix server"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.items.0",
                                "value": "*: Number of processed *values per second"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.color",
                                "value": "000000"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "type": 0,
                                "name": "draw_type",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "width",
                                "value": 30
                            },
                            {
                                "type": 0,
                                "name": "total_show",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_show",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "graph_time",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_period.from",
                                "value": "now-3h"
                            },
                            {
                                "type": 1,
                                "name": "time_period.to",
                                "value": "now"
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Siehe auch