This is a translation of the original English documentation page. Help us make it better.

12 Honeycomb

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Honeycomb widget in dashboard.create and dashboard.update methods.

Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Honeycomb widget, please refer to the parameter behavior outlined in the tables below.

Parameters

The following parameters are supported for the Honeycomb widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Host groups 2 groupids.0 Host group ID.

Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name.

This parameter is not supported if configuring the widget on a template dashboard.
Hosts 3 hostids.0 Host ID.

Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to.

This parameter is not supported if configuring the widget on a template dashboard.
Host tags
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 host_tags.0.tag Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Host tags
Operator 0 host_tags.0.operator 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Host tags
Tag value 1 host_tags.0.value Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Host tags
Item pattern 1 items.0 Item name or pattern.

Parameter behavior:
- required
Item tags
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Operator 0 item_tags.0.operator 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Tag value 1 item_tags.0.value Any string value.

Note: The number in the property name references tag order in the tag evaluation list.

Parameter behavior:
- required if configuring Item tags
Show hosts in maintenance 0 maintenance 0 - (default) Disabled;
1 - Enabled.
Show 0 show.0 1 - Primary label;
2 - Secondary label.

Note: To configure multiple values, create a dashboard widget field object for each value with an incremented number in the property name.

Default: 1, 2.
Reference 1 reference Any string value consisting of 5 characters (e.g., ABCDE or JBPNL). This value must be unique within the dashboard to which the widget belongs.

Parameter behavior:
- required

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.

Configuring a Honeycomb widget

Configure a Honeycomb widget that displays the utilization of Zabbix server processes. In addition, change the primary label of honeycomb cells and visually fine-tune the widget with thresholds.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": "30",
               "auto_start": "1",
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "honeycomb",
                               "name": "Zabbix server: Utilization of server processes",
                               "x": "0",
                               "y": "0",
                               "width": "8",
                               "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
       }

Response:

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

See also