25 Точечная диаграмма

Описание

Эти параметры и возможные значения свойств для соответствующих объектов полей виджета позволяют настроить виджет Точечная диаграмма в методах dashboard.create и dashboard.update.

Свойства fields виджета не проверяются при создании или обновлении панели. Это позволяет пользователям изменять встроенные виджеты и создавать пользовательские виджеты, но также создает риск некорректного создания или обновления виджетов. Чтобы обеспечить успешное создание или обновление виджета Точечная диаграмма, обратитесь к описанию поведения параметров в таблицах ниже.

Параметры

Для виджета Точечная диаграмма поддерживаются следующие параметры.

Параметр type name value
Интервал обновления 0 rf_rate 0 - Без обновления;
10 - 10 секунд;
30 - 30 секунд;
60 - (по умолчанию) 1 минута;
120 - 2 минуты;
600 - 10 минут;
900 - 15 минут.
Ссылка 1 reference Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой принадлежит виджет.

Поведение параметра:
- обязательный

Набор данных

Для настройки набора данных поддерживаются следующие параметры.

Первое число в имени свойства (например, ds.0.hosts.0, ds.0.items.0) обозначает конкретный набор данных, а второе число, если оно присутствует, обозначает настроенный узел сети или элемент данных.

Параметр < type name value
Тип набора данных < 0 ds.0.dataset_type 0 - Список элементов данных;
1 - (по умолчанию) Шаблоны элементов данных.
Набор данных: Список элементов данных < < <
Цвет < 1 ds.0.color.0 Шестнадцатеричный код цвета (например, FF0000).

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Список элементов данных"
Ось X < 4 ds.0.x_axis_itemids.0 ID элемента данных.

При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные в шаблоне.

Примечание: Чтобы настроить несколько элементов данных, создайте объект поля виджета панели для каждого элемента данных с увеличенным номером в имени свойства.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Ось X (Виджет) не задана
Ось X (Виджет) < 1 ds.0.x_axis_itemids.0._reference Вместо ID элемента данных:
ABCDE._itemid - задать совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для элементов данных.

Примечание: Чтобы настроить несколько виджетов, создайте объект поля виджета панели для каждого виджета с увеличенным номером в имени свойства.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Ось X не задана
Ось Y < 4 ds.0.y_axis_itemids.0 ID элемента данных.

При настройке виджета на панели шаблона следует указывать только элементы данных, настроенные в шаблоне.

Примечание: Чтобы настроить несколько элементов данных, создайте объект поля виджета панели для каждого элемента данных с увеличенным номером в имени свойства.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Ось Y (Виджет) не задана
Ось Y (Виджет) < 1 ds.0.y_axis_itemids.0._reference Вместо ID элемента данных:
ABCDE._itemid - задать совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для элементов данных.

Примечание: Чтобы настроить несколько виджетов, создайте объект поля виджета панели для каждого виджета с увеличенным номером в имени свойства.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Список элементов данных" и Ось Y не задана
Переопределить узел сети < 1 ds.0.override_hostid._reference ABCDE._hostid- задать совместимый виджет (с параметром "Reference", установленным в "ABCDE") в качестве источника данных для узлов сети;
DASHBOARD._hostid - задать селектор узла сети панели в качестве источника данных для узлов сети.

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Набор данных: Шаблоны элементов данных < < <
Цвет < 1 ds.0.color Шестнадцатеричный код цвета (например, FF0000).

Поведение параметра:
- поддерживается, если Тип набора данных установлен в значение "Шаблоны элементов данных" и Палитра цветов не задана
Палитра цветов < 0 ds.0.color_palette Индекс палитры цветов.

Возможный диапазон значений: 0-11.

По умолчанию: 0.

Поведение параметра:
- поддерживается, если Тип набора данных установлен в значение "Шаблоны элементов данных" и Цвет не задан
Шаблоны узлов сети < 1 ds.0.hosts.0 Имя узла сети или шаблон (например, "Zabbix*").

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Шаблоны элементов данных"

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Шаблоны элементов данных оси X < 1 ds.0.x_axis_items.0 Имя элемента данных или шаблон (например, "*: Number of processed *values per second").

При настройке виджета на панели шаблона следует указывать только шаблоны для элементов данных, настроенных в шаблоне.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Шаблоны элементов данных"
Шаблоны элементов данных оси Y < 1 ds.0.y_axis_items.0 Имя элемента данных или шаблон (например, "*: Number of processed *values per second").

При настройке виджета на панели шаблона следует указывать только шаблоны для элементов данных, настроенных в шаблоне.

Поведение параметра:
- обязателен, если Тип набора данных установлен в значение "Шаблоны элементов данных"
Группы узлов сети < 2 groupids.0 ID группы узлов сети.

Примечание: Чтобы настроить несколько групп узлов сети, создайте объект поля виджета панели для каждой группы узлов сети с увеличенным номером в имени свойства.

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Группы узлов сети (Виджет) < 1 groupids._reference Вместо ID группы узлов сети:
ABCDE._hostgroupids - задать совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для групп узлов сети.

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Переопределить узел сети < 1 ds.0.override_hostid._reference ABCDE._hostid- задать совместимый виджет (с параметром "Reference", установленным в "ABCDE") в качестве источника данных для узлов сети;
DASHBOARD._hostid - задать селектор узла сети панели в качестве источника данных для узлов сети.

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Теги узлов сети < < < <
< Тип вычисления 0 evaltype_host 0 - (по умолчанию) And/Or;
2 - Or.

Этот параметр не поддерживается при настройке виджета на панели шаблона.
^ Имя тега 1 host_tags.0.tag Любое строковое значение.

Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов.

Поведение параметра:
- обязателен, если настраиваются Теги узлов сети

Этот параметр не поддерживается при настройке виджета на панели шаблона.
^ Оператор 0 host_tags.0.operator 0 - Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.

Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов.

Поведение параметра:
- обязателен, если настраиваются Теги узлов сети

Этот параметр не поддерживается при настройке виджета на панели шаблона.
^ Значение тега 1 host_tags.0.value Любое строковое значение.

Примечание: Число в имени свойства указывает порядок тега в списке вычисления тегов.

Поведение параметра:
- обязателен, если настраиваются Теги узлов сети

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Маркер < 0 ds.0.marker 0 - (по умолчанию) Эллипс;
1 - Квадрат;
2 - Треугольник;
3 - Ромб;
4 - Звезда;
5 - Крест.
Размер маркера < 0 ds.0.marker_size 0 - (по умолчанию) Маленький (6px);
1 - Средний (9px);
2 - Большой (15px).
Сдвиг времени < 1 ds.0.timeshift Допустимая строка времени (например, 3600, 1h и т. д.).
Можно использовать суффиксы времени. Также допускаются отрицательные значения.

По умолчанию: "" (пусто).
Интервал агрегации < 1 ds.0.aggregate_interval Допустимая строка времени (например, 3600, 1h и т. д.).
Можно использовать суффиксы времени.

По умолчанию: 15m.
Функция агрегации < 0 ds.0.aggregate_function 0 - не используется;
1 - min;
2 - max;
3 - (по умолчанию) avg;
4 - count;
5 - sum;
6 - first;
7 - last.

Параметры отображения

Для настройки Параметров отображения поддерживаются следующие параметры.

Параметр type name value
Выбор исторических данных 0 source 0 - (по умолчанию) Авто;
1 - История;
2 - Тренды.
Имена узлов сети в метках 0 show_hostnames 0 - (по умолчанию) Авто;
1 - Показывать;
2 - Скрывать.

Этот параметр не поддерживается при настройке виджета на панели шаблона.

Период времени

Для настройки Периода времени поддерживаются следующие параметры.

Параметр type name value
Период времени 1 time_period._reference DASHBOARD._timeperiod — установить селектор периода времени панели мониторинга в качестве источника данных;
ABCDE._timeperiod — установить совместимый виджет (с его параметром Reference, установленным в "ABCDE") в качестве источника данных.

По умолчанию: DASHBOARD._timeperiod

В качестве альтернативы можно задать период времени только в параметрах От и До.
От 1 time_period.from Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или в относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).

Поведение параметра:
- поддерживается, если Период времени не задан
- обязателен, если задан time_period.to
До 1 time_period.to Допустимая строка времени в абсолютном формате (YYYY-MM-DD hh:mm:ss) или в относительном синтаксисе времени (now, now/d, now/w-1w и т. д.).

Поведение параметра:
- поддерживается, если Период времени не задан
- обязателен, если задан time_period.from

Оси

Для настройки осей поддерживаются следующие параметры.

Параметр type name value
Ось X 0 x_axis 0 - Отключено;
1 - (по умолчанию) Включено.
Ось Y 0 y_axis 0 - (по умолчанию) Отключено;
1 - Включено.
Мин. 1 x_axis_min Любое числовое значение.

По умолчанию: "" (пусто).
y_axis_min
Макс. 1 x_axis_max Любое числовое значение.

По умолчанию: "" (пусто).
y_axis_max
Единицы измерения (тип) 0 x_axis_units 0 - (по умолчанию) Авто;
1 - Статически.
y_axis_units
Единицы измерения (значение) 1 x_axis_static_units Любое строковое значение.

По умолчанию: "" (пусто).
y_axis_static_units

Легенда

Следующие параметры поддерживаются для настройки легенды.

Параметр type name value
Показывать легенду 0 legend 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.

Поведение параметра:
- поддерживается, если Показывать легенду установлено в "Включено"

Пороговые значения

Для настройки пороговых значений поддерживаются следующие параметры.

Число в имени свойства Thresholds (например, thresholds.0.color) указывает на позицию порогового значения в списке, отсортированном по возрастанию. Однако, если пороговые значения настроены в другом порядке, после обновления конфигурации виджета в веб-интерфейсе Zabbix значения будут отсортированы по возрастанию (например, "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Параметр type name value
Интерполяция цвета 0 interpolation 0 - (по умолчанию) Отключено;
1 - Включено.
Цвет 1 thresholds.0.color Шестнадцатеричный код цвета (например, FF0000).
Ось X 1 thresholds.0.x_axis_threshold Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").
Ось Y 1 thresholds.0.y_axis_threshold Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

Примеры

Следующие примеры предназначены только для описания настройки объектов полей виджета панели мониторинга для виджета Scatter plot. Для получения дополнительной информации о настройке панели мониторинга см. dashboard.create.

Настройка виджета Scatter plot

Настройте виджет Scatter plot следующим образом:

  • 5 наборов данных типа "Шаблоны элементов данных", каждый с агрегированием по умолчанию (avg, 15m) и разными маркерами.
  • Легенда отображает настроенные элементы данных в одной строке и двух столбцах.
  • Пороговые значения настроены так, чтобы окрашивать маркер в красный цвет, когда его значение достигает 80 по любой из осей.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "scatterplot",
                        "name": "Scatter plot",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "ds.0.color",
                                "value": "0C5A87"
                            },
                            {
                                "type": 1,
                                "name": "ds.0.hosts.0",
                                "value": "de-frankfurt*"
                            },
                            {
                                "type": 1,
                                "name": "ds.0.x_axis_items.0",
                                "value": "Memory utilization"
                            },
                            {
                                "type": 1,
                                "name": "ds.0.y_axis_items.0",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "ds.0.marker",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "ds.0.marker_size",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.1.color",
                                "value": "66B0D9"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.hosts.0",
                                "value": "fr-paris*"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.x_axis_items.0",
                                "value": "Memory utilization"
                            },
                            {
                                "type": 1,
                                "name": "ds.1.y_axis_items.0",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "ds.1.marker",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "ds.1.marker_size",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.2.color",
                                "value": "0A466A"
                            },
                            {
                                "type": 1,
                                "name": "ds.2.hosts.0",
                                "value": "lv-riga*"
                            },
                            {
                                "type": 1,
                                "name": "ds.2.x_axis_items.0",
                                "value": "Memory utilization"
                            },
                            {
                                "type": 1,
                                "name": "ds.2.y_axis_items.0",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "ds.2.marker",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "ds.2.marker_size",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.3.color",
                                "value": "3394C3"
                            },
                            {
                                "type": 1,
                                "name": "ds.3.hosts.0",
                                "value": "pl-warsaw*"
                            },
                            {
                                "type": 1,
                                "name": "ds.3.x_axis_items.0",
                                "value": "Memory utilization"
                            },
                            {
                                "type": 1,
                                "name": "ds.3.y_axis_items.0",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "ds.3.marker",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "ds.3.marker_size",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "ds.4.color",
                                "value": "1492C8"
                            },
                            {
                                "type": 1,
                                "name": "ds.4.hosts.0",
                                "value": "se-stockholm*"
                            },
                            {
                                "type": 1,
                                "name": "ds.4.x_axis_items.0",
                                "value": "Memory utilization"
                            },
                            {
                                "type": 1,
                                "name": "ds.4.y_axis_items.0",
                                "value": "CPU utilization"
                            },
                            {
                                "type": 0,
                                "name": "ds.4.marker",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "ds.4.marker_size",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "legend_columns",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "interpolation",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "D40000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.x_axis_threshold",
                                "value": "80"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.y_axis_threshold",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "D40000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.x_axis_threshold",
                                "value": ""
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.y_axis_threshold",
                                "value": "80"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "JQISY"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

См. также