6. Индикатор

Описание

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

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

Параметры

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

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

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

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

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

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

По умолчанию: "" (пусто).
Фон дуги 1 empty_color Шестнадцатеричный код цвета (например, FF0000).

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

По умолчанию: "" (пусто).
Показывать 0 show.0 1 - Описание;
2 - Значение;
3 - Стрелка;
4 - Шкала;
5 - Дуга значения.

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

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

Значения "Стрелка" и "Шкала" не поддерживаются, если одновременно:
- не задан ни один объект поля виджета панели для Показывать со значением "Дуга значения";
- параметр расширенной конфигурации Показывать дугу установлен в значение "Отключено".

Параметры расширенной конфигурации для опций Показывать не поддерживаются, если не заданы объекты поля виджета панели с соответствующими значениями.
Переопределить узел сети 1 override_hostid._reference ABCDE._hostid — задать совместимый виджет (с параметром Reference, установленным в "ABCDE") в качестве источника данных для узлов сети;
DASHBOARD._hostid — задать селектор узла сети панели в качестве источника данных для узлов сети.

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

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

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

Число в имени свойства 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 angle Возможные значения: 180 (по умолчанию) или 270.
Описание
Описание 1 description Любое строковое значение, включая макросы.
Поддерживаемые макросы: {HOST.*}, {ITEM.*}, {INVENTORY.*}, пользовательские макросы.

По умолчанию: {ITEM.NAME}.
Размер 0 desc_size Возможные значения: от 1 до 100.

По умолчанию: 15.
Вертикальное положение 0 desc_v_pos 0 - Сверху;
1 - (по умолчанию) Снизу.
Жирный 0 desc_bold 0 - (по умолчанию) Отключено;
1 - Включено.
Цвет 1 desc_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Значение
Десятичные знаки 0 decimal_places Возможные значения: от 1 до 10.

По умолчанию: 2.
Размер 0 value_size Возможные значения: от 1 до 100.

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

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

Поведение параметра:
- поддерживается, если Единицы измерения (флажок) установлено в значение "Включено"
Размер 0 units_size Возможные значения: от 1 до 100.

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

Поведение параметра:
- поддерживается, если Единицы измерения (флажок) установлено в значение "Включено"
Жирный 0 units_bold 0 - (по умолчанию) Отключено;
1 - Включено.

Поведение параметра:
- поддерживается, если Единицы измерения (флажок) установлено в значение "Включено"
Положение 0 units_pos 0 - Перед значением;
1 - Над значением;
2 - (по умолчанию) После значения;
3 - Под значением.

Поведение параметра:
- поддерживается, если Единицы измерения (флажок) установлено в значение "Включено"

Этот параметр игнорируется, если задана одна из следующих единиц измерения, связанных со временем: unixtime, uptime, s.
Цвет 1 units_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: "" (пусто).
Дуга значения
Размер дуги 0 value_arc_size Возможные значения: от 1 до 100.

По умолчанию: 20.
Стрелка
Цвет 1 needle_color Шестнадцатеричный код цвета (например, FF0000).

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

Поведение параметра:
- поддерживается, если задан объект поля виджета панели мониторинга для Show со значением "Value arc", или Show arc установлено в значение "Включено"
Шкала
Показывать единицы измерения 0 scale_show_units 0 - Отключено;
1 - (по умолчанию) Включено.

Поведение параметра:
- поддерживается, если Единицы измерения (флажок) установлено в значение "Включено" и либо задан объект поля виджета панели мониторинга для Show со значением "Value arc", либо Show arc установлено в значение "Включено"
Размер 0 scale_size Возможные значения: от 1 до 100.

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

Поведение параметра:
- поддерживается, если задан объект поля виджета панели мониторинга для Show со значением "Value arc", или Show arc установлено в значение "Включено"
Десятичные знаки 0 scale_decimal_places Возможные значения: от 1 до 10.

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

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

Поведение параметра:
- поддерживается, если Пороги заданы и либо задан объект поля виджета панели мониторинга для Show со значением "Value arc", либо Show arc установлено в значение "Включено"
Показывать дугу 0 th_show_arc 0 - (по умолчанию) Отключено;
1 - Включено.

Поведение параметра:
- поддерживается, если Пороги заданы
Размер дуги 0 th_arc_size Возможные значения: от 1 до 100.

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

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

Примеры

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

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

Настройте виджет Gauge, отображающий значение элемента данных для элемента данных "44474" (Interface enp0s3: Bits sent). Кроме того, выполните визуальную тонкую настройку виджета с помощью нескольких дополнительных параметров, включая пороговые значения.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "gauge",
                        "name": "Gauge",
                        "x": 0,
                        "y": 0,
                        "width": 18,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 44474
                            },
                            {
                                "type": 1,
                                "name": "min",
                                "value": "100000"
                            },
                            {
                                "type": 1,
                                "name": "max",
                                "value": "1000000"
                            },
                            {
                                "type": 0,
                                "name": "show.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show.1",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "show.2",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "show.4",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show.5",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "angle",
                                "value": 270
                            },
                            {
                                "type": 0,
                                "name": "desc_size",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "desc_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "decimal_places",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "value_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_size",
                                "value": 15
                            },
                            {
                                "type": 0,
                                "name": "units_pos",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "needle_color",
                                "value": "3C3C3C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "700000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "500000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "100000"
                            },
                            {
                                "type": 0,
                                "name": "th_show_labels",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_show_arc",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_arc_size",
                                "value": 15
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

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