29 Najważniejsze pozycje
Opis
Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Top items 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 items, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.
Parametry
Następujące parametry są obsługiwane dla widżetu Top items.
| 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. |
|
| 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 numerem zwiększanym 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. |
|
| Hosty | 3 | hostids.0 | ID hosta. Uwaga: Aby skonfigurować wiele hostów, utwórz obiekt pola widżetu pulpitu dla każdego hosta z numerem zwiększanym w nazwie właściwości. W przypadku wielu hostów parametr Grupy hostów nie może być w ogóle skonfigurowany albo musi być skonfigurowany z co najmniej jedną grupą hostów, do której należą skonfigurowane hosty. Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Hosty (widżet/pulpit) | 1 | hostids._reference | Zamiast ID hosta:DASHBOARD.hostids - ustaw selektor hostów pulpitu jako źródło danych dla hostów;ABCDE._hostids - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla hostów.Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Tagi hostów | ||||
| Typ obliczania | 0 | host_tags_evaltype | 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: Numer w nazwie właściwości odnosi się do kolejności tagu na liście obliczania tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów hostów 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: Numer w nazwie właściwości odnosi się do kolejności tagu na liście obliczania tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów hostów Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Wartość tagu | 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 obliczania tagów. Zachowanie parametru: - wymagane przy konfigurowaniu Tagów hostów Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu. |
|
| Układ | 0 | layout | 0 - (domyślnie) Poziomy; 1 - Pionowy. |
|
| Pokaż problemy | 0 | show_problems | 0 - Wszystkie; 1 - (domyślnie) Nieukryte; 2 - Brak. |
|
| Pozycje (zobacz poniżej) | ||||
Zaawansowana konfiguracja
Poniższe zaawansowane parametry konfiguracji są obsługiwane przez widżet Top items.
| Parametr | type | name | value | |
|---|---|---|---|---|
| Porządkowanie hostów | ||||
| Sortuj według | 0 | host_ordering_order_by | 0 - (domyślnie) Nazwa hosta; 3 - Wartość pozycji. |
|
| Wzorce pozycji | 1 | host_ordering_item.0 | Nazwa lub wzorzec pozycji (np. "*: Number of processed *values per second"). Uwaga: Aby skonfigurować wiele wzorców pozycji, utwórz obiekt pola widżetu pulpitu dla każdego wzorca pozycji z inkrementowanym numerem w nazwie właściwości. Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie. Zachowanie parametru: - wymagane, jeśli Sortuj według jest ustawione na "Wartość pozycji" |
|
| Kolejność | 0 | host_ordering_order | 2 - (domyślnie) Górne N; 3 - Dolne N. |
|
| Limit | 0 | host_ordering_limit | Możliwe wartości mieszczą się w zakresie od 1 do 100. Domyślnie: 10. |
|
| Porządkowanie pozycji | ||||
| Sortuj według | 0 | item_ordering_order_by | 1 - Host; 2 - Nazwa pozycji; 3 - (domyślnie) Wartość pozycji. |
|
| Wzorce hostów | 1 | item_ordering_host.0 | Nazwa lub wzorzec hosta. Uwaga: Aby skonfigurować wiele wzorców hostów, utwórz obiekt pola widżetu pulpitu dla każdego wzorca hosta z inkrementowanym numerem w nazwie właściwości. Zachowanie parametru: - wymagane, jeśli Sortuj według jest ustawione na "Host" |
|
| Kolejność | 0 | item_ordering_order | 2 - (domyślnie) Górne N; 3 - Dolne N. |
|
| Limit | 0 | item_ordering_limit | Możliwe wartości mieszczą się w zakresie od 1 do 100. Domyślnie: 10. |
|
Kolumny
Pierwsza liczba w nazwie właściwości (np. columns.0.items.0, columns.0.item_tags_evaltype) oznacza konkretną kolumnę, natomiast druga liczba, jeśli występuje, oznacza skonfigurowaną encję (np. wzorzec pozycji, znacznik).
| Parametr | type | name | value | |
|---|---|---|---|---|
| Wzorce pozycji | 1 | columns.0.items.0 | Nazwa lub wzorzec pozycji (np. "*: Number of processed *values per second"). Uwaga: Aby skonfigurować wiele wzorców pozycji, utwórz obiekt pola widżetu pulpitu dla każdego wzorca pozycji z inkrementowaną drugą liczbą w nazwie właściwości. Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko wzorce dla pozycji skonfigurowanych w szablonie. Zachowanie parametrów: - wymagane |
|
| Znaczniki pozycji | ||||
| Typ oceny | 0 | columns.0.item_tags_evaltype | 0 - (domyślnie) And/Or; 2 - Or. |
|
| Nazwa znacznika | 1 | columns.0.item_tags.0.tag | Dowolna wartość tekstowa. Uwaga: Druga liczba w nazwie właściwości odnosi się do kolejności znacznika na liście oceny znaczników. Zachowanie parametrów: - wymagane przy konfigurowaniu Znaczników pozycji |
|
| Operator | 0 | columns.0.item_tags.0.operator | 0 - Zawiera; 1 - Równe; 2 - Nie zawiera; 3 - Nie równa się; 4 - Istnieje; 5 - Nie istnieje. Uwaga: Druga liczba w nazwie właściwości odnosi się do kolejności znacznika na liście oceny znaczników. Zachowanie parametrów: - wymagane przy konfigurowaniu Znaczników pozycji |
|
| Wartość znacznika | 1 | columns.0.item_tags.0.value | Dowolna wartość tekstowa. Uwaga: Druga liczba w nazwie właściwości odnosi się do kolejności znacznika na liście oceny znaczników. Zachowanie parametrów: - wymagane przy konfigurowaniu Znaczników pozycji |
|
| Kolor bazowy | 1 | columns.0.base_color | Szesnastkowy kod koloru (np. FF0000). |
|
| Wyświetl wartość jako | 0 | columns.0.display_value_as | 1 - (domyślnie) Numerycznie; 2 - Tekst. |
|
| Wyświetlanie | 0 | columns.0.display | 1 - (domyślnie) Bez zmian; 2 - Pasek; 3 - Wskaźniki; 6 - Sparkline. |
|
| Min | 1 | columns.0.min | Dowolna wartość liczbowa. Obsługiwane są sufiksy (np. "1d", "2w", "4K", "8G"). Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie", a Wyświetlanie jest ustawione na "Pasek" lub "Wskaźniki" |
|
| Max | 1 | columns.0.max | Dowolna wartość liczbowa. Obsługiwane są sufiksy (np. "1d", "2w", "4K", "8G"). Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie", a Wyświetlanie jest ustawione na "Pasek" lub "Wskaźniki" |
|
| Sparkline | ||||
| Szerokość | 0 | columns.0.sparkline.width | Możliwe wartości mieszczą się w zakresie 0-10. Domyślnie: 1. Zachowanie parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "Sparkline" |
|
| Wypełnienie | 0 | columns.0.sparkline.fill | Możliwe wartości mieszczą się w zakresie 0-10. Domyślnie: 3. Zachowanie parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "Sparkline" |
|
| Kolor | 1 | columns.0.sparkline.color | Szesnastkowy kod koloru (np. FF0000).Domyślnie: 42A5F5.Zachowanie parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "Sparkline" |
|
| Okres czasu | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - ustaw selektor okresu czasu pulpitu jako źródło danych;ABCDE._timeperiod - ustaw kompatybilny widżet (z parametrem reference równym ABCDE) jako źródło danych.Domyślnie: DASHBOARD._timeperiodAlternatywnie można ustawić okres czasu tylko w parametrach Od i Do. Zachowanie parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "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 parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "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 parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "Sparkline" - wymagane jeśli ustawiono columns.0.sparkline.time_period.from |
|
| Dane historyczne | 0 | columns.0.sparkline.history | 0 - (domyślnie) Auto; 1 - Historia; 2 - Trendy. Zachowanie parametrów: - obsługiwane jeśli Wyświetlanie jest ustawione na "Sparkline" |
|
| Progi | ||||
| Kolor | 1 | columns.0.thresholds.0.color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie" |
|
| Próg | 1 | columns.0.thresholds.0.threshold | Dowolna wartość liczbowa. Obsługiwane są sufiksy (np. "1d", "2w", "4K", "8G"). Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie" |
|
| Wyróżnienia | ||||
| Wyróżnienie | 1 | columns.0.highlights.0.color | Szesnastkowy kod koloru (np. FF0000).Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Tekst" |
|
| Próg | 1 | columns.0.highlights.0.pattern | Dowolne wyrażenie regularne. Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Tekst" |
|
| Miejsca dziesiętne | 0 | columns.0.decimal_places | Możliwe wartości mieszczą się w zakresie 0-10. Domyślnie: 2. |
|
| Konfiguracja zaawansowana | ||||
| Funkcja agregacji | 0 | columns.0.aggregate_function | Jeśli Wyświetl wartość jako jest ustawione na "Numerycznie": 0 - (domyślnie) nieużywane; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. Jeśli Wyświetl wartość jako jest ustawione na "Tekst": 0 - (domyślnie) nieużywane; 4 - count; 6 - first; 7 - last. |
|
| Okres czasu | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - ustaw selektor okresu czasu pulpitu jako źródło danych;ABCDE._timeperiod - ustaw kompatybilny widżet (z parametrem reference równym ABCDE) jako źródło danych.Domyślnie: DASHBOARD._timeperiodAlternatywnie można ustawić okres czasu tylko w parametrach Od i Do. Zachowanie parametrów: - obsługiwane jeśli Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "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 parametrów: - obsługiwane jeśli Okres czasu nie jest ustawiony, a Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "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 parametrów: - obsługiwane jeśli Okres czasu nie jest ustawiony, a Funkcja agregacji jest ustawiona na "min", "max", "avg", "count", "sum", "first", "last" - wymagane jeśli ustawiono columns.0.time_period.from |
|
| Dane historyczne | 0 | columns.0.history | 0 - (domyślnie) Auto; 1 - Historia; 2 - Trendy. Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie" |
|
| Agreguj | 0 | columns.0.aggregate_columns | 0 - (domyślnie) Każda pozycja 1 - Łącznie. Zachowanie parametrów: - obsługiwane jeśli Wyświetl wartość jako jest ustawione na "Numerycznie", a Wyświetlanie jest ustawione na "Bez zmian", "Pasek" lub "Wskaźniki". |
|
| Funkcja agregacji łączonej | 0 | columns.0.column_aggregate_function | 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum (domyślnie). Zachowanie parametrów: - wymagane przy konfigurowaniu Agreguj. |
|
| Nazwa kolumny łączonej | 1 | columns.0.combined_column_name | Dowolna wartość tekstowa. Zachowanie parametrów: - wymagane przy konfigurowaniu Agreguj. |
|
Przykłady
Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widgetu pulpitu dla widgetu Top items.
Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.
Konfigurowanie widżetu Top items
Skonfiguruj widżet Top items, który wyświetla dane dla hosta „10084” i tylko dla pozycji, dla których tag o nazwie „component” zawiera wartość „cpu”. Dodatkowo wyświetl dane z hostami umieszczonymi u góry i użyj kolorowego paska wskaźnika do reprezentacji komórek.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}