On this page
28 Najważniejsze hosty
Opis
Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają konfigurację widgetu Top hosts 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 aktualizację widgetu Top hosts, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.
Parametry
Poniższe parametry są obsługiwane przez widget Najlepsze hosty.
| 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. |
|
| Grupy hostów | 2 | groupids.0 | Identyfikator 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. |
|
| Grupy hostów (widget) | 1 | groupids._reference | Zamiast identyfikatora grupy hostów:ABCDE._hostgroupids - ustaw zgodny 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. |
|
| Hosty | 3 | hostids.0 | Identyfikator 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 Grupy hostów musi być całkowicie nieskonfigurowany 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. |
|
| Hosty (widget/dashboard) | 1 | hostids._reference | Zamiast identyfikatora hosta:DASHBOARD.hostids - ustaw dashboardowy selektor hostów jako źródło danych dla hostów;ABCDE._hostids - ustaw zgodny 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. |
|
| Tagi hostów | ||||
| Typ oceny | 0 | evaltype | 0 - (domyślnie) And/Or; 2 - Or. Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu. |
|
| Nazwa tagu | 1 | tags.0.tag | Dowolna wartość tekstowa. Uwaga: Numer w nazwie właściwości wskazuje kolejność tagu na liście oceny tagów. Zachowanie parametru: - wymagany podczas konfigurowania Tagów hostów Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu. |
|
| Operator | 0 | tags.0.operator | 0 - Zawiera; 1 - Jest równe; 2 - Nie zawiera; 3 - Nie jest równe; 4 - Istnieje; 5 - Nie istnieje. Uwaga: Numer w nazwie właściwości wskazuje kolejność tagu na liście oceny tagów. Zachowanie parametru: - wymagany podczas konfigurowania Tagów hostów Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu. |
|
| Wartość tagu | 1 | tags.0.value | Dowolna wartość tekstowa. Uwaga: Numer w nazwie właściwości wskazuje kolejność tagu na liście oceny tagów. Zachowanie parametru: - wymagany podczas konfigurowania Tagów hostów Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu. |
|
| Pokaż hosty w konserwacji | 0 | maintenance | 0 - (domyślnie) Wyłączone; 1 - Włączone. |
|
| Kolumny (patrz poniżej) | ||||
| Sortuj według | 0 | column | Wartość liczbowa kolumny spośród skonfigurowanych kolumn. | |
| Kolejność | 0 | order | 2 - (domyślnie) Najlepsze N; 3 - Najgorsze N. |
|
| Limit hostów | 0 | show_lines | Dozwolone wartości mieszczą się w zakresie od 1 do 1000. Wartość domyślna: 10. Ten parametr nie jest obsługiwany podczas konfigurowania widgetu na dashboardzie szablonu. |
|
Kolumny
Kolumny posiadają wspólne parametry oraz dodatkowe parametry w zależności od konfiguracji parametru Data.
Dla wszystkich parametrów związanych z kolumnami, liczba w nazwie właściwości (np. columns.name.0) odnosi się do kolumny, dla której parametr jest skonfigurowany.
Następujące parametry są obsługiwane dla wszystkich kolumn.
| Parametr | type | name | value |
|---|---|---|---|
| Nazwa | 1 | columns.0.name | Dowolna wartość tekstowa. Zachowanie parametru: - wymagany |
| Dane | 0 | columns.0.data | 1 - Wartość pozycji; 2 - Nazwa hosta; 3 - Tekst. Zachowanie parametru: - wymagany |
| Kolor bazowy | 1 | columns.0.base_color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - wymagany |
Wartość pozycji
Poniższe parametry są obsługiwane, jeśli dla Data ustawiono wartość „Item value”.
Pierwsza liczba w nazwie właściwości Thresholds (np. columnsthresholds.0.color.0) odwołuje się do kolumny, dla której skonfigurowano progi, natomiast druga liczba odwołuje się do miejsca progu na liście posortowanej rosnąco.
Jeśli jednak progi zostaną skonfigurowane w innej kolejności, po zaktualizowaniu konfiguracji widżetu w frontend Zabbix wartości zostaną posortowane rosnąco (np. "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parametr | type | name | value | |
|---|---|---|---|---|
| Pozycja | 1 | columns.0.item | Prawidłowa nazwa pozycji. Podczas konfigurowania widżetu na pulpicie nawigacyjnym szablonu należy ustawić wyłącznie pozycje skonfigurowane na szablonie. |
|
| Wyświetlaj wartość pozycji jako | 0 | columns.0.display_value_as | 0 - (domyślnie) Liczbowa; 1 - Tekstowa; 2 - Binarna. |
|
| Wyświetlanie | 0 | columns.0.display | 1 - (domyślnie) Bez zmian; 2 - Pasek; 3 - Wskaźniki; 6 - Sparkline. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric” |
|
| Min | 1 | columns.0.min | Dowolna wartość liczbowa. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Bar” lub „Indicators” |
|
| Maks. | 1 | columns.0.max | Dowolna wartość liczbowa. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Bar” lub „Indicators” |
|
| Miejsca dziesiętne | 0 | columns.0.decimal_places | Możliwe wartości mieszczą się w zakresie od 0 do 10. Wartość domyślna: 2. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric” |
|
| Sparkline | ||||
| Szerokość | 0 | columns.0.sparkline.width | Możliwe wartości mieszczą się w zakresie od 0 do 10. Wartość domyślna: 1. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” |
|
| Wypełnienie | 0 | columns.0.sparkline.fill | Możliwe wartości mieszczą się w zakresie od 0 do 10. Wartość domyślna: 3. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” |
|
| Kolor | 1 | columns.0.sparkline.color | Szesnastkowy kod koloru (np. FF0000).Wartość domyślna: 42A5F5.Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” |
|
| Okres | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - ustaw selektor okresu pulpitu nawigacyjnego jako źródło danych;ABCDE._timeperiod - ustaw zgodny widżet (z parametrem reference równym ABCDE) jako źródło danych.Wartość domyślna: DASHBOARD._timeperiodAlternatywnie można ustawić okres wyłącznie za pomocą parametrów Od i Do. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” |
|
| Od | 1 | columns.0.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: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” - wymagane, jeśli ustawiono columns.0.sparkline.time_period.to |
|
| Do | 1 | columns.0.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: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” - wymagane, jeśli ustawiono columns.0.sparkline.time_period.from |
|
| Dane historyczne | 0 | columns.0.sparkline.history | 0 - (domyślnie) Automatycznie; 1 - Historia; 2 - Trendy. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric”, a dla Wyświetlanie ustawiono „Sparkline” |
|
| Progi | ||||
| Kolor | 1 | columnsthresholds.0.color.0 | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric” |
|
| Próg | 1 | columnsthresholds.0.threshold.0 | Dowolna wartość tekstowa. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric” |
|
| Wyróżnienia | ||||
| Kolor | 1 | columns.0.highlights.0.color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Text” |
|
| Wzorzec | 1 | columns.0.highlights.0.pattern | Dowolna wartość tekstowa. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Text” |
|
| Pokaż miniaturę | 0 | columns.0.show_thumbnail | 0 - (domyślnie) Wyłączone; 1 - Włączone. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Binary” |
|
| Funkcja agregująca | 0 | columns.0.aggregate_function | 0 - (domyślnie) nieużywana; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Okres | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - ustaw selektor okresu pulpitu nawigacyjnego jako źródło danych;ABCDE._timeperiod - ustaw zgodny widżet (z parametrem reference równym ABCDE) jako źródło danych.Wartość domyślna: DASHBOARD._timeperiodAlternatywnie można ustawić okres wyłącznie za pomocą parametrów Od i Do. Zachowanie parametru: - obsługiwane, jeśli dla Funkcja agregująca ustawiono „min”, „max”, „avg”, „count”, „sum”, „first” lub „last” |
|
| Od | 1 | columns.0.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ługiwane, jeśli nie ustawiono Okres, a dla Funkcja agregująca ustawiono „min”, „max”, „avg”, „count”, „sum”, „first” lub „last” - wymagane, jeśli ustawiono columns.0.time_period.to |
|
| Do | 1 | columns.0.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ługiwane, jeśli nie ustawiono Okres, a dla Funkcja agregująca ustawiono „min”, „max”, „avg”, „count”, „sum”, „first” lub „last” - wymagane, jeśli ustawiono columns.0.time_period.from |
|
| Dane historyczne | 0 | columns.0.history | 0 - (domyślnie) Automatycznie; 1 - Historia; 2 - Trendy. Zachowanie parametru: - obsługiwane, jeśli dla Wyświetlaj wartość pozycji jako ustawiono „Numeric” |
|
| Odwołanie | 1 | reference | Dowolna wartość tekstowa składająca się z 5 znaków (np. ABCDE lub JBPNL). Wartość musi być unikatowa w obrębie pulpitu nawigacyjnego, do którego należy widżet.Zachowanie parametru: - wymagane |
|
Tekst
Następujące parametry są obsługiwane, jeśli Data jest ustawione na "Text".
| Parameter | type | name | value |
|---|---|---|---|
| Text | 1 | columns.0.text | Dowolna wartość tekstowa, w tym makra. Obsługiwane makra: {HOST.*}, {INVENTORY.*}.Zachowanie parametru: - wymagane, jeśli Data jest ustawione na "Text" |
Przykłady
Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Top hosts.
Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.
Konfigurowanie widżetu Top hosts
Skonfiguruj widżet Top hosts, który wyświetla hosty o najwyższym wykorzystaniu CPU w grupie hostów „4”. Dodatkowo skonfiguruj następujące niestandardowe kolumny: „Nazwa hosta”, „Wykorzystanie CPU w %”, „Średnia 1m”, „Średnia 5m”, „Średnia 15m”, „Procesy”.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}