21 饼图

描述

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

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

参数

饼图小部件支持以下参数。

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

数据集

以下参数可用于配置数据集.

属性名称中的第一个数字(例如 ds.0.主机.0, ds.0.监控项.0)表示特定数据集, 而第二个数字(如果存在)表示配置的主机或监控项.

参数 仪表板小部件字段 名称
Data set type 0 ds.0.dataset_type 0 - 监控项列表;
1 - (默认) 监控项模式.
监控项 4 ds.0.itemids.0 Item ID.
template dashboard上配置小部件时,只能设置模板上配置的监控项.

注意: 要配置多个监控项, 需要create仪表板小部件字段object, 每个监控项的属性名称中数字递增.

参数行为:
- 必需 如果数据集类型设置为"监控项列表"且未设置监控项 (小部件)
监控项 (小部件) 1 ds.0.itemids.0._reference 替代Item ID:
ABCDE._itemid - 将部件兼容性(其引用参数设置为"ABCDE")设置为监控项的数据源.

注意: 要配置多个小部件, 需要create仪表板小部件字段object, 每个小部件的属性名称中数字递增.

参数行为:
- 必需 如果数据集类型设置为"监控项列表"且未设置监控项
颜色 1 ds.0.color.0 十六进制颜色代码(例如FF0000).

参数行为:
- 支持 如果数据集类型设置为"监控项列表"
监控项类型 0 ds.0.type.0 0 - (默认) 普通;
1 - 总计.

值"总计"只能在整个图表中的一个监控项上设置.

参数行为:
- 支持 如果数据集类型设置为"监控项列表"
主机模式 1 ds.0.hosts.0 Host名称或模式(例如"Zabbix*").

参数行为:
- 必需 如果数据集类型设置为"监控项模式"

template dashboard上配置小部件时不支持此参数.
监控项模式 1 ds.0.items.0 Item名称或模式(例如"*: 每秒处理的*值数量").

template dashboard上配置小部件时,只能设置模板上配置的监控项的模式.

参数行为:
- 必需 如果数据集类型设置为"监控项模式"
颜色 1 ds.0.color 十六进制颜色代码(例如FF0000).

参数行为:
- 支持 如果数据集类型设置为"监控项模式"
Aggregation function 0 ds.0.aggregate_function 1 - 最小;
2 - 最大;
3 - 平均;
4 - 计数;
5 - 求和;
6 - 第一个;
7 - (默认) 最后一个.
Data set aggregation 0 ds.0.dataset_aggregation 0 - (默认) 无;
1 - 最小;
2 - 最大;
3 - 平均;
4 - 计数;
5 - 求和.

参数行为:
- 支持 如果监控项类型设置为"总计"
Data set label 1 ds.0.data_set_label 任意string值.

默认: "" (空).

显示选项

以下参数可用于配置显示选项

参数 仪表板小部件字段 名称
History data selection 0 source 0 - (默认) 自动;
1 - 历史数据;
2 - 趋势数据.
Draw 0 draw_type 0 - (默认) 饼图;
1 - 环形图.
宽度 0 width 20 - 半径的20%;
30 - 半径的30%;
40 - 半径的40%;
50 - (默认) 半径的50%.

参数行为:
- 支持绘制类型设为"环形图"时
描边宽度 0 stroke 取值范围0-10.

默认: 0.

参数行为:
- 支持绘制类型设为"环形图"时
显示总值 0 total_show 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持绘制类型设为"环形图"时
大小 0 value_size_type 0 - (默认) 自动;
1 - 自定义.

参数行为:
- 支持显示总值设为"启用"时
大小 (自定义尺寸值) 0 value_size 取值范围1-100.

默认: 20.

参数行为:
- 支持显示总值设为"启用"时
小数位数 0 decimal_places 取值范围0-6.

默认: 2.

参数行为:
- 支持显示总值设为"启用"时
单位 (复选框) 0 units_show 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持显示总值设为"启用"时
单位 (值) 1 units 任意string值.

参数行为:
- 支持单位 (复选框)设为"启用"时
粗体 0 value_bold 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持显示总值设为"启用"时
颜色 1 value_color 十六进制颜色代码 (例如 FF0000).

参数行为:
- 支持显示总值设为"启用"时
Space between sectors 0 space 取值范围0-10.

默认: 1.
Merge sectors smaller than N% (checkbox) 0 merge 0 - (默认) 禁用;
1 - 启用.
Merge sectors smaller than N% (value) 0 merge_percent 取值范围1-10.

默认: 1.

参数行为:
- 支持合并小于N%的扇区 (复选框)设为"启用"时
Merge sectors smaller than N% (color) 1 merge_color 十六进制颜色代码 (例如 FF0000).

参数行为:
- 支持合并小于N%的扇区 (复选框)设为"启用"时

时间段

以下参数可用于配置时间段.

参数 仪表板小部件字段 名称
Time period 1 time_period._reference DASHBOARD._timeperiod - 将Time period selector设为数据源;
ABCDE._timeperiod - 将部件兼容性(其Reference参数设置为"ABCDE")设为数据源.

默认值: DASHBOARD._timeperiod

或者,您也可以仅在FromTo参数中设置时间段.
From 1 time_period.from 有效的string,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w, 等).

参数行为:
- 当时间段未设置时支持
To 1 time_period.to 有效的string,使用绝对时间语法(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w, 等).

参数行为:
- 当时间段未设置时支持

图例

以下参数可用于配置图例.

参数 仪表板小部件字段 名称
Show legend 0 legend 0 - 禁用;
1 - (默认) 启用.
Show value 0 legend_value 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持显示图例设置为"启用"时
Show aggregation function 0 legend_aggregation 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持显示图例设置为"启用"时
Rows 0 legend_lines_mode 0 - (默认) 固定;
1 - 可变.

参数行为:
- 支持显示图例设置为"启用"时
Number of rows/
Maximum number of rows
0 legend_lines 取值范围1-10.

默认: 1.

参数行为:
- 支持显示图例设置为"启用"时
Number of columns 0 legend_columns 取值范围1-4.

默认: 4.

参数行为:
- 支持显示图例设置为"启用"且显示值设置为"禁用"时

示例

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

配置饼图小部件

按以下方式配置饼图部件:

  • 2个数据集共包含9个监控项分布在1个主机上
  • 第一个数据集类型为"监控项列表",包含3个类型均为"Normal"的监控项,每个用不同颜色表示
  • 第二个数据集类型为"监控项模式",包含6个监控项,每个监控项都配置了聚合,并使用自定义颜色表示
  • 第二个数据集还配置了自定义数据集标签
  • 饼图数据以环形图形式显示,带有自定义宽度和带单位的中心总值
  • 饼图数据显示并聚合最近3小时的自定义时间段数据
  • 饼图图例以4行显示配置的监控项

执行请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "piechart",
                               "name": "Pie chart",
                               "x": 0,
                               "y": 0,
                               "width": 24,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "ds.0.dataset_type",
                                       "value": 0
                                   },
                                   {
                                       "type": 4,
                                       "name": "ds.0.itemids.1",
                                       "value": 23264
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.0.color.1",
                                       "value": "FF0000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.0.type.1",
                                       "value": 0
                                   },
                                   {
                                       "type": 4,
                                       "name": "ds.0.itemids.2",
                                       "value": 23269
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.0.color.2",
                                       "value": "BF00FF"
                                   },
                                   {
                                     "type": 0,
                                     "name": "ds.0.type.2",
                                     "value": 0
                                   },
                                   {
                                       "type": 4,
                                       "name": "ds.0.itemids.3",
                                       "value": 23257
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.0.color.3",
                                       "value": "0040FF"
                                   },
                                   {
                                     "type": 0,
                                     "name": "ds.0.type.3",
                                     "value": 0
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.hosts.0",
                                       "value": "Zabbix server"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.items.0",
                                       "value": "*: Number of processed *values per second"
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.color",
                                       "value": "000000"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.1.aggregate_function",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.data_set_label",
                                       "value": "Number of processed values per second"
                                   },
                                   {
                                       "type": 0,
                                       "name": "draw_type",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "width",
                                       "value": 30
                                   },
                                   {
                                       "type": 0,
                                       "name": "total_show",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "units_show",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "graph_time",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "time_period.from",
                                       "value": "now-3h"
                                   },
                                   {
                                       "type": 0,
                                       "name": "legend_lines",
                                       "value": 4
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅