29 Элементы данных верхнего уровня

Описание

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

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

Параметры

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

Параметр 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 host_tags_evaltype 0 - (по умолчанию) И/Или;
2 - Или.

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

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

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

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

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

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

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

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

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

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Макет 0 layout 0 - (по умолчанию) Горизонтальный;
1 - Вертикальный.
Показывать проблемы 0 show_problems 0 - Все;
1 - (по умолчанию) Неподавленные;
2 - Нет.
Элементы данных (см. ниже)

Расширенная настройка

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

Parameter type name value
Сортировка узлов сети
Сортировать по 0 host_ordering_order_by 0 - (по умолчанию) Имя узла сети;
3 - Значение элемента данных.
Шаблоны элементов данных 1 host_ordering_item.0 Имя или шаблон элемента данных (например, "*: Number of processed *values per second").

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

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

Поведение параметра:
- обязателен, если для параметра Сортировать по установлено значение «Значение элемента данных»
Порядок 0 host_ordering_order 2 - (по умолчанию) Первые N;
3 - Последние N.
Ограничение 0 host_ordering_limit Допустимые значения: от 1 до 100.

По умолчанию: 10.
Сортировка элементов данных
Сортировать по 0 item_ordering_order_by 1 - Узел сети;
2 - Имя элемента данных;
3 - (по умолчанию) Значение элемента данных.
Шаблоны узлов сети 1 item_ordering_host.0 Имя или шаблон узла сети.

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

Поведение параметра:
- обязателен, если для параметра Сортировать по установлено значение «Узел сети»
Порядок 0 item_ordering_order 2 - (по умолчанию) Первые N;
3 - Последние N.
Ограничение 0 item_ordering_limit Допустимые значения: от 1 до 100.

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

Столбцы

Первое число в имени свойства (например, columns.0.items.0, columns.0.item_tags_evaltype) обозначает конкретный столбец, а второе число, если оно указано, обозначает настроенную сущность (например, шаблон элемента данных или тег).

Параметр тип имя значение
Шаблоны элементов данных 1 columns.0.items.0 Имя или шаблон элемента данных (например, "*: Number of processed *values per second").

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

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

Поведение параметра:
- обязательный
Теги элементов данных
Тип вычисления 0 columns.0.item_tags_evaltype 0 - (по умолчанию) И/ИЛИ;
2 - ИЛИ.
Имя тега 1 columns.0.item_tags.0.tag Любое строковое значение.

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

Поведение параметра:
- обязательный при настройке Тегов элементов данных
Оператор 0 columns.0.item_tags.0.operator 0 - Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.

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

Поведение параметра:
- обязательный при настройке Тегов элементов данных
Значение тега 1 columns.0.item_tags.0.value Любое строковое значение.

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

Поведение параметра:
- обязательный при настройке Тегов элементов данных
Базовый цвет 1 columns.0.base_color Шестнадцатеричный код цвета (например, FF0000).
Отображать значение как 0 columns.0.display_value_as 1 - (по умолчанию) Число;
2 - Текст.
Отображение 0 columns.0.display 1 - (по умолчанию) Как есть;
2 - Гистограмма;
3 - Индикаторы;
6 - Спарклайн.
Минимум 1 columns.0.min Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число", а для Отображение — "Гистограмма" или "Индикаторы"
Максимум 1 columns.0.max Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число", а для Отображение — "Гистограмма" или "Индикаторы"
Спарклайн
Ширина 0 columns.0.sparkline.width Допустимые значения находятся в диапазоне от 0 до 10.

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

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
Заполнение 0 columns.0.sparkline.fill Допустимые значения находятся в диапазоне от 0 до 10.

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

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
Цвет 1 columns.0.sparkline.color Шестнадцатеричный код цвета (например, FF0000).

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

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
Период времени 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - использовать селектор периода времени дашборда в качестве источника данных;
ABCDE._timeperiod - использовать совместимый виджет (с параметром reference, равным ABCDE) в качестве источника данных.

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

Также можно задать период времени только в параметрах От и До.

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

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
- обязательный, если задан 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 и т. д.).

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
- обязательный, если задан columns.0.sparkline.time_period.from
Данные истории 0 columns.0.sparkline.history 0 - (по умолчанию) Автоматически;
1 - История;
2 - Тренды.

Поведение параметра:
- поддерживается, если для Отображение установлено значение "Спарклайн"
Пороговые значения
Цвет 1 columns.0.thresholds.0.color Шестнадцатеричный код цвета (например, FF0000).

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число"
Пороговое значение 1 columns.0.thresholds.0.threshold Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число"
Выделения
Выделение 1 columns.0.highlights.0.color Шестнадцатеричный код цвета (например, FF0000).

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Текст"
Пороговое значение 1 columns.0.highlights.0.pattern Любое регулярное выражение.

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Текст"
Десятичные разряды 0 columns.0.decimal_places Допустимые значения находятся в диапазоне от 0 до 10.

По умолчанию: 2.
Расширенная настройка
Функция агрегации 0 columns.0.aggregate_function Если для Отображать значение как установлено значение "Число":
0 - (по умолчанию) не используется;
1 - минимум;
2 - максимум;
3 - среднее;
4 - количество;
5 - сумма;
6 - первое;
7 - последнее.

Если для Отображать значение как установлено значение "Текст":
0 - (по умолчанию) не используется;
4 - количество;
6 - первое;
7 - последнее.
Период времени 1 columns.0.time_period._reference DASHBOARD._timeperiod - использовать селектор периода времени дашборда в качестве источника данных;
ABCDE._timeperiod - использовать совместимый виджет (с параметром reference, равным ABCDE) в качестве источника данных.

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

Также можно задать период времени только в параметрах От и До.

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

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

Поведение параметра:
- поддерживается, если Период времени не задан, а для Функция агрегации установлено значение "минимум", "максимум", "среднее", "количество", "сумма", "первое" или "последнее"
- обязательный, если задан columns.0.time_period.from
Данные истории 0 columns.0.history 0 - (по умолчанию) Автоматически;
1 - История;
2 - Тренды.

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число"
Агрегировать 0 columns.0.aggregate_columns 0 - (по умолчанию) Каждый элемент данных
1 - Объединенные.

Поведение параметра:
- поддерживается, если для Отображать значение как установлено значение "Число", а для Отображение — "Как есть", "Гистограмма" или "Индикаторы".
Функция агрегации объединенных данных 0 columns.0.column_aggregate_function 1 - минимум;
2 - максимум;
3 - среднее;
4 - количество;
5 - сумма (по умолчанию).

Поведение параметра:
- обязательный при настройке Агрегировать.
Имя объединенного столбца 1 columns.0.combined_column_name Любое строковое значение.

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

Примеры

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

Настройка виджета Top items

Настройте виджет Top items, который отображает данные для узла сети "10084" и только для тех элементов данных, у которых тег с именем "component" содержит значение "cpu". Кроме того, отобразите данные так, чтобы узлы сети располагались сверху, и используйте цветную шкалу gauge для представления ячеек.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "topitems",
                        "name": "Top items",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "columns.0.items.0",
                                "value": "*"
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.item_tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "columns.0.item_tags.0.value",
                                "value": "cpu"
                            },
                            {
                                "type": 0,
                                "name": "columns.0.display",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "layout",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

Смотрите также