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

17 监控项值

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.createdashboard.update 方法中配置监控项值组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件,但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新监控项值组件,请参阅下表中概述的参数行为。

参数

监控项值组件支持以下参数:

参数 类型 参数名称 参数值或参数说明
刷新频率 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
监控项 4 itemid.0 监控项 ID。

参数行为
- 必需的 (如果未设置 监控项 (组件))。
监控项 (组件) 1 itemid._reference 用于替代监控项 ID:
ABCDE._itemid - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

参数行为
- 必需的 (如果未设置 监控项)。
显示 0 show.0 1 - 说明;
2 - 值;
3 - 时间;
4 - 变动指标。

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

注意:如果需要配置多个值,则需要给每个值创建一个仪表盘组件字段对象,参数名称 statuses.0 中的数字按照顺序进行递增。
覆盖主机 1 override_hostid._reference ABCDE._hostid - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源;
DASHBOARD._hostid - 将主机选择器作为数据源。

仪表盘模板中定义组件时,此参数不可用。

高级配置

监控项值组件支持以下高级配置参数:

参数名称 阈值 (例如:thresholds.0.color)中的数字与提供的参数列表需要一致,且升序排序。例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。 如果传入的数字未按照升序排序,则 Zabbix 前端更新组件时会自动按照升序排序。 (例如:"thresholds.0.threshold":"5""thresholds.0.threshold":"1""thresholds.1.threshold":"1""thresholds.1.threshold": "5")

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

默认值:"" (空)。
阈值
颜色 1 thresholds.0.color 十六进制颜色代码(例如:FF0000)。
阈值 1 thresholds.0.threshold 任意字符串。
聚合函数 0 aggregate_function 0 - (默认) 未使用;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last。
时间期间 1 time_period._reference DASHBOARD._timeperiod - 将时间期间选择器选择器作为数据源;
ABCDE._timeperiod - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

默认值: DASHBOARD._timeperiod

另外,你也可以仅仅通过 FromTo 参数指定时间周期。

参数行为
- 支持 (如果 聚合函数 配置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last")。
From 1 time_period.from 绝对(YYYY-MM-DD hh:mm:ss)或相对(nownow/dnow/w-1w等)时间字符串。

参数行为
- 支持 (如果未设置 时间期间 并且 聚合函数 设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last")。
To 1 time_period.to 绝对(YYYY-MM-DD hh:mm:ss)或相对(nownow/dnow/w-1w等)时间字符串。

参数行为
- 支持 (如果未设置 时间期间 并且 聚合函数 设置为 "min"、"max"、"avg"、"count"、"sum"、"first"、"last")。
历史数据 0 history 0 - (默认) 自动;
1 - 历史;
2 - 趋势。
说明

如果 显示 设置为 "说明",则支持以下高级配置参数:

参数 类型 参数名称 参数值或参数说明
说明 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)。

默认值:"" (空)。

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 监控项值 组件。 更多信息,请参考 创建仪表盘

配置一个监控项值 组件

配置一个监控项值组件,用于展示监控项 "42266" 的值(Zabbix agent 可用)。 此外,通过包含动态背景颜色在内的多个高级配置对组件进行视觉微调。 基于 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": 12,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 4,
                                       "name": "itemid.0",
                                       "value": 42266
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.0",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.1",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show.2",
                                       "value": 3
                                   },
                                   {
                                       "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"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.0.color",
                                       "value": "E1E1E1"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.0.threshold",
                                       "value": "0"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.1.color",
                                       "value": "D1C4E9"
                                   },
                                   {
                                       "type": 1,
                                       "name": "thresholds.1.threshold",
                                       "value": "1"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

参考