18 Значение элемента данных

Описание

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

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

Параметры

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

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

Поведение параметра:
- required если Item (Widget) не задан
Item (Widget) 1 itemid._reference Вместо ID элемента данных:
ABCDE._itemid - задайте совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для элементов данных.

Поведение параметра:
- required если Item не задан
Show 0 show.0 1 - Описание;
2 - Значение;
3 - Время;
4 - Индикатор изменения;
5 - Sparkline.

По умолчанию: 1, 2, 3, 4.

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

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

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

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

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

Parameter type name value
Цвет фона 1 bg_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Пороги
Цвет 1 thresholds.0.color Шестнадцатеричный код цвета (например, FF0000).
Порог 1 thresholds.0.threshold Любое строковое значение.
Функция агрегации 0 aggregate_function 0 - (по умолчанию) не используется;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Период времени 1 time_period._reference DASHBOARD._timeperiod - использовать селектор периода времени в качестве источника данных;
ABCDE._timeperiod - использовать совместимый виджет (со значением параметра reference, равным ABCDE) в качестве источника данных.

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

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

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

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

Поведение параметра:
- поддерживается, если Период времени не задан и для Функция агрегации установлено значение "min", "max", "avg", "count", "sum", "first", "last"
- обязательно, если задан time_period.from
Исторические данные 0 history 0 - (по умолчанию) Auto;
1 - History;
2 - Trends.
Описание

Следующие параметры расширенной конфигурации поддерживаются, если для Show установлено значение "Description".

Parameter type name value
Description 1 description Любое строковое значение, включая макросы.
Поддерживаемые макросы: {HOST.*}, {ITEM.*}, {INVENTORY.*}, пользовательские макросы.

По умолчанию: {ITEM.NAME}.
Horizontal position 0 desc_h_pos 0 - Слева;
1 - (по умолчанию) По центру;
2 - Справа.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые Horizontal position и Vertical position.
Vertical position 0 desc_v_pos 0 - Сверху;
1 - Посередине;
2 - (по умолчанию) Снизу.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые Horizontal position и Vertical position.
Size 0 desc_size Возможные значения: от 1 до 100.

По умолчанию: 15.
Bold 0 desc_bold 0 - (по умолчанию) Отключено;
1 - Включено.
Color 1 desc_color Шестнадцатеричный код цвета (например, FF0000).

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

Следующие параметры расширенной конфигурации поддерживаются, если для Show установлено значение "Value".

Parameter type name value
Десятичные знаки
Десятичные знаки 0 decimal_places Допустимые значения: от 1 до 10.

По умолчанию: 2.
Размер 0 decimal_size Допустимые значения: от 1 до 100.

По умолчанию: 35.
Положение
Горизонтальное положение 0 value_h_pos 0 - Слева;
1 - (по умолчанию) По центру;
2 - Справа.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые значения Horizontal position и Vertical position.
Вертикальное положение 0 value_v_pos 0 - Сверху;
1 - (по умолчанию) По центру;
2 - Снизу.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые значения Horizontal position и Vertical position.
Размер 0 value_size Допустимые значения: от 1 до 100.

По умолчанию: 45.
Полужирный 0 value_bold 0 - Отключено;
1 - (по умолчанию) Включено.
Цвет 1 value_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Единицы
Единицы (флажок) 0 units_show 0 - Отключено;
1 - (по умолчанию) Включено.
Единицы (значение) 1 units Любое строковое значение.
Положение 0 units_pos 0 - Перед значением;
1 - Над значением;
2 - (по умолчанию) После значения;
3 - Под значением.
Размер 0 units_size Допустимые значения: от 1 до 100.

По умолчанию: 35.
Полужирный 0 units_bold 0 - Отключено;
1 - (по умолчанию) Включено.
Цвет 1 units_color Шестнадцатеричный код цвета (например, FF0000).

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

Следующие параметры расширенной настройки поддерживаются, если для Show установлено значение "Time".

Parameter type name value
Горизонтальное положение 0 time_h_pos 0 - Слева;
1 - (по умолчанию) По центру;
2 - Справа.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые Горизонтальное положение и Вертикальное положение.
Вертикальное положение 0 time_v_pos 0 - (по умолчанию) Сверху;
1 - Посередине;
2 - Снизу.

Два или более элементов (Description, Value, Time) не могут иметь одинаковые Горизонтальное положение и Вертикальное положение.
Размер 0 time_size Допустимые значения находятся в диапазоне от 1 до 100.

По умолчанию: 15.
Полужирный 0 time_bold 0 - (по умолчанию) Отключено;
1 - Включено.
Цвет 1 time_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Индикатор изменения

Следующие параметры расширенной конфигурации поддерживаются, если для Показывать установлено значение "Индикатор изменения".

Parameter type name value
Цвет индикатора изменения ↑ 1 up_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Цвет индикатора изменения ↓ 1 down_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Цвет индикатора изменения ↕ 1 updown_color Шестнадцатеричный код цвета (например, FF0000).

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

Следующие параметры расширенной настройки поддерживаются, если для Show установлено значение "Sparkline".

Parameter type name value
Width 0 sparkline.width Допустимые значения: от 0 до 10.

По умолчанию: 1.
Fill 0 sparkline.fill Допустимые значения: от 0 до 10.

По умолчанию: 3.
Color 1 sparkline.color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - использовать селектор Time period в качестве источника данных;
ABCDE._timeperiod - использовать совместимый виджет (с параметром reference, равным ABCDE) в качестве источника данных.

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

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

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

Поведение параметра:
- required, если задан sparkline.time_period.from
History data 0 sparkline.history 0 - (по умолчанию) Auto;
1 - History;
2 - Trends.

Примеры

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

Настройка виджета Item value

Настройте виджет Item value, который отображает значение элемента данных для элемента данных "42266" (доступность агента Zabbix). Кроме того, визуально доработайте виджет с помощью нескольких расширенных параметров, включая динамический цвет фона, который изменяется в зависимости от статуса доступности агента Zabbix.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "item",
                        "name": "Item value",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42266
                            },
                            {
                                "type": 0,
                                "name": "show.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show.1",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "show.2",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "description",
                                "value": "Agent status"
                            },
                            {
                                "type": 0,
                                "name": "desc_h_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "desc_v_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "desc_bold",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "desc_color",
                                "value": "F06291"
                            },
                            {
                                "type": 0,
                                "name": "value_h_pos",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "value_size",
                                "value": 25
                            },
                            {
                                "type": 1,
                                "name": "value_color",
                                "value": "FFFF00"
                            },
                            {
                                "type": 0,
                                "name": "units_show",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "time_h_pos",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "time_v_pos",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "time_size",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "time_bold",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "time_color",
                                "value": "9FA8DA"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "E1E1E1"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "D1C4E9"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "1"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

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