18 监控项 值

描述

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

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

参数

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

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

参数行为:
- 必填 如果未设置监控项 (部件)
监控项 (部件) 1 itemid._reference 替代Item ID:
ABCDE._itemid - 设置一个部件兼容性 (其引用参数设置为"ABCDE")作为监控项的数据源.

参数行为:
- 必填 如果未设置监控项
Show 0 show.0 1 - 描述;
2 - 值;
3 - 时间;
4 - 变更指示器;
5 - 迷你图.

默认: 1, 2, 3, 4.

注意: 要配置多个值, 为每个值create一个仪表板部件字段object, 并在属性名称中使用递增数字.
Override host 1 override_hostid._reference ABCDE._hostid - 设置一个部件兼容性 (其引用参数设置为"ABCDE")作为主机的数据源;
DASHBOARD._hostid - 设置仪表板覆盖主机作为主机的数据源.

如果在template dashboard上配置部件, 则不支持此参数.

高级配置

以下高级配置参数支持监控项值部件。

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

参数 仪表板小部件字段 名称
Background color 1 bg_color 十六进制颜色代码(例如FF0000)。

默认:""(空)。
Thresholds
颜色 1 thresholds.0.color 十六进制颜色代码(例如FF0000)。
阈值 1 thresholds.0.threshold 任何string值。
Aggregation function 0 aggregate_function 0 - (默认) 未使用;
1 - 最小值;
2 - 最大值;
3 - 平均值;
4 - 计数;
5 - 总和;
6 - 第一个;
7 - 最后一个。
Time period 1 time_period._reference DASHBOARD._timeperiod - 将Time period selector设置为数据源;
ABCDE._timeperiod - 将部件兼容性(其reference参数等于ABCDE)设置为数据源。

默认:DASHBOARD._timeperiod

或者,您可以在FromTo参数中仅设置时间段。

参数行为:
- 支持 如果聚合函数设置为"min"、"max"、"avg"、"count"、"sum"、"first"、"last"
From 1 time_period.from 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果Time period未设置且聚合函数设置为"min"、"max"、"avg"、"count"、"sum"、"first"、"last"
To 1 time_period.to 有效的string时间,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(nownow/dnow/w-1w等)。

参数行为:
- 支持 如果Time period未设置且聚合函数设置为"min"、"max"、"avg"、"count"、"sum"、"first"、"last"
History data 0 history 0 - (默认) 自动;
1 - 历史数据;
2 - 趋势数据。
描述

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

参数 仪表板小部件字段 名称
Description 1 description 任意string值,包括宏。
支持的宏:{主机.*}, {监控项.*}、{INVENTORY.*}、用户宏。

默认值:{ITEM.NAME}。
Horizontal position 0 desc_h_pos 0 - 左对齐;
1 - (默认) 居中;
2 - 右对齐。

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

两个或多个元素(描述、值、时间)不能共享相同的水平位置垂直位置
Size 0 desc_size 取值范围1-100。

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

默认值:""(空)。

显示设置为"值"时支持以下高级配置参数。

参数 仪表板小部件字段 名称
Decimal places
小数位数 0 decimal_places 取值范围1-10。

默认值: 2.
大小 0 decimal_size 取值范围1-100。

默认值: 35.
Position
水平位置 0 value_h_pos 0 - 左对齐;
1 - (默认) 居中;
2 - 右对齐。

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

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

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

默认值: "" (空)。
Units
单位 (复选框) 0 units_show 0 - 禁用;
1 - (默认) 启用。
单位 (值) 1 units 任意string值。
位置 0 units_pos 0 - 值前;
1 - 值上;
2 - (默认) 值后;
3 - 值下。
大小 0 units_size 取值范围1-100。

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

默认值: "" (空)。
时间

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

参数 仪表板小部件字段 名称
Horizontal position 0 time_h_pos 0 - 左对齐;
1 - (默认) 居中;
2 - 右对齐.

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

两个或多个元素(描述、值、时间)不能共享相同的水平位置垂直位置.
Size 0 time_size 取值范围1-100.

默认值: 15.
Bold 0 time_bold 0 - (默认) 禁用;
1 - 启用.
Color 1 time_color 十六进制颜色代码(例如 FF0000).

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

如果显示设置为"变更指示器",则支持以下高级配置参数。

参数 仪表板小部件字段 名称
Change indicator ↑ color 1 up_color 十六进制颜色代码(例如FF0000)。

默认值:""(空)。
Change indicator ↓ color 1 down_color 十六进制颜色代码(例如FF0000)。

默认值:""(空)。
Change indicator ↕ color 1 updown_color 十六进制颜色代码(例如FF0000)。

默认值:""(空)。
迷你图

显示设置为"Sparkline",则支持以下高级配置参数。

参数 仪表板小部件字段 名称
Width 0 sparkline.width 取值范围0-10。

默认值: 1.
Fill 0 sparkline.fill 取值范围0-10。

默认值: 3.
Color 1 sparkline.color 十六进制颜色代码(如FF0000)。

默认值: 42A5F5.
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - 将Time period selector设为数据源;
ABCDE._timeperiod - 将部件兼容性(其reference参数等于ABCDE)设为数据源。

默认值: DASHBOARD._timeperiod

或者,您也可以仅在FromTo参数中设置时间段。
From 1 sparkline.time_period.from 有效的string,采用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w等)。
To 1 sparkline.time_period.to 有效的string,采用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w等)。
History data 0 sparkline.history 0 - (默认)自动;
1 - 历史数据;
2 - 趋势数据。

示例

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

配置 监控项 值 部件

配置一个显示监控项 "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
       }

另请参阅