8 График
Описание
Эти параметры и возможные значения свойств для соответствующих объектов полей виджета панели позволяют настроить виджет Graph в методах dashboard.create и dashboard.update.
Свойства fields виджета не проверяются при создании или обновлении панели.
Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов.
Чтобы обеспечить успешное создание или обновление виджета Graph, ознакомьтесь с поведением параметров, описанным в таблицах ниже.
Параметры
Следующие параметры поддерживаются для виджета Graph.
| Parameter | type | name | value |
|---|---|---|---|
| Интервал обновления | 0 | rf_rate | 0 - без обновления; 10 - 10 секунд; 30 - 30 секунд; 60 - (по умолчанию) 1 минута; 120 - 2 минуты; 600 - 10 минут; 900 - 15 минут. |
| Ссылка | 1 | reference | Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой принадлежит виджет.Поведение параметра: - required |
Набор данных
Для настройки набора данных поддерживаются следующие параметры.
Первое число в имени свойства (например, ds.0.hosts.0, ds.0.items.0) обозначает конкретный набор данных, а второе число, если оно указано, обозначает настроенный узел сети или элемент данных.
| Параметр | тип | имя | значение | |
|---|---|---|---|---|
| Тип набора данных | 0 | ds.0.dataset_type | 0 - список элементов данных; 1 - (по умолчанию) шаблоны элементов данных. |
|
| Элементы данных | 4 | ds.0.itemids.0 | Идентификатор элемента данных. При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные в шаблоне. Примечание: чтобы настроить несколько элементов данных, создайте отдельный объект поля виджета панели для каждого элемента данных, увеличивая число в имени свойства. Поведение параметра: - обязателен, если для параметра Тип набора данных установлено значение «Список элементов данных», а параметр Элементы данных (виджет) не задан |
|
| Элементы данных (виджет) | 1 | ds.0.itemids.0._reference | Вместо идентификатора элемента данных:ABCDE._itemid - задайте совместимый виджет (с параметром Ссылка, установленным в значение "ABCDE") в качестве источника данных для элементов данных.Примечание: чтобы настроить несколько виджетов, создайте отдельный объект поля виджета панели для каждого виджета, увеличивая число в имени свойства. Поведение параметра: - обязателен, если для параметра Тип набора данных установлено значение «Список элементов данных», а параметр Элементы данных не задан |
|
| Цвет | 1 | ds.0.color.0 | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - обязателен, если для параметра Тип набора данных установлено значение «Список элементов данных» |
|
| Шаблоны узлов сети | 1 | ds.0.hosts.0 | Имя или шаблон узла сети (например, "Zabbix*"). Поведение параметра: - обязателен, если для параметра Тип набора данных установлено значение «Шаблоны элементов данных» Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Шаблоны элементов данных | 1 | ds.0.items.0 | Имя или шаблон элемента данных (например, "*: Number of processed *values per second"). При настройке виджета на панели шаблона следует указывать только шаблоны элементов данных, настроенных в шаблоне. Поведение параметра: - обязателен, если для параметра Тип набора данных установлено значение «Шаблоны элементов данных» |
|
| Цвет | 1 | ds.0.color | Шестнадцатеричный код цвета (например, FF0000).Поведение параметра: - поддерживается, если для параметра Тип набора данных установлено значение «Шаблоны элементов данных», а параметр Палитра цветов не задан |
|
| Палитра цветов | 0 | ds.0.color_palette | Индекс палитры цветов. Допустимые значения находятся в диапазоне от 0 до 11. По умолчанию: 0. Поведение параметра: - поддерживается, если для параметра Тип набора данных установлено значение «Шаблоны элементов данных», а параметр Цвет не задан |
|
| Отображение | 0 | ds.0.type | 0 - (по умолчанию) линия; 1 - точки; 2 - ступенчатая линия; 3 - столбцы. |
|
| С накоплением | 0 | ds.0.stacked | 0 - (по умолчанию) отключено; 1 - включено. Поведение параметра: - поддерживается, если для параметра Отображение установлено значение «Линия», «Ступенчатая линия» или «Столбцы» |
|
| Ширина | 0 | ds.0.width | Допустимые значения находятся в диапазоне от 1 до 10. По умолчанию: 1. Поведение параметра: - поддерживается, если для параметра Отображение установлено значение «Линия» или «Ступенчатая линия» |
|
| Размер точки | 0 | ds.0.pointsize | Допустимые значения находятся в диапазоне от 1 до 10. По умолчанию: 3. Поведение параметра: - поддерживается, если для параметра Отображение установлено значение «Точки» |
|
| Прозрачность | 0 | ds.0.transparency | Допустимые значения находятся в диапазоне от 1 до 10. По умолчанию: 5. |
|
| Заливка | 0 | ds.0.fill | Допустимые значения находятся в диапазоне от 1 до 10. По умолчанию: 3. Поведение параметра: - поддерживается, если для параметра Отображение установлено значение «Линия» или «Ступенчатая линия» |
|
| Отсутствующие данные | 0 | ds.0.missingdatafunc | 0 - (по умолчанию) нет; 1 - соединять; 2 - считать равными 0; 3 - последнее известное значение. Поведение параметра: - поддерживается, если для параметра Отображение установлено значение «Линия» или «Ступенчатая линия» |
|
| Переопределение узла сети | 1 | ds.0.override_hostid._reference | ABCDE._hostid - задайте совместимый виджет (с параметром «Ссылка», установленным в значение "ABCDE") в качестве источника данных для узлов сети;DASHBOARD._hostid - задайте выбор узла сети панели в качестве источника данных для узлов сети.Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Ось Y | 0 | ds.0.axisy | 0 - (по умолчанию) левая; 1 - правая. |
|
| Инвертировать значения | 0 | ds.0.invert_values | 0 - (по умолчанию) отключено; 1 - включено. |
|
| Сдвиг времени | 1 | ds.0.timeshift | Допустимая строка времени (например, 3600, 1h и т. д.).Можно использовать суффиксы времени. Также допускаются отрицательные значения. По умолчанию: "" (пусто). |
|
| Функция агрегации | 0 | ds.0.aggregate_function | 0 - (по умолчанию) не используется; 1 - минимум; 2 - максимум; 3 - среднее; 4 - количество; 5 - сумма; 6 - первое значение; 7 - последнее значение. |
|
| Интервал агрегации | 1 | ds.0.aggregate_interval | Допустимая строка времени (например, 3600, 1h и т. д.).Можно использовать суффиксы времени. По умолчанию: 1h. |
|
| Агрегировать | 0 | ds.0.aggregate_grouping | 0 - (по умолчанию) каждый элемент данных; 1 - набор данных. Поведение параметра: - поддерживается, если для параметра Функция агрегации установлено значение «минимум», «максимум», «среднее», «количество», «сумма», «первое значение» или «последнее значение» |
|
| Аппроксимация | 0 | ds.0.approximation | 1 - минимум; 2 - (по умолчанию) среднее; 4 - максимум; 7 - все. |
|
| Метка набора данных | 1 | ds.0.data_set_label | Любое строковое значение. По умолчанию: "" (пусто). |
|
| Теги элементов данных | ||||
| Тип оценки | 0 | ds.0.item_tags_evaltype | 0 - (по умолчанию) И/ИЛИ; 2 - ИЛИ. |
|
| Имя тега | 1 | ds.0.item_tags.0.tag | Любое строковое значение. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен при настройке Тегов элементов данных |
|
| Оператор | 0 | ds.0.item_tags.0.operator | 0 - содержит; 1 - равно; 2 - не содержит; 3 - не равно; 4 - существует; 5 - не существует. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен при настройке Тегов элементов данных |
|
| Значение тега | 1 | ds.0.item_tags.0.value | Любое строковое значение. Примечание: число в имени свойства указывает порядок тега в списке оценки тегов. Поведение параметра: - обязателен при настройке Тегов элементов данных |
|
Параметры отображения
Для настройки параметров отображения поддерживаются следующие параметры.
| Параметр | тип | имя | значение | |
|---|---|---|---|---|
| Выбор данных истории | 0 | source | 0 - (по умолчанию) Автоматически; 1 - История; 2 - Тренды. |
|
| Простые триггеры | 0 | simple_triggers | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Рабочее время | 0 | working_time | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Имена узлов сети в подписях | 0 | show_hostnames | 0 - (по умолчанию) Автоматически; 1 - Показывать; 2 - Скрывать. Этот параметр не поддерживается при настройке виджета на панели мониторинга шаблона. |
|
| Линия процентиля (слева) | ||||
| Состояние | 0 | percentile_left | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для оси Y (в конфигурации набора данных) установлено значение «Слева» |
|
| Значение | 0 | percentile_left_value | Допустимый диапазон значений: от 1 до 100. Поведение параметра: - поддерживается, если для оси Y (в конфигурации набора данных) установлено значение «Слева» |
|
| Линия процентиля (справа) | ||||
| Состояние | 0 | percentile_right | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для оси Y (в конфигурации набора данных) установлено значение «Справа» |
|
| Значение | 0 | percentile_right_value | Допустимый диапазон значений: от 1 до 100. Поведение параметра: - поддерживается, если для оси Y (в конфигурации набора данных) установлено значение «Справа» |
|
Период времени
Следующие параметры поддерживаются для настройки Периода времени.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Период времени | 1 | time_period._reference | DASHBOARD._timeperiod - задать селектор периода времени на веб-интерфейсе панели как источник данных;ABCDE._timeperiod - задать совместимый виджет (с параметром Reference, установленным в значение "ABCDE") как источник данных.По умолчанию: DASHBOARD._timeperiodКроме того, вы можете задать период времени только в параметрах From и To. |
|
| From | 1 | time_period.from | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - supported если Период времени не задан - required если задан time_period.to |
|
| To | 1 | time_period.to | Допустимая строка времени в абсолютном (YYYY-MM-DD hh:mm:ss) или относительном формате времени (now, now/d, now/w-1w и т. д.).Поведение параметра: - supported если Период времени не задан - required если задан time_period.from |
|
Оси
Следующие параметры поддерживаются для настройки Оси.
| Parameter | type | name | value |
|---|---|---|---|
| Левая Y | 0 | lefty | 0 - Отключено; 1 - (по умолчанию) Включено. Поведение параметра: - поддерживается, если ось Y (в настройке Набор данных) установлена в значение "Left" |
| Правая Y | 0 | righty | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если ось Y (в настройке Набор данных) установлена в значение "Right" |
| Масштаб | 0 | lefty_scale | 0 - (по умолчанию) Линейный; 1 - Логарифмический. |
| righty_scale | |||
| Мин. | 1 | lefty_min | Любое числовое значение. По умолчанию: "" (пусто). |
| righty_min | |||
| Макс. | 1 | lefty_max | Любое числовое значение. По умолчанию: "" (пусто). |
| righty_max | |||
| Единицы (тип) | 0 | lefty_units | 0 - (по умолчанию) Авто; 1 - Статические. |
| righty_units | |||
| Единицы (значение) | 1 | lefty_static_units | Любое строковое значение. По умолчанию: "" (пусто). |
| righty_static_units | |||
| Ось X | 0 | xaxis | 0 - Отключено; 1 - (по умолчанию) Включено. |
Легенда
Для настройки Легенды поддерживаются следующие параметры.
| Параметр | тип | имя | значение |
|---|---|---|---|
| Показывать легенду | 0 | legend | 0 - Отключено; 1 - (по умолчанию) Включено. |
| Отображать мин./средн./макс. | 0 | legend_statistic | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для параметра Показывать легенду установлено значение «Включено» |
| Показывать функцию агрегации | 0 | legend_aggregation | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если для параметра Показывать легенду установлено значение «Включено» |
| Строки | 0 | legend_lines_mode | 0 - (по умолчанию) Фиксированное количество; 1 - Переменное количество. Поведение параметра: - поддерживается, если для параметра Показывать легенду установлено значение «Включено» |
| Количество строк/ Максимальное количество строк |
0 | legend_lines | Допустимые значения: от 1 до 10. По умолчанию: 1. Поведение параметра: - поддерживается, если для параметра Показывать легенду установлено значение «Включено» |
| Количество столбцов | 0 | legend_columns | Допустимые значения: от 1 до 4. По умолчанию: 4. Поведение параметра: - поддерживается, если для параметра Показывать легенду установлено значение «Включено», а для параметра Отображать мин./средн./макс. установлено значение «Отключено» |
Проблемы
Следующие параметры поддерживаются для настройки Проблем.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Показывать проблемы | 0 | show_problems | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Только выбранные элементы данных | 0 | graph_item_problems | 0 - Отключено; 1 - (по умолчанию) Включено. |
|
| Узлы сети с проблемами | 1 | problemhosts.0 | Имя узла сети. Примечание: Число в имени свойства указывает на настроенный узел сети. Чтобы настроить несколько узлов сети, создайте объект поля виджета панели для каждого узла сети, увеличивая число в имени свойства. Этот параметр не поддерживается при настройке виджета на шаблонной панели. |
|
| Серьезность | 0 | severities.0 | 0 - Не классифицировано; 1 - Информация; 2 - Предупреждение; 3 - Средняя; 4 - Высокая; 5 - Катастрофа. По умолчанию: пусто (все включены). Примечание: Чтобы настроить несколько значений, создайте объект поля виджета панели для каждого значения, увеличивая число в имени свойства. |
|
| Проблема | 1 | problem_name | Имя события проблемы (без учета регистра, полное имя или его часть). | |
| Теги проблемы | ||||
| Тип оценки | 0 | evaltype | 0 - (по умолчанию) И/ИЛИ; 2 - ИЛИ. |
|
| Имя тега | 1 | tags.0.tag | Любое строковое значение. Примечание: Число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - обязательно, если настраиваются Теги проблемы |
|
| Оператор | 0 | tags.0.operator | 0 - Содержит; 1 - Равно; 2 - Не содержит; 3 - Не равно; 4 - Существует; 5 - Не существует. Примечание: Число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - обязательно, если настраиваются Теги проблемы |
|
| Значение тега | 1 | tags.0.value | Любое строковое значение. Примечание: Число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - обязательно, если настраиваются Теги проблемы |
|
Переопределения
Для настройки переопределений поддерживаются следующие параметры.
Первое число в имени свойства (например, or.0.hosts.0, or.0.items.0) обозначает определенный набор данных, а второе число, если оно указано, обозначает настроенный узел сети или элемент данных.
| Параметр | тип | имя | значение |
|---|---|---|---|
| Шаблоны узлов сети | 1 | or.0.hosts.0 | Имя или шаблон узла сети (например, Zabbix*).Этот параметр не поддерживается при настройке виджета на панели шаблона. Поведение параметра: - обязателен при настройке переопределений |
| Шаблоны элементов данных | 1 | or.0.items.0 | Имя или шаблон элемента данных (например, *: Number of processed *values per second).При настройке виджета на панели шаблона следует указывать только шаблоны элементов данных, настроенных в шаблоне. Поведение параметра: - обязателен при настройке переопределений |
| Базовый цвет | 1 | or.0.color | Шестнадцатеричный код цвета (например, FF0000). |
| Ширина | 0 | or.0.width | Допустимые значения: от 1 до 10. |
| Отображение | 0 | or.0.type | 0 - Линия; 1 - Точки; 2 - Ступенчатая линия; 3 - Столбцы. |
| Прозрачность | 0 | or.0.transparency | Допустимые значения: от 1 до 10. |
| Заливка | 0 | or.0.fill | Допустимые значения: от 1 до 10. |
| Размер точки | 0 | or.0.pointsize | Допустимые значения: от 1 до 10. |
| Отсутствующие данные | 0 | or.0.missingdatafunc | 0 - Нет; 1 - Соединять; 2 - Считать равными 0; 3 - Последнее известное значение. |
| Ось Y | 0 | or.0.axisy | 0 - Слева; 1 - Справа. |
| Инвертировать значения | 0 | or.0.invert_values | 0 - (по умолчанию) Отключено; 1 - Включено. |
| Смещение времени | 1 | or.0.timeshift | Допустимая строка времени (например, 3600, 1h и т. д.).Можно использовать суффиксы времени. Допускаются отрицательные значения. |
Примеры
Следующие примеры предназначены только для описания конфигурации объектов полей виджета панели мониторинга для виджета Graph.
Дополнительную информацию о настройке панели мониторинга см. в dashboard.create.
Настройка виджета Graph
Настройте виджет Graph следующим образом:
- 2 набора данных для общего числа 9 элементов данных на 1 узле сети.
- Первый набор данных имеет тип "Item list" и состоит из 3 элементов, которые отображаются линиями разного цвета, но с одинаковыми шириной, прозрачностью и заливкой.
- Второй набор данных имеет тип "Item patterns", состоит из 6 элементов, имеет настроенную агрегацию и отображается линией с пользовательскими цветом, шириной, прозрачностью и заливкой.
- Второй набор данных также имеет пользовательскую метку набора данных.
- Данные на графике отображаются за период последних 3 часов.
- Проблемы на графике отображаются только для настроенных элементов данных.
- У графика есть две оси Y, при этом правая ось Y отображает значения только для второго набора данных.
- Легенда графика отображает настроенные элементы данных в 4 строках, а также минимальные, максимальные и средние значения наборов данных.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "svggraph",
"name": "Graph",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.width",
"value": 3
},
{
"type": 0,
"name": "ds.0.transparency",
"value": 3
},
{
"type": 0,
"name": "ds.0.fill",
"value": 1
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.transparency",
"value": 0
},
{
"type": 0,
"name": "ds.1.fill",
"value": 0
},
{
"type": 0,
"name": "ds.1.axisy",
"value": 1
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.aggregate_interval",
"value": "1m"
},
{
"type": 0,
"name": "ds.1.aggregate_grouping",
"value": 1
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_statistic",
"value": 1
},
{
"type": 0,
"name": "legend_lines",
"value": 4
},
{
"type": 0,
"name": "show_problems",
"value": 1
},
{
"type": 1,
"name": "reference",
"value": "YZABC"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}