18 Datenpunkt-Wert

Beschreibung

Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Dashboard-Widget-Feldobjekte ermöglichen die Konfiguration des Widgets Datenpunktwert 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 Datenpunktwert sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.

Parameter

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

Parameter type name value
Refresh interval 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.
Item 4 itemid.0 Item-ID.

Verhalten von Parametern:
- erforderlich, wenn Item (Widget) nicht gesetzt ist
Item (Widget) 1 itemid._reference Anstelle der Item-ID:
ABCDE._itemid - setzen Sie ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE" gesetzt) als Datenquelle für Datenpunkte.

Verhalten von Parametern:
- erforderlich, wenn Item nicht gesetzt ist
Show 0 show.0 1 - Beschreibung;
2 - Wert;
3 - Zeit;
4 - Änderungsindikator;
5 - Sparkline.

Standard: 1, 2, 3, 4.

Hinweis: Um mehrere Werte zu konfigurieren, erstellen Sie für jeden Wert ein Dashboard-Widget-Feldobjekt mit einer erhöhten Nummer im Eigenschaftsnamen.
Override host 1 override_hostid._reference ABCDE._hostid - setzen Sie ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE" gesetzt) als Datenquelle für Hosts;
DASHBOARD._hostid - setzen Sie den [Host]-Selektor des Dashboards als Datenquelle für Hosts.

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

Erweiterte Konfiguration

Die folgenden erweiterten Konfigurationsparameter werden für das Widget Item value unterstützt.

Die Zahl im Eigenschaftsnamen Thresholds (z. B. thresholds.0.color) verweist auf die Position des Schwellenwerts in einer Liste, die in aufsteigender Reihenfolge sortiert ist. Wenn die Schwellenwerte jedoch in einer anderen Reihenfolge konfiguriert sind, werden die Werte nach dem Aktualisieren der Widget-Konfiguration im Zabbix Frontend in aufsteigender Reihenfolge sortiert (z. B. "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Parameter type name value
Hintergrundfarbe 1 bg_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Schwellenwerte
Farbe 1 thresholds.0.color Hexadezimaler Farbcode (z. B. FF0000).
Schwellenwert 1 thresholds.0.threshold Beliebiger Zeichenfolgenwert.
Aggregationsfunktion 0 aggregate_function 0 - (Standard) nicht verwendet;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Zeitraum 1 time_period._reference DASHBOARD._timeperiod - setzt den Zeitraum-Selektor als Datenquelle;
ABCDE._timeperiod - setzt ein kompatibles Widget (dessen Parameter reference gleich ABCDE ist) als Datenquelle.

Standard: DASHBOARD._timeperiod

Alternativ können Sie den Zeitraum nur in den Parametern From und To festlegen.

Parameterverhalten:
- unterstützt, wenn Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first", "last" gesetzt ist
From 1 time_period.from Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).

Parameterverhalten:
- unterstützt, wenn Zeitraum nicht gesetzt ist und Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first", "last" gesetzt ist
- erforderlich, wenn time_period.to gesetzt ist
To 1 time_period.to Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).

Parameterverhalten:
- unterstützt, wenn Zeitraum nicht gesetzt ist und Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first", "last" gesetzt ist
- erforderlich, wenn time_period.from gesetzt ist
Historische Daten 0 history 0 - (Standard) Auto;
1 - History;
2 - Trends.
Beschreibung

Die folgenden erweiterten Konfigurationsparameter werden unterstützt, wenn Anzeigen auf „Beschreibung“ gesetzt ist.

Parameter type name value
Beschreibung 1 description Beliebiger Zeichenfolgenwert, einschließlich Makros.
Unterstützte Makros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, Benutzermakros.

Standard: {ITEM.NAME}.
Horizontale Position 0 desc_h_pos 0 - Links;
1 - (Standard) Zentriert;
2 - Rechts.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position gemeinsam verwenden.
Vertikale Position 0 desc_v_pos 0 - Oben;
1 - Mitte;
2 - (Standard) Unten.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position gemeinsam verwenden.
Größe 0 desc_size Mögliche Werte liegen zwischen 1 und 100.

Standard: 15.
Fett 0 desc_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Farbe 1 desc_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Wert

Die folgenden erweiterten Konfigurationsparameter werden unterstützt, wenn Anzeigen auf „Wert“ gesetzt ist.

Parameter type name value
Dezimalstellen
Dezimalstellen 0 decimal_places Mögliche Werte liegen zwischen 1 und 10.

Standard: 2.
Größe 0 decimal_size Mögliche Werte liegen zwischen 1 und 100.

Standard: 35.
Position
Horizontale Position 0 value_h_pos 0 - Links;
1 - (Standard) Zentriert;
2 - Rechts.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position verwenden.
Vertikale Position 0 value_v_pos 0 - Oben;
1 - (Standard) Mitte;
2 - Unten.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position verwenden.
Größe 0 value_size Mögliche Werte liegen zwischen 1 und 100.

Standard: 45.
Fett 0 value_bold 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Farbe 1 value_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Einheiten
Einheiten (Kontrollkästchen) 0 units_show 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Einheiten (Wert) 1 units Beliebiger Zeichenfolgenwert.
Position 0 units_pos 0 - Vor dem Wert;
1 - Über dem Wert;
2 - (Standard) Nach dem Wert;
3 - Unter dem Wert.
Größe 0 units_size Mögliche Werte liegen zwischen 1 und 100.

Standard: 35.
Fett 0 units_bold 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Farbe 1 units_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Zeit

Die folgenden erweiterten Konfigurationsparameter werden unterstützt, wenn Anzeigen auf „Zeit“ gesetzt ist.

Parameter type name value
Horizontale Position 0 time_h_pos 0 - Links;
1 - (Standard) Zentriert;
2 - Rechts.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position verwenden.
Vertikale Position 0 time_v_pos 0 - (Standard) Oben;
1 - Mitte;
2 - Unten.

Zwei oder mehr Elemente (Beschreibung, Wert, Zeit) dürfen nicht dieselbe Horizontale Position und Vertikale Position verwenden.
Größe 0 time_size Mögliche Werte liegen zwischen 1 und 100.

Standard: 15.
Fett 0 time_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Farbe 1 time_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Änderungsindikator

Die folgenden erweiterten Konfigurationsparameter werden unterstützt, wenn Anzeigen auf „Änderungsindikator“ gesetzt ist.

Parameter type name value
Farbe des Änderungsindikators ↑ 1 up_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Farbe des Änderungsindikators ↓ 1 down_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Farbe des Änderungsindikators ↕ 1 updown_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Sparkline

Die folgenden erweiterten Konfigurationsparameter werden unterstützt, wenn Anzeigen auf „Sparkline“ gesetzt ist.

Parameter type name value
Breite 0 sparkline.width Mögliche Werte reichen von 0 bis 10.

Standard: 1.
Füllung 0 sparkline.fill Mögliche Werte reichen von 0 bis 10.

Standard: 3.
Farbe 1 sparkline.color Hexadezimaler Farbcode (z. B. FF0000).

Standard: 42A5F5.
Zeitraum 1 sparkline.time_period._reference DASHBOARD._timeperiod - den Zeitraum-Selektor als Datenquelle festlegen;
ABCDE._timeperiod - ein kompatibles Widget (mit dem Parameter reference, der auf ABCDE gesetzt ist) als Datenquelle festlegen.

Standard: DASHBOARD._timeperiod

Alternativ können Sie den Zeitraum nur in den Parametern Von und Bis festlegen.
Von 1 sparkline.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:
- erforderlich, wenn sparkline.time_period.to festgelegt ist
Bis 1 sparkline.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:
- erforderlich, wenn sparkline.time_period.from festgelegt ist
Verlaufsdaten 0 sparkline.history 0 - (Standard) Automatisch;
1 - Verlauf;
2 - Trends.

Beispiele

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

Konfigurieren eines Widgets Datenpunktwert

Konfigurieren Sie ein Widget Datenpunktwert, das den Datenpunktwert für den Datenpunkt „42266“ (Verfügbarkeit des Zabbix-Agenten) anzeigt. Zusätzlich können Sie das Widget mit mehreren erweiterten Optionen visuell feinabstimmen, einschließlich einer dynamischen Hintergrundfarbe, die sich abhängig vom Verfügbarkeitsstatus des Zabbix-Agenten ändert.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "item",
                        "name": "Item value",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42266
                            },
                            {
                                "type": 0,
                                "name": "show.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show.1",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "show.2",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "description",
                                "value": "Agent status"
                            },
                            {
                                "type": 0,
                                "name": "desc_h_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "desc_v_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "desc_bold",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "desc_color",
                                "value": "F06291"
                            },
                            {
                                "type": 0,
                                "name": "value_h_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "value_size",
                                "value": 25
                            },
                            {
                                "type": 1,
                                "name": "value_color",
                                "value": "FFFF00"
                            },
                            {
                                "type": 0,
                                "name": "units_show",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "time_h_pos",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "time_v_pos",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "time_size",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "time_bold",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_color",
                                "value": "9FA8DA"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "E1E1E1"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "D1C4E9"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "1"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

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

Siehe auch