На странице
28 Популярные узлы сети
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета позволяют настраивать виджет Top hosts в методах dashboard.create и dashboard.update.
Свойства fields виджета не проверяются при создании или обновлении панели.
Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов.
Чтобы обеспечить успешное создание или обновление виджета Top hosts, ознакомьтесь с поведением параметров, описанным в таблицах ниже.
Параметры
Для виджета Топ узлов сети поддерживаются следующие параметры.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Интервал обновления | 0 | rf_rate | 0 - Без обновления; 10 - 10 секунд; 30 - 30 секунд; 60 - (по умолчанию) 1 минута; 120 - 2 минуты; 600 - 10 минут; 900 - 15 минут. |
|
| Группы узлов сети | 2 | groupids.0 | ID группы узлов сети. Примечание: Чтобы настроить несколько групп узлов сети, создайте объект поля виджета панели с увеличивающимся номером в имени свойства для каждой группы узлов сети. Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Группы узлов сети (Виджет) | 1 | groupids._reference | Вместо ID группы узлов сети:ABCDE._hostgroupids — укажите совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для групп узлов сети.Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Узлы сети | 3 | hostids.0 | ID узла сети. Примечание: Чтобы настроить несколько узлов сети, создайте объект поля виджета панели с увеличивающимся номером в имени свойства для каждого узла сети. Для нескольких узлов сети параметр Группы узлов сети либо не должен быть настроен вовсе, либо должен быть настроен как минимум с одной группой узлов сети, к которой принадлежат указанные узлы сети. Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Узлы сети (Виджет/Панель) | 1 | hostids._reference | Вместо ID узла сети:DASHBOARD.hostids — укажите селектор узлов сети панели в качестве источника данных для узлов сети;ABCDE._hostids — укажите совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети.Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Теги узлов сети | ||||
| Тип вычисления | 0 | evaltype | 0 - (по умолчанию) И/Или; 2 - Или. Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Имя тега | 1 | tags.0.tag | Любое строковое значение. Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов. Поведение параметра: - обязательно при настройке Тегов узлов сети Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Оператор | 0 | tags.0.operator | 0 - Содержит; 1 - Равно; 2 - Не содержит; 3 - Не равно; 4 - Существует; 5 - Не существует. Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов. Поведение параметра: - обязательно при настройке Тегов узлов сети Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Значение тега | 1 | tags.0.value | Любое строковое значение. Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов. Поведение параметра: - обязательно при настройке Тегов узлов сети Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Показывать узлы сети на обслуживании | 0 | maintenance | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Столбцы (см. ниже) | ||||
| Сортировать по | 0 | column | Числовое значение столбца из настроенных столбцов. | |
| Порядок | 0 | order | 2 - (по умолчанию) Топ N; 3 - Нижние N. |
|
| Лимит узлов сети | 0 | show_lines | Возможные значения: от 1 до 1000. По умолчанию: 10. Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
Столбцы
Столбцы имеют общие параметры и дополнительные параметры в зависимости от конфигурации параметра Data.
Для всех параметров, относящихся к столбцам, число в имени свойства (например, columns.0.name) указывает на столбец, для которого настраивается этот параметр.
Следующие параметры поддерживаются для всех столбцов.
| Параметр | type | name | value |
|---|---|---|---|
| Имя | 1 | columns.0.name | Любое строковое значение. Поведение параметра: - обязательный |
| Данные | 0 | columns.0.data | 1 - Значение элемента данных; 2 - Имя узла сети; 3 - Текст. Поведение параметра: - обязательный |
| Базовый цвет | 1 | columns.0.base_color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - обязательный |
Значение элемента данных
Следующие параметры поддерживаются, если для 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").
| Параметр | type | name | value | |
|---|---|---|---|---|
| Элемент данных | 1 | columns.0.item | Допустимое имя элемента данных. При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные в шаблоне. |
|
| Отображать значение элемента данных как | 0 | columns.0.display_value_as | 0 - (по умолчанию) Числовое; 1 - Текст; 2 - Двоичное. |
|
| Отображение | 0 | columns.0.display | 1 - (по умолчанию) Как есть; 2 - Полоса; 3 - Индикаторы; 6 - Спарклайн. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" |
|
| Мин | 1 | columns.0.min | Любое числовое значение. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Bar" или "Indicators" |
|
| Макс | 1 | columns.0.max | Любое числовое значение. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Bar" или "Indicators" |
|
| Десятичные знаки | 0 | columns.0.decimal_places | Допустимые значения: 0-10. По умолчанию: 2. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" |
|
| Спарклайн | ||||
| Ширина | 0 | columns.0.sparkline.width | Допустимые значения: 0-10. По умолчанию: 1. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" |
|
| Заполнение | 0 | columns.0.sparkline.fill | Допустимые значения: 0-10. По умолчанию: 3. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" |
|
| Цвет | 1 | columns.0.sparkline.color | Шестнадцатеричный код цвета (например, FF0000).По умолчанию: 42A5F5.Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" |
|
| Период времени | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - использовать селектор периода времени панели как источник данных;ABCDE._timeperiod - использовать совместимый виджет (с параметром reference, равным ABCDE) как источник данных.По умолчанию: DASHBOARD._timeperiodВ качестве альтернативы можно задать период времени только в параметрах От и До. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" |
|
| От | 1 | columns.0.sparkline.time_period.from | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" - обязателен, если задан columns.0.sparkline.time_period.to |
|
| До | 1 | columns.0.sparkline.time_period.to | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" - обязателен, если задан columns.0.sparkline.time_period.from |
|
| Исторические данные | 0 | columns.0.sparkline.history | 0 - (по умолчанию) Авто; 1 - History; 2 - Trends. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" и для Отображение установлено значение "Sparkline" |
|
| Пороги | ||||
| Цвет | 1 | columnsthresholds.0.color.0 | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" |
|
| Порог | 1 | columnsthresholds.0.threshold.0 | Любое строковое значение. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" |
|
| Подсветка | ||||
| Цвет | 1 | columns.0.highlights.0.color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Text" |
|
| Шаблон | 1 | columns.0.highlights.0.pattern | Любое строковое значение. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Text" |
|
| Показывать миниатюру | 0 | columns.0.show_thumbnail | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Binary" |
|
| Функция агрегации | 0 | columns.0.aggregate_function | 0 - (по умолчанию) не используется; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Период времени | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - использовать селектор периода времени панели как источник данных;ABCDE._timeperiod - использовать совместимый виджет (с параметром reference, равным ABCDE) как источник данных.По умолчанию: DASHBOARD._timeperiodВ качестве альтернативы можно задать период времени только в параметрах От и До. Поведение параметра: - поддерживается, если для Функция агрегации установлено значение "min", "max", "avg", "count", "sum", "first", "last" |
|
| От | 1 | columns.0.time_period.from | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Период времени не задан и для Функция агрегации установлено значение "min", "max", "avg", "count", "sum", "first", "last" - обязателен, если задан columns.0.time_period.to |
|
| До | 1 | columns.0.time_period.to | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - поддерживается, если Период времени не задан и для Функция агрегации установлено значение "min", "max", "avg", "count", "sum", "first", "last" - обязателен, если задан columns.0.time_period.from |
|
| Исторические данные | 0 | columns.0.history | 0 - (по умолчанию) Авто; 1 - History; 2 - Trends. Поведение параметра: - поддерживается, если для Отображать значение элемента данных как установлено значение "Numeric" |
|
| Ссылка | 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
}Ответ:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}