Documentation
Table of Contents
21 TOP hosty
Opis
Te parametry i możliwe wartości właściwości dla odpowiednich obiektów pola widżetu pulpitu pozwalają skonfigurować widżet TOP hosty w metodach dashboard.create i dashboard.update.
Właściwości widżetu fields nie są walidowane podczas tworzenia lub aktualizacji pulpitu. Pozwala to użytkownikom modyfikować wbudowane widżety i tworzyć niestandardowe widżety, ale wprowadza również ryzyko nieprawidłowego tworzenia lub aktualizacji widżetów. Aby zapewnić pomyślne utworzenie lub aktualizację widżetu TOP hosty, należy odwołać się do wymagań dotyczących parametrów przedstawionych w poniższych tabelach.
Parametry
Poniższe parametry są obsługiwane dla widżetu TOP hosty.
| Parametr | typ | 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. |
|
| Grupy hostów | 2 | groupids | ID grupy hostów. Uwaga: Aby skonfigurować wiele grup hostów, utwórz obiekt pola widżetu pulpitu dla każdej grupy hostów. |
|
| Hosty | 3 | hostids | ID hosta. Uwaga: Aby skonfigurować wiele hostów, utwórz obiekt pola widżetu pulpitu dla każdego hosta. Dla wielu hostów parametr Grupy hostów musi być albo całkowicie nie skonfigurowany, albo skonfigurowany z co najmniej jedną grupą hostów, do której należą skonfigurowane hosty. |
|
| Znaczniki hosta (numer w nazwie właściwości (np. tags.tag.0) odnosi się do kolejności tagów na liście ewaluacyjnej) | ||||
| Typ ewaluacji | 0 | evaltype | 0 - (domyślnie) I/Lub; 2 - Lub. |
|
| Nazwa znacznika | 1 | tags.tag.0 | Dowolna wartość ciągu znaków. Parametr Nazwa tagu wymagany przy konfigurowaniu Znaczników. |
|
| Operator | 0 | tags.operator.0 | 0 - Zawiera; 1 - Równa się; 2 - Nie zawiera; 3 - Nie równa się; 4 - Istnieje; 5 - Nie istnieje. Parametr Operator wymagany przy konfigurowaniu Znaczników. |
|
| Wartość znacznika | 1 | tags.value.0 | Dowolna wartość ciągu znaków. Parametr Wartość tagu wymagany przy konfigurowaniu Znaczników. |
|
| Kolumny (patrz poniżej) | ||||
| Kolejność | 0 | order | 2 - (domyślnie) Pierwsze N; 3 - Ostatnie N. |
|
| Kolumna sortowania | 0 | column | Wartość numeryczna kolumny z skonfigurowanych kolumn. | |
| Liczba hostów | 0 | count | Dopuszczalne wartości z zakresu od 1 do 100. Domyślnie: 10. |
|
Kolumny
Kolumny posiadają wspólne parametry oraz dodatkowe parametry w zależności od konfiguracji parametru Dane.
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 | typ | nazwa | wartość |
|---|---|---|---|
| Nazwa | 1 | columns.name.0 | Dowolna wartość tekstowa. |
| Dane (wymagane) |
0 | columns.data.0 | 1 - Wartość pozycji; 2 - Nazwa hosta; 3 - Tekst. |
| Kolor podstawowy (wymagane) |
1 | columns.base_color.0 | Szesnastkowy kod koloru (np. FF0000). |
Wartość pozycji
Następujące parametry są obsługiwane, jeśli parametr Dane jest ustawiony na "Wartość pozycji".
Pierwsza liczba w nazwie właściwości Próg (np. columnsthresholds.color.0.0) odnosi się do kolumny, dla której są skonfigurowane progi, natomiast druga liczba odnosi się do miejsca progu na liście, posortowanej rosnąco. Jednakże, jeśli progi są skonfigurowane w innej kolejności, wartości zostaną posortowane rosnąco po zaktualizowaniu konfiguracji widżetu w interfejsie Zabbixa (np. "threshold.threshold.0":"5" → "threshold.threshold.0":"1"; "threshold.threshold.1":"1" → "threshold.threshold.1": "5").
| Parametr | typ | nazwa | wartość | |
|---|---|---|---|---|
| Pozycja | 1 | columns.item.0 | Prawidłowa nazwa pozycji. | |
| Przesunięcie czasu (wymagane) |
1 | columns.timeshift.0 | Prawidłowa wartość liczbowa lub ciąg czasowy (np. 3600 lub 1h).Możesz używać przyrostków czasowych. Dozwolone są wartości ujemne. |
|
| Funkcja agregująca | 0 | columns.aggregate_function.0 | 0 - (domyślnie) nieużywany; 1 - min; 2 - maks; 3 - śr; 4 - zliczyć; 5 - suma; 6 - pierwszy; 7 - ostatni. |
|
| Interwał agregacji | 1 | columns.aggregate_interval.0 | Prawidłowy ciąg czasowy (np. 3600, 1h, itp.).Możesz używać przyrostków czasowych. Parametr Interwał agregacji nie jest dostępny, jeśli Funkcja agregująca jest ustawiona na nieużywany. Domyślnie: 1h. |
|
| Wyświetlanie | 0 | columns.display.0 | 1 - (domyślnie) Tak jak jest; 2 - Belka; 3 - Wskaźniki. |
|
| Minimalny | 1 | columns.min.0 | Dowolna wartość liczbowa. Parametr Min nie jest dostępny, jeśli Wyświetlanie jest ustawione na "Tak jak jest". |
|
| Maksymalny | 1 | columns.max.0 | Dowolna wartość liczbowa. Parametr Maks nie jest dostępny, jeśli Wyświetlanie jest ustawione na "Tak jak jest". |
|
| Dane historyczne | 0 | columns.history.0 | 1 - (domyślnie) Automatycznie; 2 - Historia; 3 - Trendy. |
|
| Progi | ||||
| Kolor | 1 | columnsthresholds.color.0.0 | Szesnastkowy kod koloru (np. FF0000).Domyślnie: "" (puste). |
|
| Próg | 1 | columnsthresholds.threshold.0.0 | Dowolna wartość tekstowa. | |
Tekst
Następujące parametry są obsługiwane, jeśli Dane są ustawione na "Tekst".
| Parametr | typ | nazwa | wartość |
|---|---|---|---|
| Tekst | 1 | columns.text.0 | Dowolna wartość tekstowa, w tym makra. Obsługiwane makra: {HOST.}, {INVENTORY.}. Parametr Tekst jest wymagany, jeśli Dane są ustawione na "Tekst". |
Przykłady
Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu TOP hosty. Aby uzyskać więcej informacji na temat konfigurowania pulpitu nawigacyjnego, zobacz dashboard.create.
Konfigurowanie widżetu TOP hosty
Skonfiguruj widżet TOP hosty, który wyświetla top hosty według wykorzystania procesora w grupie hostów "4". Dodatkowo skonfiguruj następujące niestandardowe kolumny: "Host name", "Utilization", "1m avg", "5m avg", "15m avg", "Processes".
Zapytanie:
{
"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": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "Utilization"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.item.2",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.item.3",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.item.4",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processes"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 1,
"name": "columns.item.5",
"value": "Number of processes"
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź: