16 История элементов данных

Описание

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

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

Параметры

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

Параметр type name value
Интервал обновления 0 rf_rate 0 - Без обновления;
10 - 10 секунд;
30 - 30 секунд;
60 - (по умолчанию) 1 минута;
120 - 2 минуты;
600 - 10 минут;
900 - 15 минут.
Макет 0 layout 0 - (по умолчанию) Горизонтальный;
1 - Вертикальный.
Столбцы (см. ниже)
Показывать строки 0 show_lines Возможные значения: от 1 до 100.

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

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Расширенная конфигурация (см. ниже)
Ссылка 1 reference Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой принадлежит виджет.

Поведение параметра:
- required

Столбцы

Столбцы имеют общие параметры и дополнительные параметры в зависимости от конфигурации параметра Элемент данных.

Для всех параметров, относящихся к столбцам, число в имени свойства (например, columns.0.name) указывает на столбец, для которого настраивается этот параметр.

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

Параметр type name value
Имя 1 columns.0.name Любое строковое значение.

Поведение параметра:
- обязательный
Элемент данных 4 columns.0.itemid ID элемента данных.

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

Поведение параметра:
- обязательный
Базовый цвет 1 columns.0.base_color Шестнадцатеричный код цвета (например, FF0000).

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

Следующие параметры столбца поддерживаются, если настроенный элемент данных имеет числовой тип.

Параметр type name value
Отображение 0 columns.0.display 1 - (по умолчанию) Как есть;
2 - Полоса;
3 - Индикаторы.
Мин 1 columns.0.min Любое числовое значение.

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

Поведение параметра:
- поддерживается, если Отображение установлено в "Полоса" или "Индикаторы"
Пороговые значения
Цвет 1 columns.0.thresholds.0.color Шестнадцатеричный код цвета (например, FF0000).
Порог 1 columns.0.thresholds.0.threshold Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").
Данные истории 0 columns.0.history 0 - (по умолчанию) Авто;
1 - История;
2 - Тренды.

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

Параметр type name value
Подсветки
Подсветка 1 columns.0.highlights.0.color Шестнадцатеричный код цвета (например, FF0000).
Порог 1 columns.0.highlights.0.pattern Любое регулярное выражение.
Отображение 0 columns.0.display 1 - (по умолчанию) Как есть;
4 - HTML;
5 - Одна строка.
Одна строка 0 columns.0.max_length Допустимые значения находятся в диапазоне 1-500.

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

Поведение параметра:
- поддерживается, если Отображение установлено в "Одна строка"
Использовать моноширинный шрифт 0 columns.0.monospace_font 0 - (по умолчанию) Использовать шрифт по умолчанию;
1 - Использовать моноширинный шрифт.
Отображать локальное время 0 columns.0.local_time 0 - (по умолчанию) Отображать временную метку;
1 - Отображать локальное время.

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

Следующие параметры столбца поддерживаются, если настроенный Элемент данных имеет двоичный тип.

Параметр type name value
Показывать миниатюру 1 columns.0.show_thumbnail 0 - (по умолчанию) Отключено;
1 - Включено.

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

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

Параметр type name value
Новые значения 0 sortorder 0 - (по умолчанию) Сверху;
1 - Снизу.
Показывать метку времени 0 show_timestamp 0 - (по умолчанию) Отключено;
1 - Включено.
Показывать заголовок столбца 0 show_column_header 0 - Выкл.;
1 - Горизонтально;
2 - (по умолчанию) Вертикально.
Период времени 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

Примеры

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

Настройка виджета История элемента данных

Настройте виджет История элемента данных, отображающий последние данные для двух числовых элементов данных "42269" и "42270". Кроме того, настройте отображение столбцов элементов данных по вертикали, а имен столбцов — по горизонтали; ограничьте вывод 15 строками данных и добавьте отдельный столбец с временной меткой.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemhistory",
                        "name": "Item history",
                        "x": "0",
                        "y": "0",
                        "width": "18",
                        "height": "6",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": "0",
                                "name": "layout",
                                "value": "1"
                            },
                            {
                                "type": "1",
                                "name": "columns.0.name",
                                "value": "CPU utilization"
                            },
                            {
                                "type": "4",
                                "name": "columns.0.itemid",
                                "value": "42269"
                            },
                            {
                                "type": "1",
                                "name": "columns.1.name",
                                "value": "Memory utilization"
                            },
                            {
                                "type": "4",
                                "name": "columns.1.itemid",
                                "value": "42270"
                            },
                            {
                                "type": "0",
                                "name": "show_lines",
                                "value": "15"
                            },
                            {
                                "type": "0",
                                "name": "show_timestamp",
                                "value": "1"
                            },
                            {
                                "type": "0",
                                "name": "show_column_header",
                                "value": "1"
                            },
                            {
                                "type": "1",
                                "name": "reference",
                                "value": "KIVKD"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

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