On this page
6 Pegel
Beschreibung
Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Dashboard-Widget-Feldobjekte ermöglichen die Konfiguration
des Widgets Gauge in den Methoden dashboard.create und dashboard.update.
Die Eigenschaften von Widget-fields werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert.
Dies ermöglicht es 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 Gauge sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.
Parameter
Die folgenden Parameter werden für das Gauge-Widget 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. |
|
| Datenpunkt | 4 | itemid.0 | ID des Datenpunkts. Parameterverhalten: - erforderlich, wenn Datenpunkt (Widget) nicht gesetzt ist |
|
| Datenpunkt (Widget) | 1 | itemid._reference | Anstelle der ID des Datenpunkts:ABCDE._itemid - legt ein kompatibles Widget (mit dem auf "ABCDE" gesetzten Parameter Referenz) als Datenquelle für Datenpunkte fest.Parameterverhalten: - erforderlich, wenn Datenpunkt nicht gesetzt ist |
|
| Min | 1 | min | Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt. Standard: "0". |
|
| Max | 1 | max | Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt. Standard: "100". |
|
| Wertbogen | 1 | value_arc_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
|
| Bogenhintergrund | 1 | empty_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
|
| Hintergrund | 1 | bg_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
|
| Anzeigen | 0 | show.0 | 1 - Beschreibung; 2 - Wert; 3 - Zeiger; 4 - Skala; 5 - Wertbogen. Hinweis: Um mehrere Werte zu konfigurieren, erstellen Sie für jeden Wert ein Dashboard-Widget-Feldobjekt mit einer inkrementierten Nummer im Eigenschaftsnamen. Standard: 1, 2, 4, 5. Die Werte "Zeiger" und "Skala" werden nicht unterstützt, wenn beides zutrifft: - kein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Wertbogen" gesetzt ist; - der Parameter Bogen anzeigen der erweiterten Konfiguration auf "Deaktiviert" gesetzt ist. Parameter der erweiterten Konfiguration für Anzeigen-Optionen werden nicht unterstützt, wenn keine Dashboard-Widget-Feldobjekte mit den jeweiligen Werten gesetzt sind. |
|
| Host überschreiben | 1 | override_hostid._reference | ABCDE._hostid - legt ein kompatibles Widget (mit dem auf "ABCDE" gesetzten Parameter Referenz) als Datenquelle für Hosts fest;DASHBOARD._hostid - legt die Host-Auswahl des Dashboards als Datenquelle für Hosts fest.Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
Erweiterte Konfiguration
Die folgenden erweiterten Konfigurationsparameter werden für das Gauge-Widget 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 |
|---|---|---|---|
| Angle | 0 | angle | Mögliche Werte: 180 (Standard) oder 270. |
| Description | |||
| Description | 1 | description | Beliebiger Zeichenfolgenwert, einschließlich Makros. Unterstützte Makros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, benutzerdefinierte Makros.Standard: {ITEM.NAME}. |
| Size | 0 | desc_size | Möglicher Wertebereich: 1-100. Standard: 15. |
| Vertical position | 0 | desc_v_pos | 0 - Oben; 1 - (Standard) Unten. |
| Bold | 0 | desc_bold | 0 - (Standard) Deaktiviert; 1 - Aktiviert. |
| Color | 1 | desc_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
| Value | |||
| Decimal places | 0 | decimal_places | Möglicher Wertebereich: 1-10. Standard: 2. |
| Size | 0 | value_size | Möglicher Wertebereich: 1-100. Standard: 25. |
| Bold | 0 | value_bold | 0 - (Standard) Deaktiviert; 1 - Aktiviert. |
| Color | 1 | value_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
| Units | |||
| Units (checkbox) | 0 | units_show | 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
| Units (value) | 1 | units | Beliebiger Zeichenfolgenwert. Parameter behavior: - supported wenn Units (checkbox) auf "Enabled" gesetzt ist |
| Size | 0 | units_size | Möglicher Wertebereich: 1-100. Standard: 25. Parameter behavior: - supported wenn Units (checkbox) auf "Enabled" gesetzt ist |
| Bold | 0 | units_bold | 0 - (Standard) Deaktiviert; 1 - Aktiviert. Parameter behavior: - supported wenn Units (checkbox) auf "Enabled" gesetzt ist |
| Position | 0 | units_pos | 0 - Vor dem Wert; 1 - Über dem Wert; 2 - (Standard) Nach dem Wert; 3 - Unter dem Wert. Parameter behavior: - supported wenn Units (checkbox) auf "Enabled" gesetzt ist Dieser Parameter wird ignoriert, wenn er auf eine der folgenden zeitbezogenen Einheiten gesetzt ist: unixtime, uptime, s. |
| Color | 1 | units_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer). |
| Value arc | |||
| Arc size | 0 | value_arc_size | Möglicher Wertebereich: 1-100. Standard: 20. |
| Needle | |||
| Color | 1 | needle_color | Hexadezimaler Farbcode (z. B. FF0000).Standard: "" (leer).Parameter behavior: - supported wenn für Show ein Dashboard-Widget-Feldobjekt mit dem Wert "Value arc" gesetzt ist oder Show arc auf "Enabled" gesetzt ist |
| Scale | |||
| Show units | 0 | scale_show_units | 0 - Deaktiviert; 1 - (Standard) Aktiviert. Parameter behavior: - supported wenn Units (checkbox) auf "Enabled" gesetzt ist und entweder für Show ein Dashboard-Widget-Feldobjekt mit dem Wert "Value arc" gesetzt ist oder Show arc auf "Enabled" gesetzt ist |
| Size | 0 | scale_size | Möglicher Wertebereich: 1-100. Standard: 15. Parameter behavior: - supported wenn für Show ein Dashboard-Widget-Feldobjekt mit dem Wert "Value arc" gesetzt ist oder Show arc auf "Enabled" gesetzt ist |
| Decimal places | 0 | scale_decimal_places | Möglicher Wertebereich: 1-10. Standard: 0. Parameter behavior: - supported wenn für Show ein Dashboard-Widget-Feldobjekt mit dem Wert "Value arc" gesetzt ist oder Show arc auf "Enabled" gesetzt ist |
| Thresholds | |||
| Color | 1 | thresholds.0.color | Hexadezimaler Farbcode (z. B. FF0000). |
| Threshold | 1 | thresholds.0.threshold | Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt. |
| Show labels | 0 | th_show_labels | 0 - (Standard) Deaktiviert; 1 - Aktiviert. Parameter behavior: - supported wenn Thresholds gesetzt sind und entweder für Show ein Dashboard-Widget-Feldobjekt mit dem Wert "Value arc" gesetzt ist oder Show arc auf "Enabled" gesetzt ist |
| Show arc | 0 | th_show_arc | 0 - (Standard) Deaktiviert; 1 - Aktiviert. Parameter behavior: - supported wenn Thresholds gesetzt sind |
| Arc size | 0 | th_arc_size | Möglicher Wertebereich: 1-100. Standard: 5. Parameter behavior: - supported wenn Show arc auf "Enabled" gesetzt ist |
Beispiele
Die folgenden Beispiele beschreiben nur die Konfiguration der Dashboard-Widget-Feldobjekte für das Gauge-Widget.
Weitere Informationen zur Konfiguration eines Dashboards finden Sie unter dashboard.create.
Konfigurieren eines Gauge-Widgets
Konfigurieren Sie ein Gauge-Widget, das den Datenpunktwert für den Datenpunkt „44474“ (Schnittstelle enp0s3: Gesendete Bits) anzeigt. Zusätzlich können Sie das Widget mit mehreren erweiterten Optionen, einschließlich Schwellenwerten, visuell feinabstimmen.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "gauge",
"name": "Gauge",
"x": 0,
"y": 0,
"width": 18,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 4,
"name": "itemid.0",
"value": 44474
},
{
"type": 1,
"name": "min",
"value": "100000"
},
{
"type": 1,
"name": "max",
"value": "1000000"
},
{
"type": 0,
"name": "show.0",
"value": 1
},
{
"type": 0,
"name": "show.1",
"value": 2
},
{
"type": 0,
"name": "show.2",
"value": 3
},
{
"type": 0,
"name": "show.4",
"value": 4
},
{
"type": 0,
"name": "show.5",
"value": 5
},
{
"type": 0,
"name": "angle",
"value": 270
},
{
"type": 0,
"name": "desc_size",
"value": 10
},
{
"type": 0,
"name": "desc_bold",
"value": 1
},
{
"type": 0,
"name": "decimal_places",
"value": 0
},
{
"type": 0,
"name": "value_bold",
"value": 1
},
{
"type": 0,
"name": "units_size",
"value": 15
},
{
"type": 0,
"name": "units_pos",
"value": 3
},
{
"type": 1,
"name": "needle_color",
"value": "3C3C3C"
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "FF465C"
},
{
"type": 1,
"name": "thresholds.0.threshold",
"value": "700000"
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "FFD54F"
},
{
"type": 1,
"name": "thresholds.1.threshold",
"value": "500000"
},
{
"type": 1,
"name": "thresholds.2.color",
"value": "0EC9AC"
},
{
"type": 1,
"name": "thresholds.2.threshold",
"value": "100000"
},
{
"type": 0,
"name": "th_show_labels",
"value": 1
},
{
"type": 0,
"name": "th_show_arc",
"value": 1
},
{
"type": 0,
"name": "th_arc_size",
"value": 15
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}