6 Шкала

Описание

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

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

Параметры

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

Параметр 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 не задан
Min 1 min Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

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

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

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

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

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

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

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

Значения "Стрелка" и "Шкала" не поддерживаются, если одновременно:
- для Show не задан объект поля виджета панели со значением "Value arc";
- параметр дополнительной настройки Show arc установлен в "Disabled".

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

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

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

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

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

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

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

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

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

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

По умолчанию: "" (пусто).
Units
Units (checkbox) 0 units_show 0 - Отключено;
1 - (по умолчанию) Включено.
Units (value) 1 units Любое строковое значение.

Поведение параметра:
- поддерживается, если для Units (checkbox) установлено значение "Enabled"
Size 0 units_size Возможные значения от 1 до 100.

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

Поведение параметра:
- поддерживается, если для Units (checkbox) установлено значение "Enabled"
Bold 0 units_bold 0 - (по умолчанию) Отключено;
1 - Включено.

Поведение параметра:
- поддерживается, если для Units (checkbox) установлено значение "Enabled"
Position 0 units_pos 0 - Перед значением;
1 - Над значением;
2 - (по умолчанию) После значения;
3 - Под значением.

Поведение параметра:
- поддерживается, если для Units (checkbox) установлено значение "Enabled"

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

По умолчанию: "" (пусто).
Value arc
Arc size 0 value_arc_size Возможные значения от 1 до 100.

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

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

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

Поведение параметра:
- поддерживается, если для Units (checkbox) установлено значение "Enabled" и либо для объекта поля виджета панели управления Show со значением "Value arc" задано значение, либо Show arc установлено в "Enabled"
Size 0 scale_size Возможные значения от 1 до 100.

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

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

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

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

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

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

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

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

Примеры

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

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