Documentation
Table of Contents
21 Топ узлов сети
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета информационной панели позволяют настроить виджет Топ узлов сети в методах dashboard.create и dashboard.update.
Свойства полей виджета не проверяются во время создания или обновления информационной панели. Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск неправильного создания или обновления виджетов. Чтобы обеспечить успешное создание или обновление виджета Топ узлов сети, ознакомьтесь с требованиями к параметрам, указанными в таблицах ниже.
Parameters
The following parameters are supported for the Top Hosts widget.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - (default) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
|
| Host groups | 2 | groupids | Host group ID. Note: To configure multiple host groups, create a dashboard widget field object for each host group. |
|
| Hosts | 3 | hostids | Host ID. Note: To configure multiple hosts, create a dashboard widget field object for each host. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to. |
|
| Host Tags (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list) | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.tag.0 | Any string value. Parameter Tag name required if configuring Tags. |
|
| Operator | 0 | tags.operator.0 | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Parameter Operator required if configuring Tags. |
|
| Tag value | 1 | tags.value.0 | Any string value. Parameter Tag value required if configuring Tags. |
|
| Columns (see below) | ||||
| Order | 0 | order | 2 - (default) Top N; 3 - Bottom N. |
|
| Order column | 0 | column | Column numeric value from the configured columns. | |
| Host count | 0 | count | Valid values range from 1-100. Default: 10. |
|
Столбцы
Столбцы имеют общие параметры и дополнительные параметры в зависимости от настройки параметра Данные.
Для всех параметров, связанных со столбцами, число в имени свойства (например, columns.name.0) указывает на столбец, для которого настроен параметр.
Следующие параметры поддерживаются для всех столбцов.
| Параметр | тип | имя | значение |
|---|---|---|---|
| Name | 1 | columns.name.0 | Любое строковое значение. |
| Data (обязательно) |
0 | columns.data.0 | 1 - Значение элемента; 2 - Имя хоста; 3 - Текст. |
| Base color (обязательно) |
1 | columns.base_color.0 | Шестнадцатеричный код цвета (например, FF0000). |
Значение элемента
Следующие параметры поддерживаются, если для параметра Data установлено значение «Значение элемента».
Первое число в имени свойства Thresholds (например, columnsthresholds.color.0.0) указывает на столбец, для которого настроены пороговые значения, а второе число указывает на пороговое место в списке, отсортированном по возрастанию. Однако, если пороговые значения настроены в другом порядке, значения будут отсортированы по возрастанию после обновления конфигурации виджета в интерфейсе Zabbix. (например, "threshold.threshold.0":"5" → "threshold.threshold.0":"1"; "threshold.threshold.1":"1" → "threshold.threshold. 1": "5").
| Параметр | тип | имя | значение | |
|---|---|---|---|---|
| Элемент | 1 | columns.item.0 | Действительное имя элемента. | |
| Сдвиг по времени (обязательно) |
1 | columns.timeshift.0 | Действительное числовое или строковое значение времени (например, 3600 или 1h).Вы можете использовать суффиксы времени. Допускаются отрицательные значения. |
|
| Функция агрегации | 0 | columns.aggregate_function.0 | 0 - (по умолчанию) нет; 1 - мин; 2 - макс; 3 - среднее; 4 - счет; 5 - сумма; 6 - первый; 7 - последний. |
|
| Интервал агрегации | 1 | columns.aggregate_interval.0 | Действительная строка времени (например, 3600, 1h и т. д.).Вы можете использовать суффиксы времени. Параметр Интервал агрегации недоступен, если для Функция агрегации установлено значение none. По умолчанию: 1h. |
|
| Отображение | 0 | columns.display.0 | 1 - (по умолчанию) Как есть; 2 - Столбцы; 3 - Индикаторы. |
|
| Min | 1 | columns.min.0 | Любое числовое значение. Параметр Min недоступен, если для Отображение установлено значение «Как есть». |
|
| Max | 1 | columns.max.0 | Любое числовое значение. Параметр Max недоступен, если для Отображение установлено значение «Как есть». |
|
| Данные истории | 0 | columns.history.0 | 1 - (по умолчанию) Авто; 2 - История; 3 - Динамика изменений. |
|
| Пороги | ||||
| Цвет | 1 | columnsthresholds.color.0.0 | Шестнадцатеричный код цвета (например, FF0000).По умолчанию: "" (пусто). |
|
| Порог | 1 | columnsthresholds.threshold.0.0 | Любое строковое значение. | |
Текст
Следующие параметры поддерживаются, если для параметра Data установлено значение "Текст".
| Параметр | тип | имя | значение |
|---|---|---|---|
| Text | 1 | columns.text.0 | Любое строковое значение, включая макросы. Поддерживаемые макросы: {HOST.*}, {INVENTORY.*}. Параметр Text требуется, если для параметра Data установлено значение "Текст". |
Примеры
Следующие примеры предназначены только для описания конфигурации объектов полей виджета информационной панели для виджета Топ узлов сети. Для получения дополнительной информации о настройке информационной панели см. dashboard.create.
Configuring a Top hosts widget
Configure a Top hosts widget that displays top hosts by CPU utilization in host group "4". In addition, configure the following custom columns: "Host name", "Utilization", "1m avg", "5m avg", "15m avg", "Processes".
Request:
{
"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.item.0",
"value": "System name"
},
{
"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
}Response: