11. Ячеистая диаграмма

Описание

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

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

Параметры

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

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

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

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

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

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

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

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Теги узлов сети
Тип вычисления 0 evaltype_host 0 - (по умолчанию) И/Или;
2 - Или.

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

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

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

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

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

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

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

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

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

Этот параметр не поддерживается при настройке виджета на панели шаблона.
Шаблоны элементов данных 1 items.0 Имя или шаблон элемента данных.

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

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

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

Поведение параметра:
- обязательно при настройке Тегов элементов данных
Оператор 0 item_tags.0.operator 0 - Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.

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

Поведение параметра:
- обязательно при настройке Тегов элементов данных
Значение тега 1 item_tags.0.value Любое строковое значение.

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

Поведение параметра:
- обязательно при настройке Тегов элементов данных
Показывать узлы сети в обслуживании 0 maintenance 0 - (по умолчанию) Отключено;
1 - Включено.
Показывать 0 show.0 1 - Основная метка;
2 - Дополнительная метка.

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

По умолчанию: 1, 2.
Reference 1 reference Любое строковое значение, состоящее из 5 символов (например, ABCDE или JBPNL). Это значение должно быть уникальным в пределах панели, к которой принадлежит виджет.

Поведение параметра:
- обязательно

Advanced configuration

The following advanced configuration parameters are supported for the Honeycomb widget.

The number in the Thresholds property name (e.g. thresholds.0.color) references the threshold place in a list, sorted in ascending order. However, if thresholds are configured in a different order, the values will be sorted in ascending order after updating widget configuration in Zabbix frontend (e.g. "thresholds.0.threshold":"5" → "thresholds.0.threshold":"1"; "thresholds.1.threshold":"1" → "thresholds.1.threshold": "5").

Parameter type name value
Primary label
Type 0 primary_label_type 0 - (default) Text;
1 - Value.
Text 1 primary_label Any string value, including macros.
Supported macros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, user macros.

Default: {HOST.NAME}

Parameter behavior:
- supported if Type is set to "Text"
Decimal places 0 primary_label_decimal_places Possible values range from 0-6.

Default: 2.

Parameter behavior:
- supported if Type is set to "Value"
Size (type) 0 primary_label_size_type 0 - (default) Auto;
1 - Custom.
Size 0 primary_label_size Possible values range from 1-100.

Default: 20.

Parameter behavior:
- supported if Size (type) is set to "Custom"
Bold 0 primary_label_bold 0 - (default) Disabled;
1 - Enabled.
Color 1 primary_label_color Hexadecimal color code (e.g. FF0000).

Default: based on theme of Settings object and User object:
1F2C33 for "blue-theme" or "hc-light";
EEEEEE for "dark-theme" or "hc-dark".
Units (checkbox) 0 primary_label_units_show 0 - Disabled;
1 - (default) Enabled.

Parameter behavior:
- supported if Type is set to "Value"
Units (value) 1 primary_label_units Any string value.

"" (empty)

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"
Position 0 primary_label_units_pos 0 - Before value;
1 - (default) After value.

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"

This parameter is ignored if set to one of the following time-related units: unixtime, uptime, s.
Secondary label
Type 0 secondary_label_type 0 - Text;
1 - (default) Value.
Text 1 secondary_label Any string value, including macros.
Supported macros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, user macros.

Default: {{ITEM.LASTVALUE}.fmtnum(2)}

Parameter behavior:
- supported if Type is set to "Text"
Decimal places 0 secondary_label_decimal_places Possible values range from 0-6.

Default: 2.

Parameter behavior:
- supported if Type is set to "Value"
Size (type) 0 secondary_label_size_type 0 - (default) Auto;
1 - Custom.
Size 0 secondary_label_size Possible values range from 1-100.

Default: 30.

Parameter behavior:
- supported if Size (type) is set to "Custom"
Bold 0 secondary_label_bold 0 - Disabled;
1 - (default) Enabled.
Color 1 secondary_label_color Hexadecimal color code (e.g. FF0000).

Default: based on theme of Settings object and User object:
1F2C33 for "blue-theme" or "hc-light";
EEEEEE for "dark-theme" or "hc-dark".
Units (checkbox) 0 secondary_label_units_show 0 - Disabled;
1 - (default) Enabled.

Parameter behavior:
- supported if Type is set to "Value"
Units (value) 1 secondary_label_units Any string value.

"" (empty)

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"
Position 0 secondary_label_position 0 - Before value;
1 - (default) After value.

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"

This parameter is ignored if set to one of the following time-related units: unixtime, uptime, s.
Background color
Background color 1 bg_color Hexadecimal color code (e.g. FF0000).

Default: based on theme of Settings object and User object:
D9E7ED for "blue-theme";
3D5059 for "dark-theme";
AAD7E9 for "hc-light";
335463 for "hc-dark".
Thresholds
Color interpolation 0 interpolation 0 - Disabled;
1 - (default) Enabled.
Color 1 thresholds.0.color Hexadecimal color code (e.g. FF0000).
Threshold 1 thresholds.0.threshold Any numeric value. Suffixes (e.g. "1d", "2w", "4K", "8G") are supported.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Honeycomb widget. For more information on configuring a dashboard, see dashboard.create.

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

Настройте виджет Honeycomb, отображающий использование процессов сервера Zabbix. Кроме того, измените основную метку ячеек honeycomb и визуально донастройте виджет с помощью порогов.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "honeycomb",
                        "name": "Honeycomb",
                        "x": "0",
                        "y": "0",
                        "width": "24",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "items.0",
                                "value": "Zabbix server: Utilization*"
                            },
                            {
                                "type": 1,
                                "name": "primary_label",
                                "value": "{ITEM.NAME}"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "70"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "KSTMQ"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

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

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