11 蜂窝图

描述

这些参数及对应仪表板小组件字段objects的可选属性值,允许通过dashboard.createdashboard.update方法配置Honeycomb小组件。

仪表板创建或update过程中不会验证fields小组件的属性。
这允许用户修改built-in widgets和createcustom widgets,但也存在错误创建或更新小组件的风险。
为确保Honeycomb小组件成功创建或update,请参考下文表格中列出的参数行为规范。

参数

Honeycomb 小部件支持以下参数。

参数 仪表板小部件字段 名称
Refresh interval 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟.
Host groups 2 groupids.0 Host group ID.

注意:如需配置多个主机组,需为每个主机组在属性名中使用递增数字create仪表板小部件字段object。

若在template dashboard上配置该小部件,则不支持此参数。
主机 组 (小部件) 1 groupids._reference 替代使用 Host group ID:
ABCDE._hostgroupids - 将 部件兼容性 (其 Reference 参数设置为 "ABCDE") 设为 主机 组的数据源.

如果在 template dashboard 上配置此小部件, 则不支持此参数.
Hosts 3 hostids.0 Host ID.

注意:如需配置多个主机,需为每个主机在属性名称中使用递增数字create仪表板小部件字段object。对于多个主机,参数主机组必须完全不配置,或至少配置一个包含所配置主机的主机组。

template dashboard上配置该小部件时,此参数不受支持。
主机 (小部件/仪表盘) 1 hostids._reference 替代使用Host ID:
DASHBOARD.hostids - 将覆盖主机设置为主机的数据源;
ABCDE._hostids - 设置一个部件兼容性 (其Reference参数设为"ABCDE")作为主机的数据源.

如果在template dashboard上配置该小部件,则不支持此参数.
Host tags
评估类型 0 evaltype_host 0 - (默认) 与/或;
2 - 或.

如果在template dashboard上配置小部件,则不支持此参数.
标签名称 1 host_tags.0.tag 任意string值。

注意:属性名称中的数字对应标签评估列表中的标签顺序。

参数行为:
- 配置主机标签时为必填项

template dashboard上配置该部件时不支持此参数。
运算符 0 host_tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在.

注意: 属性名称中的数字引用标签评估列表中的标签顺序.

参数行为:
- 必需 如果配置 主机 标签

如果在 template dashboard 上配置小部件,则不支持此参数.
标签值 1 host_tags.0.value 任意string值。

注意:属性名称中的数字引用标签评估列表中的标签顺序。

参数行为:
- 必填 如果配置主机标签

如果在template dashboard上配置小部件,则不支持此参数。
Item patterns 1 items.0 Item 名称或模式.

注意: 如需配置多个监控项模式, create 仪表板小部件字段object 为每个监控项模式在属性名称中使用递增数字.

参数行为:
- 必填
Item tags
评估类型 0 evaltype_item 0 - (默认) 与/或;
2 - 或.
标签名称 1 item_tags.0.tag 任意string值。

注意:属性名称中的数字对应标签评估列表中的标签顺序。

参数行为:
- 配置监控项标签时为必填项
运算符 0 item_tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在.

注意: 属性名称中的数字引用标签评估列表中的标签顺序.

参数行为:
- 必填 如果配置 监控项标签
标签值 1 item_tags.0.value 任意string值。

注意:属性名称中的数字引用标签评估列表中的标签顺序。

参数行为:
- 必填(当配置监控项标签时)
Show hosts in maintenance 0 maintenance 0 - (默认) 禁用;
1 - 启用.
Show 0 show.0 1 - 主标签;
2 - 次标签.

注意: 要配置多个值, 请create仪表板小部件字段object, 为每个值在属性名称中使用递增数字.

默认值: 1, 2.
Reference 1 reference 任何由5个字符组成的string值(例如ABCDEJBPNL)。该值在仪表板所属的小部件中必须唯一。

参数行为:
- 必填

高级配置

以下为Honeycomb小部件支持的高级配置参数.

Thresholds属性名称中的数字(例如thresholds.0.color)引用的是按升序排序的阈值列表位置. 但如果阈值以不同顺序配置,在Zabbix前端更新小部件配置后,这些值将按升序重新排序 (例如"thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

参数 仪表板小部件字段 名称
Primary label
Type 0 primary_label_type 0 - (默认) 文本;
1 - 数值.
Text 1 primary_label 任意string值,包括宏.
支持的宏: {主机.*}, {监控项.*}, {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(类型)设为"Custom"时支持
Bold 0 primary_label_bold 0 - (默认) 禁用;
1 - 启用.
Color 1 primary_label_color 十六进制颜色代码(如FF0000).

默认: 基于设置User objecttheme:
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 任意string值.

""(空值)

参数行为:
- 当Type设为"Value"且Units(复选框)设为"Enabled"时支持
Position 0 primary_label_units_pos 0 - 数值前;
1 - (默认) 数值后.

参数行为:
- 当Type设为"Value"且Units(复选框)设为"Enabled"时支持

当设置为以下配置之一时此参数将被忽略: unixtime, uptime, s.
Secondary label
Type 0 secondary_label_type 0 - 文本;
1 - (默认) 数值.
Text 1 secondary_label 任意string值,包括宏.
支持的宏: {主机.*}, {监控项.*}, {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(类型)设为"Custom"时支持
Bold 0 secondary_label_bold 0 - 禁用;
1 - (默认) 启用.
Color 1 secondary_label_color 十六进制颜色代码(如FF0000).

默认: 基于设置User objecttheme:
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 任意string值.

""(空值)

参数行为:
- 当Type设为"Value"且Units(复选框)设为"Enabled"时支持
Position 0 secondary_label_position 0 - 数值前;
1 - (默认) 数值后.

参数行为:
- 当Type设为"Value"且Units(复选框)设为"Enabled"时支持

当设置为以下配置之一时此参数将被忽略: unixtime, uptime, s.
Background color
Background color 1 bg_color 十六进制颜色代码(如FF0000).

默认: 基于设置User objecttheme:
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 任意数值. 支持Suffixes(如"1d", "2w", "4K", "8G").

示例

以下示例仅描述Honeycomb仪表板小部件的字段objects配置。 有关配置仪表板的更多信息,请参阅dashboard.create

配置 Honeycomb 小组件

配置一个显示Zabbix server进程利用率的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
       }

另请参阅