11 Honeycomb

Описание

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

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

Параметры

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

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

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

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

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

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

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

Этот параметр не поддерживается при настройке виджета на шаблонной панели.
Host tags
Evaluation type 0 evaltype_host 0 - (по умолчанию) And/Or;
2 - Or.

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

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

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

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

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

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

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

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

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

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

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

Поведение параметра:
- обязательно
Item tags
Evaluation type 0 evaltype_item 0 - (по умолчанию) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag Любое строковое значение.

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

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

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

Поведение параметра:
- обязательно при настройке Item tags
Tag value 1 item_tags.0.value Любое строковое значение.

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

Поведение параметра:
- обязательно при настройке Item tags
Show hosts in maintenance 0 maintenance 0 - (по умолчанию) Отключено;
1 - Включено.
Show 0 show.0 1 - Основная метка;
2 - Вторичная метка.

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

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

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

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

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

Число в имени свойства 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
Primary label
Type 0 primary_label_type 0 - (по умолчанию) Текст;
1 - Значение.
Text 1 primary_label Любое строковое значение, включая макросы.
Поддерживаемые макросы: {HOST.*}, {ITEM.*}, {INVENTORY.*}, пользовательские макросы.

По умолчанию: {HOST.NAME}

Поведение параметра:
- поддерживается, если для Type задано значение "Text"
Decimal places 0 primary_label_decimal_places Допустимые значения: от 0 до 6.

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

Поведение параметра:
- поддерживается, если для Type задано значение "Value"
Size (type) 0 primary_label_size_type 0 - (по умолчанию) Авто;
1 - Пользовательский.
Size 0 primary_label_size Допустимые значения: от 1 до 100.

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

Поведение параметра:
- поддерживается, если для Size (type) задано значение "Custom"
Bold 0 primary_label_bold 0 - (по умолчанию) Отключено;
1 - Включено.
Color 1 primary_label_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: зависит от theme в объекте Settings и объекте User:
1F2C33 для "blue-theme" или "hc-light";
EEEEEE для "dark-theme" или "hc-dark".
Units (checkbox) 0 primary_label_units_show 0 - Отключено;
1 - (по умолчанию) Включено.

Поведение параметра:
- поддерживается, если для Type задано значение "Value"
Units (value) 1 primary_label_units Любое строковое значение.

"" (пусто)

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

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

Этот параметр игнорируется, если для него задано одно из следующих единиц времени: unixtime, uptime, s.
Secondary label
Type 0 secondary_label_type 0 - Текст;
1 - (по умолчанию) Значение.
Text 1 secondary_label Любое строковое значение, включая макросы.
Поддерживаемые макросы: {HOST.*}, {ITEM.*}, {INVENTORY.*}, пользовательские макросы.

По умолчанию: {{ITEM.LASTVALUE}.fmtnum(2)}

Поведение параметра:
- поддерживается, если для Type задано значение "Text"
Decimal places 0 secondary_label_decimal_places Допустимые значения: от 0 до 6.

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

Поведение параметра:
- поддерживается, если для Type задано значение "Value"
Size (type) 0 secondary_label_size_type 0 - (по умолчанию) Авто;
1 - Пользовательский.
Size 0 secondary_label_size Допустимые значения: от 1 до 100.

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

Поведение параметра:
- поддерживается, если для Size (type) задано значение "Custom"
Bold 0 secondary_label_bold 0 - Отключено;
1 - (по умолчанию) Включено.
Color 1 secondary_label_color Шестнадцатеричный код цвета (например, FF0000).

По умолчанию: зависит от theme в объекте Settings и объекте User:
1F2C33 для "blue-theme" или "hc-light";
EEEEEE для "dark-theme" или "hc-dark".
Units (checkbox) 0 secondary_label_units_show 0 - Отключено;
1 - (по умолчанию) Включено.

Поведение параметра:
- поддерживается, если для Type задано значение "Value"
Units (value) 1 secondary_label_units Любое строковое значение.

"" (пусто)

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

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

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

По умолчанию: зависит от theme в объекте Settings и объекте User:
D9E7ED для "blue-theme";
3D5059 для "dark-theme";
AAD7E9 для "hc-light";
335463 для "hc-dark".
Thresholds
Color interpolation 0 interpolation 0 - Отключено;
1 - (по умолчанию) Включено.
Color 1 thresholds.0.color Шестнадцатеричный код цвета (например, FF0000).
Threshold 1 thresholds.0.threshold Любое числовое значение. Поддерживаются суффиксы (например, "1d", "2w", "4K", "8G").

Примеры

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

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