8 图形

描述

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

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

参数

Graph 部件支持以下参数。

参数 仪表板小部件字段 名称
Refresh interval 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟.
Reference 1 reference 由5个字符组成的任意string值(例如ABCDEJBPNL)。该值在部件所属的仪表板中必须唯一。

参数行为:
- 必填

数据集

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

属性名称中的第一个数字(例如 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)。

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

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

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

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

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

默认:FF465C

参数行为:
- 支持 如果数据集类型设置为"监控项模式"
Draw 0 ds.0.type 0 - (默认) 线;
1 - 点;
2 - 阶梯;
3 - 柱状。
Stacked 0 ds.0.stacked 0 - (默认) 禁用;
1 - 启用。

参数行为:
- 支持 如果绘制设置为"线"、"阶梯"或"柱状"
Width 0 ds.0.width 可能值范围为1-10。

默认:1。

参数行为:
- 支持 如果绘制设置为"线"或"阶梯"
Point size 0 ds.0.pointsize 可能值范围为1-10。

默认:3。

参数行为:
- 支持 如果绘制设置为"点"
Transparency 0 ds.0.transparency 可能值范围为1-10。

默认:5。
Fill 0 ds.0.fill 可能值范围为1-10。

默认:3。

参数行为:
- 支持 如果绘制设置为"线"或"阶梯"
Missing data 0 ds.0.missingdatafunc 0 - (默认) 无;
1 - 连接;
2 - 视为0;
3 - 最后已知。

参数行为:
- 支持 如果绘制设置为"线"或"阶梯"
Override host 1 ds.0.override_hostid._reference ABCDE._hostid- 将兼容小部件(其"参考"参数设置为"ABCDE")设置为主机的数据源;
DASHBOARD._hostid - 将仪表板主机选择器设置为主机的数据源。

template dashboard上配置小部件时不支持此参数。
Y-axis 0 ds.0.axisy 0 - (默认) 左;
1 - 右。
Time shift 1 ds.0.timeshift 有效时间string(例如3600, 1h等)。
可以使用时间后缀。也允许负值。

默认:""(空)。
Aggregation function 0 ds.0.aggregate_function 0 - (默认) 未使用;
1 - 最小;
2 - 最大;
3 - 平均;
4 - 计数;
5 - 总和;
6 - 第一个;
7 - 最后一个。
Aggregation interval 1 ds.0.aggregate_interval 有效时间string(例如3600, 1h等)。
可以使用时间后缀

默认:1h
Aggregate 0 ds.0.aggregate_grouping 0 - (默认) 每个监控项;
1 - 数据集。

参数行为:
- 支持 如果聚合函数设置为"最小"、"最大"、"平均"、"计数"、"总和"、"第一个"或"最后一个"
Approximation 0 ds.0.approximation 1 - 最小;
2 - (默认) 平均;
4 - 最大;
7 - 全部。
Data set label 1 ds.0.data_set_label 任何string值。

默认:""(空)。

显示选项

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

参数 仪表板小部件字段 名称
History data selection 0 source 0 - (默认) 自动;
1 - 历史数据;
2 - 趋势数据.
Simple triggers 0 simple_triggers 0 - (默认) 禁用;
1 - 启用.
Working time 0 working_time 0 - (默认) 禁用;
1 - 启用.
Percentile line (left)
状态 0 percentile_left 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"左侧"时
0 percentile_left_value 取值范围1-100.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"左侧"时
Percentile line (right)
状态 0 percentile_right 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"右侧"时
0 percentile_right_value 取值范围1-100.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"右侧"时

时间段

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

参数 仪表板小部件字段 名称
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, 等).

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

坐标轴

以下参数可用于配置坐标轴

参数 仪表板小部件字段 名称
Left Y 0 lefty 0 - 禁用;
1 - (默认) 启用.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"左侧"时
Right Y 0 righty 0 - (默认) 禁用;
1 - 启用.

参数行为:
- 支持Y轴 (在数据集配置中)设置为"右侧"时
Scale 0 lefty_scale 0 - (默认) 线性;
1 - 对数.
righty_scale
Min 1 lefty_min 任意数值.

默认: "" (空).
righty_min
Max 1 lefty_max 任意数值.

默认: "" (空).
righty_max
Units (type) 0 lefty_units 0 - (默认) 自动;
1 - 静态.
righty_units
Units (value) 1 lefty_static_units 任意string值.

默认: "" (空).
righty_static_units
X-Axis 0 xaxis 0 - 禁用;
1 - (默认) 启用.

图例

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

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

参数行为:
- 支持显示图例设置为"启用"时
Display min/avg/max 0 legend_statistic 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.

参数行为:
- 支持显示图例设置为"启用"且显示最小/平均/最大值设置为"禁用"时

问题

支持以下参数用于配置问题

参数 仪表板小部件字段 名称
Show problems 0 show_problems 0 - (默认) 禁用;
1 - 启用.
Selected items only 0 graph_item_problems 0 - 禁用;
1 - (默认) 启用.
Problem hosts 1 problemhosts.0 Host 名称.

注意: 属性名称中的数字引用已配置的 主机.
要配置多个 主机, create 仪表板小部件字段 object 用于每个 主机, 并在属性名称中使用递增数字.

如果在 template dashboard 上配置小部件, 则不支持此参数.
Severity 0 severities.0 0 - 未分类;
1 - 信息;
2 - 警告;
3 - 一般;
4 - 高;
5 - 灾难.

默认值: 空 (全部启用).

注意: 要配置多个值, create 仪表板小部件字段 object 为每个值在属性名称中使用递增数字.
Problem 1 problem_name 问题 配置 (不区分大小写,完整名称或部分名称).
Problem tags
评估类型 0 evaltype 0 - (默认) 与/或;
2 - 或.
标签名称 1 tags.0.tag 任意string值。

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

参数行为:
- 配置问题标签时为必填项
Operator 0 tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在.

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

参数行为:
- 配置问题标签时为必填项
标签值 1 tags.0.value 任意 string 值。

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

参数行为:
- 配置问题标签时为必填项

覆盖规则

以下参数可用于配置覆盖项

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

参数 仪表板小部件字段 名称
Host patterns 1 or.0.hosts.0 Host名称或模式(例如Zabbix*)。

template dashboard上配置小部件时不支持此参数。

参数行为:
- 配置覆盖项时为必填
Item patterns 1 or.0.items.0 Item名称或模式(例如*: Number of processed *values per second)。
template dashboard上配置小部件时,只应设置模板上配置的监控项模式。

参数行为:
- 配置覆盖项时为必填
Base color 1 or.0.color 十六进制颜色代码(例如FF0000)。
Width 0 or.0.width 取值范围为1-10。
Draw 0 or.0.type 0 - 线型;
1 - 点型;
2 - 阶梯型;
3 - 柱型。
Transparency 0 or.0.transparency 取值范围为1-10。
Fill 0 or.0.fill 取值范围为1-10。
Point size 0 or.0.pointsize 取值范围为1-10。
Missing data 0 or.0.missingdatafunc 0 - 无;
1 - 连接;
2 - 视为0;
3 - 最后已知值。
Y-axis 0 or.0.axisy 0 - 左;
1 - 右。
Time shift 1 or.0.timeshift 有效时间string(例如3600, 1h等)。
可使用时间后缀。允许负值。

示例

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

配置 图形 部件

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

  • 2个数据集共9个监控项显示在1个主机上
  • 第一个数据集类型为"监控项列表",包含3个监控项,用不同颜色但相同宽度、透明度和填充的线条表示
  • 第二个数据集类型为"监控项模式",包含6个监控项,配置了聚合功能,并用自定义颜色、宽度、透明度和填充的线条表示
  • 第二个数据集还配置了自定义数据集标签
  • 图表数据显示最近3小时的时间段
  • 图表中仅显示已配置监控项的问题
  • 图表有两个Y轴,其中右侧Y轴仅显示第二个数据集的值
  • 图表图例在4行中显示已配置的监控项,以及数据集的最小值、最大值和平均值

执行请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "svggraph",
                               "name": "Graph",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "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": 4,
                                       "name": "ds.0.itemids.2",
                                       "value": 23269
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.0.color.2",
                                       "value": "BF00FF"
                                   },
                                   {
                                       "type": 4,
                                       "name": "ds.0.itemids.3",
                                       "value": 23257
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.0.color.3",
                                       "value": "0040FF"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.0.width",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.0.transparency",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.0.fill",
                                       "value": 1
                                   },
                                   {
                                       "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.transparency",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.1.fill",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.1.axisy",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.1.aggregate_function",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.aggregate_interval",
                                       "value": "1m"
                                   },
                                   {
                                       "type": 0,
                                       "name": "ds.1.aggregate_grouping",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "ds.1.data_set_label",
                                       "value": "Number of processed values per second"
                                   },
                                   {
                                       "type": 0,
                                       "name": "graph_time",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "time_period.from",
                                       "value": "now-3h"
                                   },
                                   {
                                       "type": 0,
                                       "name": "legend_statistic",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "legend_lines",
                                       "value": 4
                                   },
                                   {
                                       "type": 0,
                                       "name": "show_problems",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "reference",
                                       "value": "YZABC"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅