8 Graph

Opis

Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Graph 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 Graph, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Dla widżetu Graph obsługiwane są następujące parametry.

Parametr type name value
Interwał odświeżania 0 rf_rate 0 - Bez odświeżania;
10 - 10 sekund;
30 - 30 sekund;
60 - (domyślnie) 1 minuta;
120 - 2 minuty;
600 - 10 minut;
900 - 15 minut.
Odwołanie 1 reference Dowolna wartość tekstowa składająca się z 5 znaków (np. ABCDE lub JBPNL). Ta wartość musi być unikalna w obrębie pulpitu, do którego należy widżet.

Zachowanie parametru:
- wymagane

Zestaw danych

Poniższe parametry są obsługiwane podczas konfigurowania Zestawu danych.

Pierwsza liczba w nazwie właściwości (np. ds.0.hosts.0, ds.0.items.0) oznacza konkretny zestaw danych, natomiast druga liczba, jeśli występuje, oznacza skonfigurowany host lub pozycja.

Parameter type name value
Typ zestawu danych 0 ds.0.dataset_type 0 - Lista pozycji;
1 - (domyślnie) Wzorce pozycji.
Pozycje 4 ds.0.itemids.0 ID pozycja.

Podczas konfigurowania widżetu na dashboardzie szablonu należy ustawiać tylko pozycje skonfigurowane w szablonie.

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

Zachowanie parametru:
- wymagane jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Pozycje (Widget) nie są ustawione
Pozycje (Widget) 1 ds.0.itemids.0._reference Zamiast ID pozycja:
ABCDE._itemid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla pozycji.

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

Zachowanie parametru:
- wymagane jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Pozycje nie są ustawione
Kolor 1 ds.0.color.0 Szesnastkowy kod koloru (np. FF0000).

Zachowanie parametru:
- wymagane jeśli Typ zestawu danych jest ustawiony na "Lista pozycji"
Wzorce hostów 1 ds.0.hosts.0 Nazwa lub wzorzec host (np. "Zabbix*").

Zachowanie parametru:
- wymagane jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji"

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na dashboardzie szablonu.
Wzorce pozycji 1 ds.0.items.0 Nazwa lub wzorzec pozycja (np. "*: Number of processed *values per second").

Podczas konfigurowania widżetu na dashboardzie szablonu należy ustawiać tylko wzorce dla pozycji skonfigurowanych w szablonie.

Zachowanie parametru:
- wymagane jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji"
Kolor 1 ds.0.color Szesnastkowy kod koloru (np. FF0000).

Zachowanie parametru:
- obsługiwane jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji", a Paleta kolorów nie jest ustawiona
Paleta kolorów 0 ds.0.color_palette Indeks palety kolorów.

Możliwe wartości mieszczą się w zakresie 0-11.

Domyślnie: 0.

Zachowanie parametru:
- obsługiwane jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji", a Kolor nie jest ustawiony
Rysowanie 0 ds.0.type 0 - (domyślnie) Linia;
1 - Punkty;
2 - Schodkowy;
3 - Słupkowy.
Skumulowane 0 ds.0.stacked 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane jeśli Rysowanie jest ustawione na "Linia", "Schodkowy" lub "Słupkowy"
Szerokość 0 ds.0.width Możliwe wartości mieszczą się w zakresie 1-10.

Domyślnie: 1.

Zachowanie parametru:
- obsługiwane jeśli Rysowanie jest ustawione na "Linia" lub "Schodkowy"
Rozmiar punktu 0 ds.0.pointsize Możliwe wartości mieszczą się w zakresie 1-10.

Domyślnie: 3.

Zachowanie parametru:
- obsługiwane jeśli Rysowanie jest ustawione na "Punkty"
Przezroczystość 0 ds.0.transparency Możliwe wartości mieszczą się w zakresie 1-10.

Domyślnie: 5.
Wypełnienie 0 ds.0.fill Możliwe wartości mieszczą się w zakresie 1-10.

Domyślnie: 3.

Zachowanie parametru:
- obsługiwane jeśli Rysowanie jest ustawione na "Linia" lub "Schodkowy"
Brakujące dane 0 ds.0.missingdatafunc 0 - (domyślnie) Brak;
1 - Połączone;
2 - Traktuj jako 0;
3 - Ostatnio znane.

Zachowanie parametru:
- obsługiwane jeśli Rysowanie jest ustawione na "Linia" lub "Schodkowy"
Zastąp host 1 ds.0.override_hostid._reference ABCDE._hostid- ustaw kompatybilny widżet (z parametrem "Reference" ustawionym na "ABCDE") jako źródło danych dla hostów;
DASHBOARD._hostid - ustaw selektor hosta dashboardu jako źródło danych dla hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na dashboardzie szablonu.
Oś Y 0 ds.0.axisy 0 - (domyślnie) Lewa;
1 - Prawa.
Przesunięcie czasu 1 ds.0.timeshift Prawidłowy ciąg czasu (np. 3600, 1h itd.).
Można używać sufiksów czasu. Dozwolone są również wartości ujemne.

Domyślnie: "" (puste).
Funkcja agregacji 0 ds.0.aggregate_function 0 - (domyślnie) nieużywane;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Interwał agregacji 1 ds.0.aggregate_interval Prawidłowy ciąg czasu (np. 3600, 1h itd.).
Można używać sufiksów czasu.

Domyślnie: 1h.
Agreguj 0 ds.0.aggregate_grouping 0 - (domyślnie) Każda pozycja;
1 - Zestaw danych.

Zachowanie parametru:
- obsługiwane jeśli Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first" lub "last"
Przybliżenie 0 ds.0.approximation 1 - min;
2 - (domyślnie) avg;
4 - max;
7 - all.
Etykieta zestawu danych 1 ds.0.data_set_label Dowolna wartość tekstowa.

Domyślnie: "" (puste).

Opcje wyświetlania

Następujące parametry są obsługiwane podczas konfigurowania Opcji wyświetlania.

Parameter type name value
Wybór danych historycznych 0 source 0 - (domyślnie) Automatycznie;
1 - Historia;
2 - Trendy.
Proste wyzwalacze 0 simple_triggers 0 - (domyślnie) Wyłączone;
1 - Włączone.
Czas pracy 0 working_time 0 - (domyślnie) Wyłączone;
1 - Włączone.
Linia percentyla (lewa)
Status 0 percentile_left 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane jeśli Oś Y (w konfiguracji Zestaw danych) jest ustawiona na "Lewa"
Wartość 0 percentile_left_value Dopuszczalne wartości mieszczą się w zakresie 1-100.

Zachowanie parametru:
- obsługiwane jeśli Oś Y (w konfiguracji Zestaw danych) jest ustawiona na "Lewa"
Linia percentyla (prawa)
Status 0 percentile_right 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane jeśli Oś Y (w konfiguracji Zestaw danych) jest ustawiona na "Prawa"
Wartość 0 percentile_right_value Dopuszczalne wartości mieszczą się w zakresie 1-100.

Zachowanie parametru:
- obsługiwane jeśli Oś Y (w konfiguracji Zestaw danych) jest ustawiona na "Prawa"

Okres czasu

Następujące parametry są obsługiwane podczas konfigurowania Okresu czasu.

Parameter type name value
Okres czasu 1 time_period._reference DASHBOARD._timeperiod - ustaw selektor Okres czasu jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widget (z parametrem Reference ustawionym na "ABCDE") jako źródło danych.

Domyślnie: DASHBOARD._timeperiod

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

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

Zachowanie parametru:
- obsługiwany jeśli Okres czasu nie jest ustawiony
- wymagany jeśli time_period.from jest ustawiony

Osie

Następujące parametry są obsługiwane przy konfigurowaniu Osi.

Parametr type name value
Lewe Y 0 lefty 0 - Wyłączone;
1 - (domyślnie) Włączone.

Zachowanie parametru:
- obsługiwane, jeśli Oś Y (w konfiguracji Zbiór danych) jest ustawiona na „Lewa”
Prawe Y 0 righty 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane, jeśli Oś Y (w konfiguracji Zbiór danych) jest ustawiona na „Prawa”
Skala 0 lefty_scale 0 - (domyślnie) Liniowa;
1 - Logarytmiczna.
righty_scale
Min 1 lefty_min Dowolna wartość liczbowa.

Domyślnie: "" (puste).
righty_min
Max 1 lefty_max Dowolna wartość liczbowa.

Domyślnie: "" (puste).
righty_max
Jednostki (typ) 0 lefty_units 0 - (domyślnie) Auto;
1 - Statyczne.
righty_units
Jednostki (wartość) 1 lefty_static_units Dowolna wartość tekstowa.

Domyślnie: "" (puste).
righty_static_units
Oś X 0 xaxis 0 - Wyłączona;
1 - (domyślnie) Włączona.

Legenda

Następujące parametry są obsługiwane podczas konfigurowania Legend.

Parameter type name value
Pokaż legendę 0 legend 0 - Wyłączone;
1 - (domyślnie) Włączone.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone"
Wyświetl min./śr./maks. 0 legend_statistic 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone"
Pokaż funkcję agregacji 0 legend_aggregation 0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone"
Wiersze 0 legend_lines_mode 0 - (domyślnie) Stałe;
1 - Zmienne.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone"
Liczba wierszy/
Maksymalna liczba wierszy
0 legend_lines Dostępne wartości mieszczą się w zakresie 1-10.

Domyślnie: 1.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone"
Liczba kolumn 0 legend_columns Dostępne wartości mieszczą się w zakresie 1-4.

Domyślnie: 4.

Zachowanie parametru:
- obsługiwane jeśli Pokaż legendę jest ustawione na "Włączone" oraz Wyświetl min./śr./maks. jest ustawione na "Wyłączone"

Problemy

Następujące parametry są obsługiwane przy konfigurowaniu Problemów.

Parametr type name value
Pokaż problemy 0 show_problems 0 - (domyślnie) Wyłączone;
1 - Włączone.
Tylko wybrane pozycje 0 graph_item_problems 0 - Wyłączone;
1 - (domyślnie) Włączone.
Hosty problemów 1 problemhosts.0 Nazwa hosta.

Uwaga: Liczba w nazwie właściwości odnosi się do skonfigurowanego hosta.
Aby skonfigurować wiele hostów, utwórz obiekt pola widżetu pulpitu dla każdego hosta z kolejnym numerem w nazwie właściwości.

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu.
Poziom ważności 0 severities.0 0 - Niesklasyfikowane;
1 - Informacja;
2 - Ostrzeżenie;
3 - Średni;
4 - Wysoki;
5 - Katastrofa.

Domyślnie: puste (wszystkie włączone).

Uwaga: Aby skonfigurować wiele wartości, utwórz obiekt pola widżetu pulpitu dla każdej wartości z kolejnym numerem w nazwie właściwości.
Problem 1 problem_name Nazwa zdarzenia problemu (bez rozróżniania wielkości liter, pełna nazwa lub jej część).
Tagi problemu
Typ oceny 0 evaltype 0 - (domyślnie) And/Or;
2 - Or.
Nazwa tagu 1 tags.0.tag Dowolna wartość tekstowa.

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

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

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

Zachowanie parametru:
- wymagane podczas konfigurowania Tagów problemu
Wartość tagu 1 tags.0.value Dowolna wartość tekstowa.

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

Zachowanie parametru:
- wymagane podczas konfigurowania Tagów problemu

Nadpisywanie

Następujące parametry są obsługiwane podczas konfigurowania Nadpisywania.

Pierwsza liczba w nazwie właściwości (np. or.0.hosts.0, or.0.items.0) reprezentuje określony zestaw danych, natomiast druga liczba, jeśli występuje, reprezentuje skonfigurowany host lub pozycję.

Parameter type name value
Wzorce hostów 1 or.0.hosts.0 Nazwa lub wzorzec host (np. Zabbix*).

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na szablonowym dashboardzie.

Zachowanie parametru:
- wymagany podczas konfigurowania Nadpisywania
Wzorce pozycji 1 or.0.items.0 Nazwa lub wzorzec pozycja (np. *: Number of processed *values per second).
Podczas konfigurowania widżetu na szablonowym dashboardzie należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie.

Zachowanie parametru:
- wymagany podczas konfigurowania Nadpisywania
Kolor bazowy 1 or.0.color Szesnastkowy kod koloru (np. FF0000).
Szerokość 0 or.0.width Dopuszczalne wartości: 1-10.
Rysuj 0 or.0.type 0 - Linia;
1 - Punkty;
2 - Schodkowy;
3 - Słupek.
Przezroczystość 0 or.0.transparency Dopuszczalne wartości: 1-10.
Wypełnienie 0 or.0.fill Dopuszczalne wartości: 1-10.
Rozmiar punktu 0 or.0.pointsize Dopuszczalne wartości: 1-10.
Brakujące dane 0 or.0.missingdatafunc 0 - Brak;
1 - Połączone;
2 - Traktuj jako 0;
3 - Ostatnio znane.
Oś Y 0 or.0.axisy 0 - Lewa;
1 - Prawa.
Przesunięcie czasu 1 or.0.timeshift Prawidłowy ciąg czasu (np. 3600, 1h itd.).
Możesz używać sufiksów czasu. Dozwolone są wartości ujemne.

Przykłady

Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Graph. Aby uzyskać więcej informacji na temat konfiguracji pulpitu, zobacz dashboard.create.

Konfigurowanie widżetu Graph

Skonfiguruj widżet Graph w następujący sposób:

  • 2 zestawy danych dla łącznie 9 pozycji na 1 hoście.
  • Pierwszy zestaw danych jest typu „Item list” i składa się z 3 pozycji, które są reprezentowane przez linie o różnych kolorach, ale tej samej szerokości, przezroczystości i wypełnieniu.
  • Drugi zestaw danych jest typu „Item patterns”, składa się z 6 pozycji, ma skonfigurowaną agregację i jest reprezentowany przez linię z niestandardowym kolorem, szerokością, przezroczystością i wypełnieniem.
  • Drugi zestaw danych ma również niestandardową etykietę zestawu danych.
  • Dane na wykresie są wyświetlane dla okresu ostatnich 3 godzin.
  • Problemy na wykresie są wyświetlane tylko dla skonfigurowanych pozycji.
  • Wykres ma dwie osie Y, z których prawa oś Y wyświetla wartości tylko dla drugiego zestawu danych.
  • Legenda wykresu wyświetla skonfigurowane pozycje w 4 wierszach, a także minimalne, maksymalne i średnie wartości zestawów danych.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "svggraph",
                        "name": "Graph",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "ds.0.dataset_type",
                                "value": 0
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.0",
                                "value": 23264
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.0",
                                "value": "FF0000"
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.1",
                                "value": 23269
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.1",
                                "value": "BF00FF"
                            },
                            {
                                "type": 4,
                                "name": "ds.0.itemids.2",
                                "value": 23257
                            },
                            {
                                "type": 1,
                                "name": "ds.0.color.2",
                                "value": "0040FF"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.width",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.transparency",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.0.fill",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.hosts.0",
                                "value": "Zabbix server"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.items.0",
                                "value": "*: Number of processed *values per second"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.color",
                                "value": "000000"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.transparency",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.fill",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.1.axisy",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_function",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "ds.1.aggregate_interval",
                                "value": "1m"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.aggregate_grouping",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.data_set_label",
                                "value": "Number of processed values per second"
                            },
                            {
                                "type": 0,
                                "name": "graph_time",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_period.from",
                                "value": "now-3h"
                            },
                            {
                                "type": 1,
                                "name": "time_period.to",
                                "value": "now"
                            },
                            {
                                "type": 0,
                                "name": "legend_statistic",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "legend_lines",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show_problems",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "YZABC"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Odpowiedź:

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

Zobacz także