25 Wykres punktowy
Opis
Te parametry oraz możliwe wartości właściwości odpowiednich obiektów pól widgetu pulpitu nawigacyjnego umożliwiają skonfigurowanie widgetu Wykres punktowy w metodach dashboard.create i dashboard.update.
Właściwości fields widgetu nie są sprawdzane podczas tworzenia ani aktualizowania pulpitu nawigacyjnego.
Umożliwia to użytkownikom modyfikowanie wbudowanych widgetów i tworzenie niestandardowych widgetów, ale wiąże się również z ryzykiem nieprawidłowego utworzenia lub zaktualizowania widgetów.
Aby zapewnić pomyślne utworzenie lub zaktualizowanie widgetu Wykres punktowy, zapoznaj się z opisanym w poniższych tabelach działaniem parametrów.
Parametry
Następujące parametry są obsługiwane dla widżetu Scatter plot.
| Parametr | type | nazwa | wartość |
|---|---|---|---|
| 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. |
| 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 dashboardu, do którego należy widżet.Zachowanie parametru: - wymagane |
Zestaw danych
Następujące parametry są obsługiwane przy konfigurowaniu 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 pozycję.
| Parametr | < | type | name | value | |
|---|---|---|---|---|---|
| Typ zestawu danych | < | 0 | ds.0.dataset_type | 0 - Lista pozycji; 1 - (domyślnie) Wzorce pozycji. |
|
| Zestaw danych: Lista pozycji | < | < | < | ||
| Kolor | < | 1 | ds.0.color.0 | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji" |
|
| Oś X | < | 4 | ds.0.x_axis_itemids.0 | ID pozycji. Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko pozycje skonfigurowane w szablonie. Uwaga: Aby skonfigurować wiele pozycji, utwórz obiekt pola widżetu pulpitu dla każdej pozycji z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Oś X (Widżet) nie jest ustawiona |
|
| Oś X (Widżet) | < | 1 | ds.0.x_axis_itemids.0._reference | Zamiast ID pozycji: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 pulpitu dla każdego widżetu z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Oś X nie jest ustawiona |
|
| Oś Y | < | 4 | ds.0.y_axis_itemids.0 | ID pozycji. Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko pozycje skonfigurowane w szablonie. Uwaga: Aby skonfigurować wiele pozycji, utwórz obiekt pola widżetu pulpitu dla każdej pozycji z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Oś Y (Widżet) nie jest ustawiona |
|
| Oś Y (Widżet) | < | 1 | ds.0.y_axis_itemids.0._reference | Zamiast ID pozycji: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 pulpitu dla każdego widżetu z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Lista pozycji", a Oś Y nie jest ustawiona |
|
| Nadpisz 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 pulpitu jako źródło danych dla hostów.Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Zestaw danych: Wzorce pozycji | < | < | < | ||
| Kolor | < | 1 | ds.0.color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwany, 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żliwy zakres wartości: 0-11. Domyślnie: 0. Zachowanie parametru: - obsługiwany, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji", a Kolor nie jest ustawiony |
|
| Wzorce hostów | < | 1 | ds.0.hosts.0 | Nazwa lub wzorzec hosta (np. "Zabbix*"). Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji" Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Wzorce pozycji osi X | < | 1 | ds.0.x_axis_items.0 | Nazwa lub wzorzec pozycji (np. "*: Number of processed *values per second"). Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji" |
|
| Wzorce pozycji osi Y | < | 1 | ds.0.y_axis_items.0 | Nazwa lub wzorzec pozycji (np. "*: Number of processed *values per second"). Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie. Zachowanie parametru: - wymagany, jeśli Typ zestawu danych jest ustawiony na "Wzorce pozycji" |
|
| Grupy hostów | < | 2 | groupids.0 | ID grupy hostów. Uwaga: Aby skonfigurować wiele grup hostów, utwórz obiekt pola widżetu pulpitu dla każdej grupy hostów z inkrementowanym numerem w nazwie właściwości. Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Grupy hostów (Widżet) | < | 1 | groupids._reference | Zamiast ID grupy hostów:ABCDE._hostgroupids - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla grup hostów.Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Nadpisz 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 pulpitu jako źródło danych dla hostów.Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Tagi hosta | < | < | < | < | |
| < | Typ oceny | 0 | evaltype_host | 0 - (domyślnie) And/Or; 2 - Or. Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| ^ | Nazwa tagu | 1 | host_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: - wymagany przy konfigurowaniu Tagów hosta Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie 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: Liczba w nazwie właściwości odnosi się do kolejności tagu na liście oceny tagów. Zachowanie parametru: - wymagany przy konfigurowaniu Tagów hosta Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| ^ | Wartość tagu | 1 | host_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: - wymagany przy konfigurowaniu Tagów hosta Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Znacznik | < | 0 | ds.0.marker | 0 - (domyślnie) Elipsa; 1 - Kwadrat; 2 - Trójkąt; 3 - Romb; 4 - Gwiazda; 5 - Krzyżyk. |
|
| Rozmiar znacznika | < | 0 | ds.0.marker_size | 0 - (domyślnie) Mały (6px); 1 - Średni (9px); 2 - Duży (15px). |
|
| Przesunięcie czasu | < | 1 | ds.0.timeshift | Prawidłowy ciąg czasu (np. 3600, 1h itd.).Możesz używać sufiksów czasu. Dozwolone są również wartości ujemne. Domyślnie: "" (puste). |
|
| Interwał agregacji | < | 1 | ds.0.aggregate_interval | Prawidłowy ciąg czasu (np. 3600, 1h itd.).Możesz używać sufiksów czasu. Domyślnie: 15m. |
|
| Funkcja agregacji | < | 0 | ds.0.aggregate_function | 0 - nieużywane; 1 - min; 2 - max; 3 - (domyślnie) avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
Opcje wyświetlania
Następujące parametry są obsługiwane przy konfigurowaniu Opcji wyświetlania.
| Parametr | type | name | value |
|---|---|---|---|
| Wybór danych historycznych | 0 | source | 0 - (domyślnie) Auto; 1 - Historia; 2 - Trendy. |
| Nazwy hostów na etykietach | 0 | show_hostnames | 0 - (domyślnie) Auto; 1 - Pokaż; 2 - Ukryj. Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na dashboardzie szablonu. |
Okres czasu
Następujące parametry są obsługiwane przy konfigurowaniu Okresu czasu.
| Parametr | type | name | value | |
|---|---|---|---|---|
| Okres czasu | 1 | time_period._reference | DASHBOARD._timeperiod — ustaw selektor okresu czasu pulpitu jako źródło danych;ABCDE._timeperiod — ustaw kompatybilny widget (z parametrem Reference ustawionym na "ABCDE") jako źródło danych.Domyślnie: DASHBOARD._timeperiodAlternatywnie można ustawić okres czasu tylko w parametrach Od i Do. |
|
| 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 - 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 - wymagany, jeśli ustawiono time_period.from |
|
Osie
Następujące parametry są obsługiwane do konfiguracji Osi.
| Parametr | type | name | value |
|---|---|---|---|
| Oś X | 0 | x_axis | 0 - Wyłączona; 1 - (domyślnie) Włączona. |
| Oś Y | 0 | y_axis | 0 - (domyślnie) Wyłączona; 1 - Włączona. |
| Min | 1 | x_axis_min | Dowolna wartość liczbowa. Domyślnie: "" (puste). |
| y_axis_min | |||
| Max | 1 | x_axis_max | Dowolna wartość liczbowa. Domyślnie: "" (puste). |
| y_axis_max | |||
| Jednostki (typ) | 0 | x_axis_units | 0 - (domyślnie) Automatycznie; 1 - Statyczne. |
| y_axis_units | |||
| Jednostki (wartość) | 1 | x_axis_static_units | Dowolna wartość tekstowa. Domyślnie: "" (puste). |
| y_axis_static_units |
Legenda
Następujące parametry są obsługiwane przy konfigurowaniu Legendy.
| Parametr | type | name | value |
|---|---|---|---|
| Pokaż legendę | 0 | legend | 0 - Wyłączone; 1 - (domyślnie) 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 | Możliwe wartości z zakresu: 1-10. Domyślnie: 1. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na „Włączone” |
| Liczba kolumn | 0 | legend_columns | Możliwe wartości z zakresu: 1-4. Domyślnie: 4. Zachowanie parametru: - obsługiwane, jeśli Pokaż legendę jest ustawione na „Włączone” |
Progi
Następujące parametry są obsługiwane do konfigurowania Progów.
Liczba w nazwie właściwości Thresholds (np. thresholds.0.color) odnosi się do miejsca 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 frontendzie Zabbix
(np. "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").
| Parametr | type | name | value |
|---|---|---|---|
| Interpolacja kolorów | 0 | interpolation | 0 - (domyślnie) Wyłączona; 1 - Włączona. |
| Kolor | 1 | thresholds.0.color | Szesnastkowy kod koloru (np. FF0000). |
| Oś X | 1 | thresholds.0.x_axis_threshold | Dowolna wartość liczbowa. Obsługiwane są sufiksy (np. "1d", "2w", "4K", "8G"). |
| Oś Y | 1 | thresholds.0.y_axis_threshold | Dowolna wartość liczbowa. Obsługiwane są sufiksy (np. "1d", "2w", "4K", "8G"). |
Przykłady
Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widgetu pulpitu dla widgetu Scatter plot.
Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.
Konfigurowanie widżetu Scatter plot
Skonfiguruj widżet Scatter plot w następujący sposób:
- 5 zestawów danych typu „Wzorce pozycji”, każdy z domyślną agregacją (avg, 15m) i różnymi znacznikami.
- Legenda wyświetla skonfigurowane pozycje w jednym wierszu i dwóch kolumnach.
- Progi są skonfigurowane tak, aby kolor znacznika zmieniał się na czerwony, gdy jego wartość osiągnie 80 na dowolnej osi.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "scatterplot",
"name": "Scatter plot",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.0.color",
"value": "0C5A87"
},
{
"type": 1,
"name": "ds.0.hosts.0",
"value": "de-frankfurt*"
},
{
"type": 1,
"name": "ds.0.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.0.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.0.marker",
"value": 0
},
{
"type": 0,
"name": "ds.0.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.1.color",
"value": "66B0D9"
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "fr-paris*"
},
{
"type": 1,
"name": "ds.1.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.1.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.1.marker",
"value": 1
},
{
"type": 0,
"name": "ds.1.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.2.color",
"value": "0A466A"
},
{
"type": 1,
"name": "ds.2.hosts.0",
"value": "lv-riga*"
},
{
"type": 1,
"name": "ds.2.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.2.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.2.marker",
"value": 2
},
{
"type": 0,
"name": "ds.2.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.3.color",
"value": "3394C3"
},
{
"type": 1,
"name": "ds.3.hosts.0",
"value": "pl-warsaw*"
},
{
"type": 1,
"name": "ds.3.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.3.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.3.marker",
"value": 3
},
{
"type": 0,
"name": "ds.3.marker_size",
"value": 1
},
{
"type": 1,
"name": "ds.4.color",
"value": "1492C8"
},
{
"type": 1,
"name": "ds.4.hosts.0",
"value": "se-stockholm*"
},
{
"type": 1,
"name": "ds.4.x_axis_items.0",
"value": "Memory utilization"
},
{
"type": 1,
"name": "ds.4.y_axis_items.0",
"value": "CPU utilization"
},
{
"type": 0,
"name": "ds.4.marker",
"value": 4
},
{
"type": 0,
"name": "ds.4.marker_size",
"value": 1
},
{
"type": 0,
"name": "legend_columns",
"value": 2
},
{
"type": 0,
"name": "interpolation",
"value": 1
},
{
"type": 1,
"name": "thresholds.0.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.0.x_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "thresholds.0.y_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.color",
"value": "D40000"
},
{
"type": 1,
"name": "thresholds.1.x_axis_threshold",
"value": ""
},
{
"type": 1,
"name": "thresholds.1.y_axis_threshold",
"value": "80"
},
{
"type": 1,
"name": "reference",
"value": "JQISY"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}