18 Wartość pozycji

Opis

Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Wartość pozycji w metodach dashboard.create i dashboard.update.

Właściwości fields widgetu nie są walidowane podczas tworzenia ani aktualizacji pulpitu. Pozwala to użytkownikom modyfikować wbudowane widgety i tworzyć własne widgety, ale jednocześnie wprowadza ryzyko nieprawidłowego tworzenia lub aktualizowania widgetów. Aby zapewnić pomyślne utworzenie lub zaktualizowanie widgetu Wartość pozycji, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Następujące parametry są obsługiwane dla widżetu Wartość pozycji.

Parametr type name value
Interwał odświeżania 0 rf_rate 0 - Brak odświeżania;
10 - 10 sekund;
30 - 30 sekund;
60 - (domyślnie) 1 minuta;
120 - 2 minuty;
600 - 10 minut;
900 - 15 minut.
Pozycja 4 itemid.0 ID pozycji.

Zachowanie parametrów:
- wymagane, jeśli Pozycja (widżet) nie jest ustawiona
Pozycja (widżet) 1 itemid._reference Zamiast ID pozycji:
ABCDE._itemid - ustaw kompatybilny widżet (z parametrem Odwołanie ustawionym na "ABCDE") jako źródło danych dla pozycji.

Zachowanie parametrów:
- wymagane, jeśli Pozycja nie jest ustawiona
Pokaż 0 show.0 1 - Opis;
2 - Wartość;
3 - Czas;
4 - Wskaźnik zmiany;
5 - Wykres przebiegu.

Domyślnie: 1, 2, 3, 4.

Uwaga: Aby skonfigurować wiele wartości, utwórz obiekt pola widżetu pulpitu dla każdej wartości z inkrementowanym numerem w nazwie właściwości.
Nadpisz host 1 override_hostid._reference ABCDE._hostid - ustaw kompatybilny widżet (z parametrem Odwołanie ustawionym na "ABCDE") jako źródło danych dla hostów;
DASHBOARD._hostid - ustaw selektor hosta pulpitu jako źródło danych dla hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu.

Zaawansowana konfiguracja

Dla widżetu Wartość pozycji obsługiwane są następujące zaawansowane parametry konfiguracji.

Liczba w nazwie właściwości Thresholds (na przykład thresholds.0.color) odnosi się do miejsca progu na liście posortowanej rosnąco. Jeśli jednak progi zostaną skonfigurowane w innej kolejności, wartości zostaną posortowane rosnąco po zaktualizowaniu konfiguracji widżetu w frontend Zabbix (na przykład "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Parameter type name value
Kolor tła 1 bg_color Szesnastkowy kod koloru (na przykład FF0000).

Domyślnie: "" (puste).
Progi
Kolor 1 thresholds.0.color Szesnastkowy kod koloru (na przykład FF0000).
Próg 1 thresholds.0.threshold Dowolna wartość tekstowa.
Funkcja agregacji 0 aggregate_function 0 - (domyślnie) nieużywana;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Okres czasu 1 time_period._reference DASHBOARD._timeperiod - ustaw selektor okresu czasu pulpitu jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widżet (z parametrem reference równym ABCDE) jako źródło danych.

Domyślnie: DASHBOARD._timeperiod

Alternatywnie można ustawić okres czasu tylko w parametrach Od i Do.

Zachowanie parametru:
- obsługiwany, jeśli Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "last"
Od 1 time_period.from Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany, jeśli Okres czasu nie jest ustawiony, a Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "last"
- wymagany, jeśli ustawiono time_period.to
Do 1 time_period.to Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany, jeśli Okres czasu nie jest ustawiony, a Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "last"
- wymagany, jeśli ustawiono time_period.from
Dane historyczne 0 history 0 - (domyślnie) Auto;
1 - Historia;
2 - Trendy.
Opis

Poniższe zaawansowane parametry konfiguracji są obsługiwane, jeśli opcja Pokaż jest ustawiona na „Opis”.

Parametr type name value
Opis 1 description Dowolna wartość tekstowa, w tym makra.
Obsługiwane makra: {HOST.*}, {ITEM.*}, {INVENTORY.*}, makra użytkownika.

Wartość domyślna: {ITEM.NAME}.
Pozycja pozioma 0 desc_h_pos 0 - Lewo;
1 - (domyślnie) Środek;
2 - Prawo.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Pozycja pionowa 0 desc_v_pos 0 - Góra;
1 - Środek;
2 - (domyślnie) Dół.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Rozmiar 0 desc_size Dozwolone wartości mieszczą się w zakresie od 1 do 100.

Wartość domyślna: 15.
Pogrubienie 0 desc_bold 0 - (domyślnie) Wyłączone;
1 - Włączone.
Kolor 1 desc_color Szesnastkowy kod koloru (np. FF0000).

Wartość domyślna: "" (pusta).
Wartość

Poniższe zaawansowane parametry konfiguracji są obsługiwane, jeśli opcja Pokaż jest ustawiona na „Wartość”.

Parametr type name value
Miejsca dziesiętne
Miejsca dziesiętne 0 decimal_places Możliwe wartości mieszczą się w zakresie od 1 do 10.

Domyślnie: 2.
Rozmiar 0 decimal_size Możliwe wartości mieszczą się w zakresie od 1 do 100.

Domyślnie: 35.
Pozycja
Pozycja pozioma 0 value_h_pos 0 - Lewa;
1 - (domyślnie) Środek;
2 - Prawa.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Pozycja pionowa 0 value_v_pos 0 - Góra;
1 - (domyślnie) Środek;
2 - Dół.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Rozmiar 0 value_size Możliwe wartości mieszczą się w zakresie od 1 do 100.

Domyślnie: 45.
Pogrubienie 0 value_bold 0 - Wyłączone;
1 - (domyślnie) Włączone.
Kolor 1 value_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (pusty).
Jednostki
Jednostki (pole wyboru) 0 units_show 0 - Wyłączone;
1 - (domyślnie) Włączone.
Jednostki (wartość) 1 units Dowolna wartość tekstowa.
Pozycja 0 units_pos 0 - Przed wartością;
1 - Nad wartością;
2 - (domyślnie) Po wartości;
3 - Pod wartością.
Rozmiar 0 units_size Możliwe wartości mieszczą się w zakresie od 1 do 100.

Domyślnie: 35.
Pogrubienie 0 units_bold 0 - Wyłączone;
1 - (domyślnie) Włączone.
Kolor 1 units_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (pusty).
Czas

Poniższe zaawansowane parametry konfiguracji są obsługiwane, jeśli opcja Pokaż jest ustawiona na „Czas”.

Parametr type name value
Pozycja pozioma 0 time_h_pos 0 - Lewo;
1 - (domyślnie) Środek;
2 - Prawo.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Pozycja pionowa 0 time_v_pos 0 - (domyślnie) Góra;
1 - Środek;
2 - Dół.

Dwa lub więcej elementów (Opis, Wartość, Czas) nie może mieć tej samej Pozycji poziomej i Pozycji pionowej.
Rozmiar 0 time_size Dozwolone wartości mieszczą się w zakresie od 1 do 100.

Wartość domyślna: 15.
Pogrubienie 0 time_bold 0 - (domyślnie) Wyłączone;
1 - Włączone.
Kolor 1 time_color Szesnastkowy kod koloru (np. FF0000).

Wartość domyślna: "" (pusta).
Wskaźnik zmiany

Następujące zaawansowane parametry konfiguracji są obsługiwane, jeśli dla opcji Pokaż ustawiono wartość „Wskaźnik zmiany”.

Parametr type name value
Kolor wskaźnika zmiany ↑ 1 up_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (puste).
Kolor wskaźnika zmiany ↓ 1 down_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (puste).
Kolor wskaźnika zmiany ↕ 1 updown_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (puste).
Sparkline

Poniższe zaawansowane parametry konfiguracji są obsługiwane, jeśli dla opcji Show ustawiono wartość „Sparkline”.

Parameter type name value
Width 0 sparkline.width Dozwolone wartości mieszczą się w zakresie od 0 do 10.

Wartość domyślna: 1.
Fill 0 sparkline.fill Dozwolone wartości mieszczą się w zakresie od 0 do 10.

Wartość domyślna: 3.
Color 1 sparkline.color Szesnastkowy kod koloru (np. FF0000).

Wartość domyślna: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - ustaw selektor okresu czasu dashboardu jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widget (z parametrem reference równym ABCDE) jako źródło danych.

Wartość domyślna: DASHBOARD._timeperiod

Alternatywnie możesz ustawić okres czasu wyłącznie w parametrach From i To.
From 1 sparkline.time_period.from Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- wymagany, jeśli ustawiono sparkline.time_period.to
To 1 sparkline.time_period.to Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- wymagany, jeśli ustawiono sparkline.time_period.from
History data 0 sparkline.history 0 - (domyślnie) Automatycznie;
1 - Historia;
2 - Trendy.

Przykłady

Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Wartość pozycji. Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.

Konfigurowanie widżetu Wartość pozycji

Skonfiguruj widżet Wartość pozycji, który wyświetla wartość pozycji dla pozycji „42266” (dostępność agenta Zabbix). Dodatkowo dostosuj wizualnie widżet za pomocą wielu zaawansowanych opcji, w tym dynamicznego koloru tła, który zmienia się w zależności od stanu dostępności agenta Zabbix.

Żądanie:

{
    "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
}

Odpowiedź:

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

Zobacz także