28 Лучшие элементы данных

Описание

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

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

Параметры

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

Parameter type name value
Refresh interval 0 rf_rate 0 - Без обновления;
10 - 10 секунд;
30 - 30 секунд;
60 - (по умолчанию) 1 минута;
120 - 2 минуты;
600 - 10 минут;
900 - 15 минут.
Host groups 2 groupids.0 ID группы узлов сети.

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

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

Этот параметр не поддерживается при настройке виджета на шаблонной панели.
Hosts 3 hostids.0 ID узла сети.

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

Этот параметр не поддерживается при настройке виджета на шаблонной панели.
Hosts (Widget/Dashboard) 1 hostids._reference Вместо ID узла сети:
DASHBOARD.hostids - задайте селектор Host в качестве источника данных для узлов сети;
ABCDE._hostids - задайте совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети.

Этот параметр не поддерживается при настройке виджета на шаблонной панели.
Host tags
Evaluation type 0 host_tags_evaltype 0 - (по умолчанию) And/Or;
2 - Or.

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

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

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

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

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

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

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

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

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

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

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

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

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 - (по умолчанию) Top N;
3 - Bottom 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 - (по умолчанию) Top N;
3 - Bottom N.
Ограничение 0 item_ordering_limit Допустимый диапазон значений: от 1 до 100.

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

Столбцы

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

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

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

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

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

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

Поведение параметра:
- обязателен при настройке Теги элементов данных
Оператор 0 columns.0.item_tags.0.operator 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

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

Поведение параметра:
- обязателен при настройке Теги элементов данных
Значение тега 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 - Sparkline.
Мин. 1 columns.0.min Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

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

Поведение параметра:
- поддерживается, если для Отображать значение как задано "Числовое", а для Отображение задано "Полоса" или "Индикаторы"
Sparkline
Ширина 0 columns.0.sparkline.width Возможные значения: от 0 до 10.

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

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

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

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

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

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

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

Кроме того, период времени можно задать только в параметрах From и To.

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

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

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

Поведение параметра:
- поддерживается, если для Отображение задано "Sparkline"
Пороги
Цвет 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 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.

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

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

Кроме того, период времени можно задать только в параметрах From и To.

Поведение параметра:
- поддерживается, если для Функция агрегации заданы значения "min", "max", "avg", "count", "sum", "first", "last"
From 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
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 - (по умолчанию) Auto;
1 - History;
2 - Trends.

Поведение параметра:
- поддерживается, если для Отображать значение как задано "Числовое"

Примеры

Следующие примеры предназначены только для описания конфигурации объектов полей виджета панели мониторинга для виджета 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
}

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