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) обозначает конкретный набор данных, а второе число, если оно присутствует, обозначает настроенный узел сети или элемент данных.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Тип набора данных | 0 | ds.0.dataset_type | 0 - Список элементов данных; 1 - (по умолчанию) Шаблоны элементов данных. |
|
| Элементы данных | 4 | ds.0.itemids.0 | ID элемента данных. При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные на шаблоне. Примечание: чтобы настроить несколько элементов данных, создайте объект поля виджета панели для каждого элемента, увеличивая номер в имени свойства. Поведение параметра: - обязателен, если Тип набора данных установлен в "Список элементов данных" и Элементы данных (Виджет) не задан |
|
| Элементы данных (Виджет) | 1 | ds.0.itemids.0._reference | Вместо ID элемента данных:ABCDE._itemid - укажите совместимый виджет (с параметром Reference, установленным в "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- укажите совместимый виджет (с параметром "Reference", установленным в "ABCDE") в качестве источника данных для узлов сети;DASHBOARD._hostid - укажите селектор узлов сети на панели в качестве источника данных для узлов сети.Этот параметр не поддерживается при настройке виджета на панели шаблона. |
|
| Ось Y | 0 | ds.0.axisy | 0 - (по умолчанию) Левая; 1 - Правая. |
|
| Сдвиг времени | 1 | ds.0.timeshift | Допустимая строка времени (например, 3600, 1h и т. д.).Можно использовать суффиксы времени. Также допускаются отрицательные значения. По умолчанию: "" (пусто). |
|
| Функция агрегации | 0 | ds.0.aggregate_function | 0 - (по умолчанию) не используется; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Интервал агрегации | 1 | ds.0.aggregate_interval | Допустимая строка времени (например, 3600, 1h и т. д.).Можно использовать суффиксы времени. По умолчанию: 1h. |
|
| Агрегировать | 0 | ds.0.aggregate_grouping | 0 - (по умолчанию) Каждый элемент данных; 1 - Набор данных. Поведение параметра: - поддерживается, если Функция агрегации установлена в "min", "max", "avg", "count", "sum", "first" или "last" |
|
| Аппроксимация | 0 | ds.0.approximation | 1 - min; 2 - (по умолчанию) avg; 4 - max; 7 - all. |
|
| Метка набора данных | 1 | ds.0.data_set_label | Любое строковое значение. По умолчанию: "" (пусто). |
|
Параметры отображения
Следующие параметры поддерживаются для настройки Параметров отображения.
| Параметр | type | name | value | |
|---|---|---|---|---|
| Выбор исторических данных | 0 | source | 0 - (по умолчанию) Авто; 1 - История; 2 - Тренды. |
|
| Простые триггеры | 0 | simple_triggers | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Рабочее время | 0 | working_time | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Линия перцентиля (слева) | ||||
| Состояние | 0 | percentile_left | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если Ось Y (в конфигурации Набор данных) установлена в "Left" |
|
| Значение | 0 | percentile_left_value | Допустимые значения: от 1 до 100. Поведение параметра: - поддерживается, если Ось Y (в конфигурации Набор данных) установлена в "Left" |
|
| Линия перцентиля (справа) | ||||
| Состояние | 0 | percentile_right | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если Ось Y (в конфигурации Набор данных) установлена в "Right" |
|
| Значение | 0 | percentile_right_value | Допустимые значения: от 1 до 100. Поведение параметра: - поддерживается, если Ось Y (в конфигурации Набор данных) установлена в "Right" |
|
Период времени
Следующие параметры поддерживаются для настройки Периода времени.
| 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 |
|---|---|---|---|
| Left Y | 0 | lefty | 0 - Отключено; 1 - (по умолчанию) Включено. Поведение параметра: - поддерживается, если Y-axis (в конфигурации Data set) установлено в "Left" |
| Right Y | 0 | righty | 0 - (по умолчанию) Отключено; 1 - Включено. Поведение параметра: - поддерживается, если Y-axis (в конфигурации Data set) установлено в "Right" |
| Scale | 0 | lefty_scale | 0 - (по умолчанию) Линейная; 1 - Логарифмическая. |
| righty_scale | |||
| Min | 1 | lefty_min | Любое числовое значение. По умолчанию: "" (пусто). |
| righty_min | |||
| Max | 1 | lefty_max | Любое числовое значение. По умолчанию: "" (пусто). |
| righty_max | |||
| Units (type) | 0 | lefty_units | 0 - (по умолчанию) Авто; 1 - Статический. |
| righty_units | |||
| Units (value) | 1 | lefty_static_units | Любое строковое значение. По умолчанию: "" (пусто). |
| righty_static_units | |||
| X-Axis | 0 | xaxis | 0 - Отключено; 1 - (по умолчанию) Включено. |
Легенда
Следующие параметры поддерживаются для настройки Легенда.
| Parameter | type | name | value |
|---|---|---|---|
| Показывать легенду | 0 | legend | 0 - Отключено; 1 - (по умолчанию) Включено. Поведение параметра: - поддерживается, если для Показывать легенду установлено значение "Включено" |
| Показывать min/avg/max | 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. Поведение параметра: - поддерживается, если для Показывать легенду установлено значение "Включено", а для Показывать min/avg/max установлено значение "Отключено" |
Проблемы
Следующие параметры поддерживаются для настройки Problems.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Show problems | 0 | show_problems | 0 - (по умолчанию) Отключено; 1 - Включено. |
|
| Selected items only | 0 | graph_item_problems | 0 - Отключено; 1 - (по умолчанию) Включено. |
|
| Problem hosts | 1 | problemhosts.0 | Имя узла сети. Примечание: число в имени свойства указывает на настроенный узел сети. Чтобы настроить несколько узлов сети, создайте объект поля виджета панели для каждого узла сети, увеличивая число в имени свойства. Этот параметр не поддерживается при настройке виджета на шаблонной панели. |
|
| Severity | 0 | severities.0 | 0 - Не классифицировано; 1 - Информация; 2 - Предупреждение; 3 - Средняя; 4 - Высокая; 5 - Катастрофа. По умолчанию: пусто (все включены). Примечание: чтобы настроить несколько значений, создайте объект поля виджета панели для каждого значения, увеличивая число в имени свойства. |
|
| Problem | 1 | problem_name | Имя события проблемы (без учета регистра, полное имя или его часть). | |
| Problem tags | ||||
| Evaluation type | 0 | evaltype | 0 - (по умолчанию) И/ИЛИ; 2 - ИЛИ. |
|
| Tag name | 1 | tags.0.tag | Любое строковое значение. Примечание: число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - required если настраивается Problem tags |
|
| Operator | 0 | tags.0.operator | 0 - Содержит; 1 - Равно; 2 - Не содержит; 3 - Не равно; 4 - Существует; 5 - Не существует. Примечание: число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - required если настраивается Problem tags |
|
| Tag value | 1 | tags.0.value | Любое строковое значение. Примечание: число в имени свойства указывает на порядок тега в списке оценки тегов. Поведение параметра: - required если настраивается Problem tags |
|
Переопределения
Следующие параметры поддерживаются для настройки Переопределений.
Первое число в имени свойства (например, or.0.hosts.0, or.0.items.0) представляет конкретный набор данных, а второе число, если оно присутствует, представляет настроенный узел сети или элемент данных.
| Parameter | type | name | value |
|---|---|---|---|
| Шаблоны узлов сети | 1 | or.0.hosts.0 | Узел сети name or pattern (e.g. Zabbix*).Этот параметр не поддерживается при настройке виджета на шаблонной панели. Поведение параметра: - required if configuring Overrides |
| Шаблоны элементов данных | 1 | or.0.items.0 | Элемент данных name or pattern (e.g. *: Number of processed *values per second).При настройке виджета на шаблонной панели следует задавать только шаблоны для элементов данных, настроенных на шаблоне. Поведение параметра: - required if configuring Overrides |
| Базовый цвет | 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 - Правая. |
| Сдвиг времени | 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
}