2022 Zabbix中国峰会
2022 Zabbix中国峰会

12 监控项值

描述

这些参数及其可能的属性值允许配置dashboard.createdashboard.update方法中的监控项值小部件。

在创建或更新仪表盘时,不会验证小部件fields属性。 这允许用户修改内置小部件并创建自定义小部件,但同时也引入了错误创建或更新小部件的风险。 为确保监控项值小部件的成功创建或更新,请参考下表中概述的参数要求。

参数

以下参数支持监控项值小部件。

参数 类型 名称
刷新间隔 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟。
监控项
(必需)
4 itemid 监控项 ID。
显示 0 show 1 - 描述;
2 - 值;
3 - 时间;
4 - 变化指示器。

默认:1, 2, 3, 4(全部启用)。

注意:要配置多个值,请为每个值创建一个仪表盘小部件字段对象。
动态监控项 0 dynamic 0 - (默认) 禁用;
1 - 启用。
高级配置 0 adv_conf 0 - (默认) 禁用;
1 - 启用。

高级配置

如果高级配置设置为"启用",则支持以下参数。

参数 类型 名称
背景颜色 1 bg_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
描述

如果高级配置设置为"启用",并且显示设置为"描述",则支持以下参数。

参数 类型 名称
描述 1 description 任何字符串值,包括宏。
支持的宏:{HOST.*}, {ITEM.*}, {INVENTORY.*}, 用户宏。

默认:{ITEM.NAME}。
水平位置 0 desc_h_pos 0 - 左;
1 - (默认) 中心;
2 - 右。
两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
垂直位置 0 desc_v_pos 0 - 顶部;
1 - 中间;
2 - (默认) 底部。
两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
大小 0 desc_size 有效值范围从1-100。

默认:15。
加粗 0 desc_bold 0 - (默认) 禁用;
1 - 启用。
颜色 1 desc_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。

如果高级配置设置为"启用",并且显示设置为"值",则支持以下参数。

参数 类型 名称
小数位 0 decimal_places 有效值范围从1-10。

默认:2。
大小 0 decimal_size 有效值范围从1-100。

默认:35。
水平位置 0 value_h_pos 0 - 左;
1 - (默认) 中心;
2 - 右。

两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
垂直位置 0 value_v_pos 0 - 顶部;
1 - (默认) 中间;
2 - 底部。

两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
大小 0 value_size 有效值范围从1-100。

默认:45。
加粗 0 value_bold 0 - 禁用;
1 - (默认) 启用。
颜色 1 value_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
单位 (复选框) 0 units_show 0 - 禁用;
1 - (默认) 启用。
单位 (值) 1 units 任何字符串值。
位置 0 units_pos 0 - 值之前;
1 - 值上方;
2 - (默认) 值之后;
3 - 值下方。
大小 0 units_size 有效值范围从1-100。

默认:35。
加粗 0 units_bold 0 - 禁用;
1 - (默认) 启用。
颜色 1 units_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
时间

如果高级配置设置为"启用",并且显示设置为"时间",则支持以下参数。

参数 类型 名称
水平位置 0 time_h_pos 0 - 左;
1 - (默认) 中心;
2 - 右。

两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
垂直位置 0 time_v_pos 0 - (默认) 顶部;
1 - 中间;
2 - 底部。

两个或更多的元素(描述、值、时间)不能共享相同的水平位置垂直位置
大小 0 time_size 有效值范围从1-100。

默认:15。
加粗 0 time_bold 0 - (默认) 禁用;
1 - 启用。
颜色 1 time_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
变化指示器

如果高级配置设置为"启用",并且显示设置为"变化指示器",则支持以下参数。

参数 类型 名称
上升变化指示器颜色 1 up_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
下降变化指示器颜色 1 down_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
无变化变化指示器颜色 1 updown_color 十六进制颜色代码(例如 FF0000)。

默认:""(空)。

示例

以下示例旨在仅描述仪表盘小部件字段对象的配置,用于监控项值小部件。 有关配置仪表盘的更多信息,请参见dashboard.create

配置一个监控项值小部件

配置一个监控项值小部件,用于展示项目“42266”的Zabbix agent可用性。 此外,还可以使用多个高级选项对仪表盘小部件进行视觉微调。

请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "item",
                               "name": "Item value",
                               "x": 0,
                               "y": 0,
                               "width": 4,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 4,
                                       "name": "itemid",
                                       "value": 42266
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "adv_conf",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "bg_color",
                                       "value": "D1C4E9"
                                   },
                                   {
                                       "type": 1,
                                       "name": "description",
                                       "value": "Agent status"
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_h_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_v_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "desc_color",
                                       "value": "F06291"
                                   },
                                   {
                                       "type": 0,
                                       "name": "value_h_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "value_size",
                                       "value": 25
                                   },
                                   {
                                       "type": 1,
                                       "name": "value_color",
                                       "value": "FFFF00"
                                   },
                                   {
                                       "type": 0,
                                       "name": "units_show",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_h_pos",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_v_pos",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_size",
                                       "value": 10
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "time_color",
                                       "value": "9FA8DA"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

另请参阅