11 Honeycomb

Opis

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

Właściwości fields widgetu nie są walidowane podczas tworzenia ani aktualizacji dashboardu. 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 aktualizację widgetu Honeycomb, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Następujące parametry są obsługiwane dla widgetu Honeycomb.

Parameter type name value
Refresh interval 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.
Host groups 2 groupids.0 ID grupy hostów.

Uwaga: Aby skonfigurować wiele grup hostów, utwórz obiekt pola widgetu dashboardu dla każdej grupy hostów, zwiększając numer w nazwie właściwości.

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Host groups (Widget) 1 groupids._reference Zamiast ID grupy hostów:
ABCDE._hostgroupids - ustaw kompatybilny widget (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla grup hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Hosts 3 hostids.0 ID hosta.

Uwaga: Aby skonfigurować wiele hostów, utwórz obiekt pola widgetu dashboardu dla każdego hosta, zwiększając numer w nazwie właściwości. W przypadku wielu hostów parametr Host groups musi być albo w ogóle nie skonfigurowany, albo skonfigurowany z co najmniej jedną grupą hostów, do której należą skonfigurowane hosty.

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Hosts (Widget/Dashboard) 1 hostids._reference Zamiast ID hosta:
DASHBOARD.hostids - ustaw selektor Host jako źródło danych dla hostów;
ABCDE._hostids - ustaw kompatybilny widget (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Host tags
Evaluation type 0 evaltype_host 0 - (domyślnie) And/Or;
2 - Or.

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Tag name 1 host_tags.0.tag Dowolna wartość tekstowa.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Host tags

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Operator 0 host_tags.0.operator 0 - Zawiera;
1 - Równa się;
2 - Nie zawiera;
3 - Nie równa się;
4 - Istnieje;
5 - Nie istnieje.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Host tags

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Tag value 1 host_tags.0.value Dowolna wartość tekstowa.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Host tags

Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu.
Item patterns 1 items.0 Nazwa lub wzorzec pozycji.

Uwaga: Aby skonfigurować wiele wzorców pozycji, utwórz obiekt pola widgetu dashboardu dla każdego wzorca pozycji, zwiększając numer w nazwie właściwości.

Zachowanie parametru:
- wymagane
Item tags
Evaluation type 0 evaltype_item 0 - (domyślnie) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag Dowolna wartość tekstowa.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Item tags
Operator 0 item_tags.0.operator 0 - Zawiera;
1 - Równa się;
2 - Nie zawiera;
3 - Nie równa się;
4 - Istnieje;
5 - Nie istnieje.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Item tags
Tag value 1 item_tags.0.value Dowolna wartość tekstowa.

Uwaga: Numer w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów.

Zachowanie parametru:
- wymagane podczas konfigurowania Item tags
Show hosts in maintenance 0 maintenance 0 - (domyślnie) Wyłączone;
1 - Włączone.
Show 0 show.0 1 - Etykieta główna;
2 - Etykieta pomocnicza.

Uwaga: Aby skonfigurować wiele wartości, utwórz obiekt pola widgetu dashboardu dla każdej wartości, zwiększając numer w nazwie właściwości.

Domyślnie: 1, 2.
Reference 1 reference Dowolna wartość tekstowa składająca się z 5 znaków (np. ABCDE lub JBPNL). Wartość ta musi być unikalna w obrębie dashboardu, do którego należy widget.

Zachowanie parametru:
- wymagane

Zaawansowana konfiguracja

Następujące zaawansowane parametry konfiguracji są obsługiwane dla widżetu Honeycomb.

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

Parameter type name value
Primary label
Type 0 primary_label_type 0 - (domyślnie) Tekst;
1 - Wartość.
Text 1 primary_label Dowolna wartość tekstowa, w tym makra.
Obsługiwane makra: {HOST.*}, {ITEM.*}, {INVENTORY.*}, makra użytkownika.

Domyślnie: {HOST.NAME}

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Text"
Decimal places 0 primary_label_decimal_places Zakres możliwych wartości: 0-6.

Domyślnie: 2.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value"
Size (type) 0 primary_label_size_type 0 - (domyślnie) Automatyczny;
1 - Niestandardowy.
Size 0 primary_label_size Zakres możliwych wartości: 1-100.

Domyślnie: 20.

Zachowanie parametru:
- obsługiwany, jeśli Size (type) jest ustawione na "Custom"
Bold 0 primary_label_bold 0 - (domyślnie) Wyłączone;
1 - Włączone.
Color 1 primary_label_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: na podstawie theme obiektu Settings object i User object:
1F2C33 dla "blue-theme" lub "hc-light";
EEEEEE dla "dark-theme" lub "hc-dark".
Units (checkbox) 0 primary_label_units_show 0 - Wyłączone;
1 - (domyślnie) Włączone.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value"
Units (value) 1 primary_label_units Dowolna wartość tekstowa.

"" (puste)

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value" i Units (checkbox) jest ustawione na "Enabled"
Position 0 primary_label_units_pos 0 - Przed wartością;
1 - (domyślnie) Po wartości.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value" i Units (checkbox) jest ustawione na "Enabled"

Ten parametr jest ignorowany, jeśli zostanie ustawiony na jedną z następujących jednostek związanych z czasem: unixtime, uptime, s.
Secondary label
Type 0 secondary_label_type 0 - Tekst;
1 - (domyślnie) Wartość.
Text 1 secondary_label Dowolna wartość tekstowa, w tym makra.
Obsługiwane makra: {HOST.*}, {ITEM.*}, {INVENTORY.*}, makra użytkownika.

Domyślnie: {{ITEM.LASTVALUE}.fmtnum(2)}

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Text"
Decimal places 0 secondary_label_decimal_places Zakres możliwych wartości: 0-6.

Domyślnie: 2.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value"
Size (type) 0 secondary_label_size_type 0 - (domyślnie) Automatyczny;
1 - Niestandardowy.
Size 0 secondary_label_size Zakres możliwych wartości: 1-100.

Domyślnie: 30.

Zachowanie parametru:
- obsługiwany, jeśli Size (type) jest ustawione na "Custom"
Bold 0 secondary_label_bold 0 - Wyłączone;
1 - (domyślnie) Włączone.
Color 1 secondary_label_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: na podstawie theme obiektu Settings object i User object:
1F2C33 dla "blue-theme" lub "hc-light";
EEEEEE dla "dark-theme" lub "hc-dark".
Units (checkbox) 0 secondary_label_units_show 0 - Wyłączone;
1 - (domyślnie) Włączone.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value"
Units (value) 1 secondary_label_units Dowolna wartość tekstowa.

"" (puste)

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value" i Units (checkbox) jest ustawione na "Enabled"
Position 0 secondary_label_position 0 - Przed wartością;
1 - (domyślnie) Po wartości.

Zachowanie parametru:
- obsługiwany, jeśli Type jest ustawione na "Value" i Units (checkbox) jest ustawione na "Enabled"

Ten parametr jest ignorowany, jeśli zostanie ustawiony na jedną z następujących jednostek związanych z czasem: unixtime, uptime, s.
Background color
Background color 1 bg_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: na podstawie theme obiektu Settings object i User object:
D9E7ED dla "blue-theme";
3D5059 dla "dark-theme";
AAD7E9 dla "hc-light";
335463 dla "hc-dark".
Thresholds
Color interpolation 0 interpolation 0 - Wyłączone;
1 - (domyślnie) Włączone.
Color 1 thresholds.0.color Szesnastkowy kod koloru (np. FF0000).
Threshold 1 thresholds.0.threshold Dowolna wartość liczbowa. Obsługiwane są przyrostki (np. "1d", "2w", "4K", "8G").

Przykłady

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

Konfigurowanie widżetu Honeycomb

Skonfiguruj widżet Honeycomb, który wyświetla wykorzystanie procesów serwera Zabbix. Dodatkowo zmień główną etykietę komórek honeycomb i dostrój wizualnie widżet za pomocą progów.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "honeycomb",
                        "name": "Honeycomb",
                        "x": "0",
                        "y": "0",
                        "width": "24",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "items.0",
                                "value": "Zabbix server: Utilization*"
                            },
                            {
                                "type": 1,
                                "name": "primary_label",
                                "value": "{ITEM.NAME}"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "70"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "KSTMQ"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Odpowiedź:

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

Zobacz także