28 Top-Datenpunkte

Beschreibung

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

Die Eigenschaften fields des Widgets werden während 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 falsch zu erstellen oder zu aktualisieren. Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Top items sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.

Parameter

Die folgenden Parameter werden für das Widget Top items 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.
Host groups 2 groupids.0 ID der Host group.

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

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Host groups (Widget) 1 groupids._reference Anstelle der ID der Host group:
ABCDE._hostgroupids - setzen Sie ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE") als Datenquelle für Host groups.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Hosts 3 hostids.0 ID des Host.

Hinweis: Um mehrere Hosts zu konfigurieren, erstellen Sie für jeden Host ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen. Bei mehreren Hosts muss der Parameter Host groups entweder gar nicht konfiguriert sein oder mit mindestens einer Host group konfiguriert sein, zu der die konfigurierten Hosts gehören.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Hosts (Widget/Dashboard) 1 hostids._reference Anstelle der ID des Host:
DASHBOARD.hostids - setzen Sie den Host selector als Datenquelle für Hosts;
ABCDE._hostids - setzen Sie ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE") als Datenquelle für Hosts.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Host tags
Evaluation type 0 host_tags_evaltype 0 - (Standard) Und/Oder;
2 - Oder.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Tag name 1 host_tags.0.tag Beliebiger Zeichenfolgenwert.

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

Parameter behavior:
- erforderlich, wenn Host tags konfiguriert werden

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Operator 0 host_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 des Tags in der Tag-Auswertungsliste.

Parameter behavior:
- erforderlich, wenn Host tags konfiguriert werden

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Tag value 1 host_tags.0.value Beliebiger Zeichenfolgenwert.

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

Parameter behavior:
- erforderlich, wenn Host tags konfiguriert werden

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlage-Dashboard konfiguriert wird.
Layout 0 layout 0 - (Standard) Horizontal;
1 - Vertikal.
Show problems 0 show_problems 0 - Alle;
1 - (Standard) Nicht unterdrückte;
2 - Keine.
Items (see below)

Erweiterte Konfiguration

Für das Widget Top-Datenpunkte werden die folgenden erweiterten Konfigurationsparameter unterstützt.

Parameter type name value
Host-Reihenfolge
Sortieren nach 0 host_ordering_order_by 0 - (Standard) Host-Name;
3 - Datenpunktwert.
Datenpunktmuster 1 host_ordering_item.0 Name oder Muster des Datenpunkts (z. B. "*: Anzahl der verarbeiteten *Werte pro Sekunde").

Hinweis: Um mehrere Datenpunktmuster zu konfigurieren, erstellen Sie für jedes Datenpunktmuster ein Dashboard-Widget-Feldobjekt mit einer fortlaufenden Nummer im Eigenschaftsnamen.

Bei der Konfiguration des Widgets auf einem Vorlagen-Dashboard sollten nur die Muster für Datenpunkte festgelegt werden, die auf der Vorlage konfiguriert sind.

Parameterverhalten:
- erforderlich, wenn Sortieren nach auf „Datenpunktwert“ gesetzt ist
Reihenfolge 0 host_ordering_order 2 - (Standard) Top N;
3 - Bottom N.
Limit 0 host_ordering_limit Mögliche Werte liegen zwischen 1 und 100.

Standard: 10.
Datenpunkt-Reihenfolge
Sortieren nach 0 item_ordering_order_by 1 - Host;
2 - Datenpunktname;
3 - (Standard) Datenpunktwert.
Host-Muster 1 item_ordering_host.0 Name oder Muster des Hosts.

Hinweis: Um mehrere Host-Muster zu konfigurieren, erstellen Sie für jedes Host-Muster ein Dashboard-Widget-Feldobjekt mit einer fortlaufenden Nummer im Eigenschaftsnamen.

Parameterverhalten:
- erforderlich, wenn Sortieren nach auf „Host“ gesetzt ist
Reihenfolge 0 item_ordering_order 2 - (Standard) Top N;
3 - Bottom N.
Limit 0 item_ordering_limit Mögliche Werte liegen zwischen 1 und 100.

Standard: 10.

Spalten

Die erste Zahl im Eigenschaftsnamen (z. B. columns.0.items.0, columns.0.item_tags_evaltype) stellt die jeweilige Spalte dar, während die zweite Zahl, sofern vorhanden, die konfigurierte Entität (z. B. Datenpunktmuster, Tag) angibt.

Parameter type name value
Datenpunktmuster 1 columns.0.items.0 Name oder Muster des Datenpunkts (z. B. "*: Anzahl der verarbeiteten *Werte pro Sekunde").

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

Bei der Konfiguration des Widgets in einem Vorlagen-Dashboard sollten nur die Muster für Datenpunkte festgelegt werden, die auf der Vorlage konfiguriert sind.

Parameterverhalten:
- erforderlich
Datenpunkt-Tags
Auswertungstyp 0 columns.0.item_tags_evaltype 0 - (Standard) Und/Oder;
2 - Oder.
Tag-Name 1 columns.0.item_tags.0.tag Beliebiger Zeichenfolgenwert.

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

Parameterverhalten:
- erforderlich, wenn Datenpunkt-Tags konfiguriert werden
Operator 0 columns.0.item_tags.0.operator 0 - Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Existiert;
5 - Existiert nicht.

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

Parameterverhalten:
- erforderlich, wenn Datenpunkt-Tags konfiguriert werden
Tag-Wert 1 columns.0.item_tags.0.value Beliebiger Zeichenfolgenwert.

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

Parameterverhalten:
- erforderlich, wenn Datenpunkt-Tags konfiguriert werden
Grundfarbe 1 columns.0.base_color Hexadezimaler Farbcode (z. B. FF0000).
Wert anzeigen als 0 columns.0.display_value_as 1 - (Standard) Numerisch;
2 - Text.
Anzeige 0 columns.0.display 1 - (Standard) Wie vorhanden;
2 - Balken;
3 - Indikatoren;
6 - Sparkline.
Min. 1 columns.0.min Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Numerisch" und Anzeige auf "Balken" oder "Indikatoren" gesetzt ist
Max. 1 columns.0.max Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Numerisch" und Anzeige auf "Balken" oder "Indikatoren" gesetzt ist
Sparkline
Breite 0 columns.0.sparkline.width Mögliche Werte liegen zwischen 0 und 10.

Standard: 1.

Parameterverhalten:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
Füllung 0 columns.0.sparkline.fill Mögliche Werte liegen zwischen 0 und 10.

Standard: 3.

Parameterverhalten:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
Farbe 1 columns.0.sparkline.color Hexadezimaler Farbcode (z. B. FF0000).

Standard: 42A5F5.

Parameterverhalten:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
Zeitraum 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - den *Zeitraumauswahlschalter als Datenquelle festlegen;
ABCDE._timeperiod - ein kompatibles Widget (mit dem auf ABCDE gesetzten Parameter reference) als Datenquelle festlegen.

Standard: DASHBOARD._timeperiod

Alternativ können Sie den Zeitraum nur in den Parametern Von und Bis festlegen.

Parameterverhalten:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
Von 1 columns.0.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:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
- erforderlich, wenn columns.0.sparkline.time_period.to festgelegt ist
Bis 1 columns.0.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:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
- erforderlich, wenn columns.0.sparkline.time_period.from festgelegt ist
Verlaufsdaten 0 columns.0.sparkline.history 0 - (Standard) Automatisch;
1 - Verlauf;
2 - Trends.

Parameterverhalten:
- unterstützt, wenn Anzeige auf "Sparkline" gesetzt ist
Schwellenwerte
Farbe 1 columns.0.thresholds.0.color Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Numerisch" gesetzt ist
Schwellenwert 1 columns.0.thresholds.0.threshold Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Numerisch" gesetzt ist
Hervorhebungen
Hervorhebung 1 columns.0.highlights.0.color Hexadezimaler Farbcode (z. B. FF0000).

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Text" gesetzt ist
Schwellenwert 1 columns.0.highlights.0.pattern Beliebiger regulärer Ausdruck.

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Text" gesetzt ist
Dezimalstellen 0 columns.0.decimal_places Mögliche Werte liegen zwischen 0 und 10.

Standard: 2.
Erweiterte Konfiguration
Aggregationsfunktion 0 columns.0.aggregate_function Wenn Wert anzeigen als auf "Numerisch" gesetzt ist:
0 - (Standard) nicht verwendet;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.

Wenn Wert anzeigen als auf "Text" gesetzt ist:
0 - (Standard) nicht verwendet;
4 - count;
6 - first;
7 - last.
Zeitraum 1 columns.0.time_period._reference DASHBOARD._timeperiod - den *Zeitraumauswahlschalter als Datenquelle festlegen;
ABCDE._timeperiod - ein kompatibles Widget (mit dem auf ABCDE gesetzten Parameter reference) als Datenquelle festlegen.

Standard: DASHBOARD._timeperiod

Alternativ können Sie den Zeitraum nur in den Parametern Von und Bis festlegen.

Parameterverhalten:
- unterstützt, wenn Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first" oder "last" gesetzt ist
Von 1 columns.0.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:
- unterstützt, wenn Zeitraum nicht festgelegt und Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first" oder "last" gesetzt ist
- erforderlich, wenn columns.0.time_period.to festgelegt ist
Bis 1 columns.0.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:
- unterstützt, wenn Zeitraum nicht festgelegt und Aggregationsfunktion auf "min", "max", "avg", "count", "sum", "first" oder "last" gesetzt ist
- erforderlich, wenn columns.0.time_period.from festgelegt ist
Verlaufsdaten 0 columns.0.history 0 - (Standard) Automatisch;
1 - Verlauf;
2 - Trends.

Parameterverhalten:
- unterstützt, wenn Wert anzeigen als auf "Numerisch" gesetzt ist

Beispiele

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

Konfiguration eines Widgets Top items

Konfigurieren Sie ein Widget Top items, das Daten für den Host „10084“ anzeigt und nur für Datenpunkte, bei denen das Tag mit dem Namen „component“ den Wert „cpu“ enthält. Zeigen Sie außerdem die Daten so an, dass sich die Hosts oben befinden, und verwenden Sie für die Zellendarstellung einen farbigen Balken als Messanzeige.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "topitems",
                        "name": "Top items",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "columns.0.items.0",
                                "value": "*"
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.item_tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.value",
                                "value": "cpu"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.display",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "layout",
                                "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