9 Diagramm

Beschreibung

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

Die Eigenschaften von Widget-fields werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert. Dadurch können Benutzer integrierte Widgets ändern und benutzerdefinierte Widgets erstellen, es besteht jedoch auch das Risiko, Widgets fehlerhaft zu erstellen oder zu aktualisieren. Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Graph sicherzustellen, beachten Sie bitte das in den nachstehenden Tabellen beschriebene Verhalten der Parameter.

Parameter

Die folgenden Parameter werden für das Widget Graph 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.
Referenz 1 reference Beliebiger Zeichenfolgenwert, der aus 5 Zeichen besteht (z. B. ABCDE oder JBPNL). Dieser Wert muss innerhalb des Dashboards, zu dem das Widget gehört, eindeutig sein.

Parameter behavior:
- erforderlich

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, für den konfigurierten Host oder Datenpunkt steht.

Parameter type name value
Datensatztyp 0 ds.0.dataset_type 0 - Datenpunktliste;
1 - (Standard) Datenpunktmuster.
Datenpunkte 4 ds.0.itemids.0 Datenpunkt-ID.

Bei der Konfiguration des Widgets auf einem Vorlagen-Dashboard 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 Referenz 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.

Dieser Parameter wird seit Zabbix 7.0.1 unterstützt.

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
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 Vorlagen-Dashboard konfiguriert wird.
Datenpunktmuster 1 ds.0.items.0 Datenpunkt-Name oder Muster (z. B. "*: Number of processed *values per second").

Bei der Konfiguration des Widgets auf einem Vorlagen-Dashboard 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).

Standard: FF465C.

Parameterverhalten:
- unterstützt, wenn Datensatztyp auf "Datenpunktmuster" gesetzt ist
Zeichnen 0 ds.0.type 0 - (Standard) Linie;
1 - Punkte;
2 - Treppe;
3 - Balken.
Gestapelt 0 ds.0.stacked 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf "Linie", "Treppe" oder "Balken" gesetzt ist
Breite 0 ds.0.width Mögliche Werte liegen im Bereich von 1-10.

Standard: 1.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf "Linie" oder "Treppe" gesetzt ist
Punktgröße 0 ds.0.pointsize Mögliche Werte liegen im Bereich von 1-10.

Standard: 3.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf "Punkte" gesetzt ist
Transparenz 0 ds.0.transparency Mögliche Werte liegen im Bereich von 1-10.

Standard: 5.
Füllung 0 ds.0.fill Mögliche Werte liegen im Bereich von 1-10.

Standard: 3.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf "Linie" oder "Treppe" gesetzt ist
Fehlende Daten 0 ds.0.missingdatafunc 0 - (Standard) Keine;
1 - Verbunden;
2 - Als 0 behandeln;
3 - Letzter bekannter Wert.

Parameterverhalten:
- unterstützt, wenn Zeichnen auf "Linie" oder "Treppe" gesetzt ist
Y-Achse 0 ds.0.axisy 0 - (Standard) Links;
1 - Rechts.
Zeitverschiebung 1 ds.0.timeshift Gültige Zeitangabe (z. B. 3600, 1h usw.).
Sie können Zeit-Suffixe verwenden. Negative Werte sind ebenfalls zulässig.

Standard: "" (leer).
Aggregationsfunktion 0 ds.0.aggregate_function 0 - (Standard) nicht verwendet;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Aggregationsintervall 1 ds.0.aggregate_interval Gültige Zeitangabe (z. B. 3600, 1h usw.).
Sie können Zeit-Suffixe verwenden.

Standard: 1h.
Aggregieren 0 ds.0.aggregate_grouping 0 - (Standard) Jedes Datenpunkt;
1 - Datensatz.

Parameterverhalten:
- unterstützt, wenn Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first" oder "last" gesetzt ist
Approximation 0 ds.0.approximation 1 - min;
2 - (Standard) avg;
4 - max;
7 - all.
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) Automatisch;
1 - Verlauf;
2 - Trends.
Einfache Auslöser 0 simple_triggers 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Arbeitszeit 0 working_time 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Perzentillinie (links)
Status 0 percentile_left 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt wenn Y-Achse (in der Konfiguration von Datenpunkt) auf "Links" gesetzt ist
Wert 0 percentile_left_value Mögliche Werte liegen im Bereich von 1-100.

Parameterverhalten:
- unterstützt wenn Y-Achse (in der Konfiguration von Datenpunkt) auf "Links" gesetzt ist
Perzentillinie (rechts)
Status 0 percentile_right 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt wenn Y-Achse (in der Konfiguration von Datenpunkt) auf "Rechts" gesetzt ist
Wert 0 percentile_right_value Mögliche Werte liegen im Bereich von 1-100.

Parameterverhalten:
- unterstützt wenn Y-Achse (in der Konfiguration von Datenpunkt) auf "Rechts" gesetzt ist

Zeitspanne

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

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

Standard: DASHBOARD._timeperiod

Alternativ können Sie die Zeitspanne nur in den Parametern From und To festlegen.
From 1 time_period.from Gültige Zeitangabe im absoluten (YYYY-MM-DD hh:mm:ss) oder relativen Zeitformat (now, now/d, now/w-1w, usw.).

Parameterverhalten:
- supported wenn Zeitspanne nicht gesetzt ist
- required wenn time_period.to gesetzt ist
To 1 time_period.to Gültige Zeitangabe im absoluten (YYYY-MM-DD hh:mm:ss) oder relativen Zeitformat (now, now/d, now/w-1w, usw.).

Parameterverhalten:
- supported wenn Zeitspanne nicht gesetzt ist
- required wenn time_period.from gesetzt ist

Achsen

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

Parameter type name value
Left Y 0 lefty 0 - Deaktiviert;
1 - (default) Aktiviert.

Parameterverhalten:
- supported wenn Y-axis (in der Konfiguration von Data set) auf "Left" gesetzt ist
Right Y 0 righty 0 - (default) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- supported wenn Y-axis (in der Konfiguration von Data set) auf "Right" gesetzt ist
Min 1 lefty_min Beliebiger numerischer Wert.

Standard: "" (leer).
righty_min
Max 1 lefty_max Beliebiger numerischer Wert.

Standard: "" (leer).
righty_max
Units (type) 0 lefty_units 0 - (default) Automatisch;
1 - Statisch.
righty_units
Units (value) 1 lefty_static_units Beliebiger Zeichenfolgenwert.

Standard: "" (leer).
righty_static_units
X-Axis 0 xaxis 0 - Deaktiviert;
1 - (default) Aktiviert.

Legende

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

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

Parameterverhalten:
- unterstützt, wenn Legende anzeigen auf "Aktiviert" gesetzt ist
Min./Durchs./Max. anzeigen 0 legend_statistic 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 Min./Durchs./Max. anzeigen auf "Deaktiviert" gesetzt ist

Probleme

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

Parameter type name value
Probleme anzeigen 0 show_problems 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Nur ausgewählte Datenpunkte 0 graph_item_problems 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Problem-Hosts 1 problemhosts.0 Host-Name.

Hinweis: Die Zahl im Eigenschaftsnamen verweist auf den konfigurierten Host.
Um mehrere Hosts zu konfigurieren, erstellen Sie für jeden Host ein Dashboard-Widget-Feldobjekt mit einer inkrementierten Zahl im Eigenschaftsnamen.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird.
Schweregrad 0 severities.0 0 - Nicht klassifiziert;
1 - Information;
2 - Warnung;
3 - Durchschnittlich;
4 - Hoch;
5 - Katastrophe.

Standard: leer (alle aktiviert).

Hinweis: Um mehrere Werte zu konfigurieren, erstellen Sie für jeden Wert ein Dashboard-Widget-Feldobjekt mit einer inkrementierten Zahl im Eigenschaftsnamen.
Problem 1 problem_name Problem-Ereignisname (Groß-/Kleinschreibung wird nicht beachtet, vollständiger Name oder ein Teil davon).
Problem-Tags
Auswertungstyp 0 evaltype 0 - (Standard) Und/Oder;
2 - Oder.
Tag-Name 1 tags.0.tag Beliebiger Zeichenfolgenwert.

Hinweis: Die Zahl im Eigenschaftsnamen verweist auf die Reihenfolge der Tags in der Tag-Auswertungsliste.

Parameterverhalten:
- erforderlich bei der Konfiguration von Problem-Tags
Operator 0 tags.0.operator 0 - Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.

Hinweis: Die Zahl im Eigenschaftsnamen verweist auf die Reihenfolge der Tags in der Tag-Auswertungsliste.

Parameterverhalten:
- erforderlich bei der Konfiguration von Problem-Tags
Tag-Wert 1 tags.0.value Beliebiger Zeichenfolgenwert.

Hinweis: Die Zahl im Eigenschaftsnamen verweist auf die Reihenfolge der Tags in der Tag-Auswertungsliste.

Parameterverhalten:
- erforderlich bei der Konfiguration von Problem-Tags

Overrides

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

Die erste Zahl im Eigenschaftsnamen (z. B. or.0.hosts.0, or.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
Host patterns 1 or.0.hosts.0 Host-Name oder Muster (z. B. Zabbix*).

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.

Parameterverhalten:
- erforderlich, wenn Overrides konfiguriert werden
Item patterns 1 or.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 Datenpunkte gesetzt werden, die auf der Vorlage konfiguriert sind.

Parameterverhalten:
- erforderlich, wenn Overrides konfiguriert werden
Base color 1 or.0.color Hexadezimaler Farbcode (z. B. FF0000).
Width 0 or.0.width Mögliche Werte liegen im Bereich von 1-10.
Draw 0 or.0.type 0 - Linie;
1 - Punkte;
2 - Treppe;
3 - Balken.
Transparency 0 or.0.transparency Mögliche Werte liegen im Bereich von 1-10.
Fill 0 or.0.fill Mögliche Werte liegen im Bereich von 1-10.
Point size 0 or.0.pointsize Mögliche Werte liegen im Bereich von 1-10.
Missing data 0 or.0.missingdatafunc 0 - Keine;
1 - Verbunden;
2 - Als 0 behandeln;
3 - Zuletzt bekannt.
Y-axis 0 or.0.axisy 0 - Links;
1 - Rechts.
Time shift 1 or.0.timeshift Gültiger Zeitstring (z. B. 3600, 1h usw.).
Sie können Zeit-Suffixe verwenden. Negative Werte sind zulässig.

Beispiele

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

Konfigurieren eines Graph-Widgets

Konfigurieren Sie ein Graph-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 als Linien mit unterschiedlicher Farbe, aber gleicher Breite, Transparenz und Füllung dargestellt werden.
  • Der zweite Datensatz ist vom Typ „Datenpunktmuster“, besteht aus 6 Datenpunkten, hat eine konfigurierte Aggregation und wird als Linie mit benutzerdefinierter Farbe, Breite, Transparenz und Füllung dargestellt.
  • Der zweite Datensatz hat außerdem eine benutzerdefinierte Datensatzbeschriftung.
  • Daten im Diagramm werden für einen Zeitraum der letzten 3 Stunden angezeigt.
  • Probleme im Diagramm werden nur für die konfigurierten Datenpunkte angezeigt.
  • Das Diagramm hat zwei Y-Achsen, wobei die rechte Y-Achse Werte nur für den zweiten Datensatz anzeigt.
  • Die Diagrammlegende zeigt konfigurierte Datenpunkte in 4 Zeilen sowie Minimal-, Maximal- und Durchschnittswerte der Datensätze an.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "svggraph",
                        "name": "Graph",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "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": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.width",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.transparency",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.fill",
                                "value": 1
                            },
                            {
                                "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.transparency",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.fill",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.axisy",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.aggregate_interval",
                                "value": "1m"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_grouping",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "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_statistic",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show_problems",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "YZABC"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

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

Siehe auch