На странице
26 Топ узлов сети
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета панели позволяют настроить виджет Top hosts в методах dashboard.create и dashboard.update.
Свойства fields виджета не проверяются при создании или обновлении панели.
Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов.
Чтобы обеспечить успешное создание или обновление виджета Top hosts, обратитесь к описанию поведения параметров в таблицах ниже.
Параметры
Следующие параметры поддерживаются для виджета Top hosts.
| Параметр | type | имя | значение | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - Без обновления; 10 - 10 секунд; 30 - 30 секунд; 60 - (по умолчанию) 1 минута; 120 - 2 минуты; 600 - 10 минут; 900 - 15 минут. |
|
| Host groups | 2 | groupids.0 | ID группы узлов сети. Примечание: чтобы настроить несколько групп узлов сети, создайте объект поля виджета панели для каждой группы узлов сети, увеличивая номер в имени свойства. Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Host groups (Widget) | 1 | groupids._reference | Вместо ID группы узлов сети:ABCDE._hostgroupids - задайте совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для групп узлов сети.Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Hosts | 3 | hostids.0 | ID узла сети. Примечание: чтобы настроить несколько узлов сети, создайте объект поля виджета панели для каждого узла сети, увеличивая номер в имени свойства. Для нескольких узлов сети параметр Host groups должен либо не быть настроен вовсе, либо быть настроен как минимум с одной группой узлов сети, к которой принадлежат настроенные узлы сети. Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Вместо ID узла сети:DASHBOARD.hostids - задайте селектор Host в качестве источника данных для узлов сети;ABCDE._hostids - задайте совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети.Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype | 0 - (по умолчанию) И/ИЛИ; 2 - ИЛИ. Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Tag name | 1 | tags.0.tag | Любое строковое значение. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен, если настраивается Host tags Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Operator | 0 | tags.0.operator | 0 - Содержит; 1 - Равно; 2 - Не содержит; 3 - Не равно; 4 - Существует; 5 - Не существует. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен, если настраивается Host tags Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Tag value | 1 | tags.0.value | Любое строковое значение. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен, если настраивается Host tags Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Columns (see below) | ||||
| Order by | 0 | column | Числовое значение столбца из настроенных столбцов. | |
| Order | 0 | order | 2 - (по умолчанию) Top N; 3 - Bottom N. |
|
| Host limit | 0 | show_lines | Допустимые значения: от 1 до 100. По умолчанию: 10. Этот параметр не поддерживается при настройке виджета на шаблоне панели. |
|
Столбцы
У столбцов есть общие параметры и дополнительные параметры в зависимости от настройки параметра Data.
Для всех параметров, связанных со столбцами, число в имени свойства (например, columns.0.name) указывает на столбец, для которого настроен параметр.
Следующие параметры поддерживаются для всех столбцов.
| Parameter | type | name | value |
|---|---|---|---|
| Имя | 1 | columns.0.name | Любое строковое значение. Поведение параметра: - required |
| Данные | 0 | columns.0.data | 1 - значение элемента данных; 2 - имя узла сети; 3 - текст. Поведение параметра: - required |
| Основной цвет | 1 | columns.0.base_color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - required |
Значение элемента данных
Следующие параметры поддерживаются, если для Data задано значение "Item value".
Первое число в имени свойства Thresholds (например, columnsthresholds.0.color.0) указывает на столбец, для которого настроены пороговые значения, а второе число указывает на позицию порогового значения в списке, отсортированном по возрастанию.
Однако если пороговые значения настроены в другом порядке, значения будут отсортированы по возрастанию после обновления конфигурации виджета во веб-интерфейсе Zabbix (например, "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parameter | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Допустимое имя элемента данных. При настройке виджета на шаблонной панели следует указывать только элементы данных, настроенные на шаблоне. |
|
| Display | 0 | columns.0.display | 1 - (по умолчанию) как есть; 2 - Bar; 3 - Indicators. |
|
| Min | 1 | columns.0.min | Любое числовое значение. Поведение параметра: - поддерживается, если для Display задано значение "Bar" или "Indicators" |
|
| Max | 1 | columns.0.max | Любое числовое значение. Поведение параметра: - поддерживается, если для Display задано значение "Bar" или "Indicators" |
|
| Decimal places | 0 | columns.0.decimal_places | Допустимый диапазон значений: от 0 до 10. По умолчанию: 2. |
|
| Thresholds | ||||
| Color | 1 | columnsthresholds.0.color.0 | Шестнадцатеричный код цвета (например, FF0000).По умолчанию: "" (пусто). |
|
| Threshold | 1 | columnsthresholds.0.threshold.0 | Любое строковое значение. | |
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (по умолчанию) не используется; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - использовать селектор Time period в качестве источника данных;ABCDE._timeperiod - использовать совместимый виджет (со значением параметра reference, равным ABCDE) в качестве источника данных.По умолчанию: DASHBOARD._timeperiodКроме того, можно задать период времени только в параметрах From и To. Поведение параметра: - поддерживается, если для Aggregation function задано значение "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | columns.0.time_period.from | Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Time period не задан и для Aggregation function задано значение "min", "max", "avg", "count", "sum", "first", "last" - обязательно, если задан columns.0.time_period.to |
|
| To | 1 | columns.0.time_period.to | Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Time period не задан и для Aggregation function задано значение "min", "max", "avg", "count", "sum", "first", "last" - обязательно, если задан columns.0.time_period.from |
|
| History data | 0 | columns.0.history | 0 - (по умолчанию) Auto; 1 - History; 2 - Trends. |
|
| Reference | 1 | reference | Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой относится виджет.Поведение параметра: - обязательно |
|
Текст
Следующие параметры поддерживаются, если для параметра Data установлено значение "Текст".
| Параметр | тип | имя | значение |
|---|---|---|---|
| Текст | 1 | columns.0.text | Любое строковое значение, включая макросы. Поддерживаемые макросы: {HOST.*}, {INVENTORY.*}. Поведение параметра: - обязательно, если для Data установлено значение "Текст" |
Примеры
Следующие примеры предназначены только для описания конфигурации объектов полей виджета информационной панели для виджета Топ узлов сети.
Для получения дополнительной информации о настройке информационной панели см. dashboard.create.
Настройка виджета Top hosts
Настройте виджет Top hosts, который отображает узлы сети с наибольшей загрузкой CPU в группе узлов сети "4". Кроме того, настройте следующие пользовательские столбцы: "Имя узла сети", "Загрузка CPU в %", "среднее за 1 мин", "среднее за 5 мин", "среднее за 15 мин", "Процессы".
{
"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
}Response:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}