这些参数及对应仪表板小部件字段objects的可选属性值,可用于配置dashboard.create
和dashboard.update
方法中的Graph部件。
小部件fields
属性在仪表板创建或更新时不会进行验证。 这使得用户能够修改built-in widgets并创建开发模块,但也存在错误创建或更新部件的风险。 为确保成功创建或更新图形部件,请参考下文表格中列出的参数要求。
图形部件支持以下参数。
参数 | 仪表板小部件字段 | 名称 | 取值 |
---|---|---|---|
Refresh interval | 0 | rf_rate | 0 - 不刷新; 10 - 10 秒; 30 - 30 秒; 60 - (默认) 1 分钟; 120 - 2 分钟; 600 - 10 分钟; 900 - 15 分钟。 |
以下参数可用于配置数据集。
属性名称中的第一个数字(例如 ds.主机.0.0, ds.监控项.0.0)表示特定数据集, 而第二个数字(如果存在)表示配置的主机或监控项。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Host pattern (required) |
1 | ds.hosts.0.0 | Host名称或模式(例如Zabbix* )。 |
Item pattern (required) |
1 | ds.items.0.0 | Item名称或模式(例如*: Number of processed *values per second )。 |
Color | 1 | ds.color.0 | 十六进制颜色代码(例如FF0000 )。默认: FF465C 。 |
Draw | 0 | ds.type.0 | 0 - (默认) 线; 1 - 点; 2 - 阶梯; 3 - 柱状。 |
Width | 0 | ds.width.0 | 有效值范围为1-10。 默认:1。 如果绘制设置为"点"或"柱状",则宽度参数不可用。 |
Point size | 0 | ds.pointsize.0 | 有效值范围为1-10。 默认:3。 如果绘制设置为"线"、"阶梯"或"柱状",则点大小参数不可用。 |
Transparency | 0 | ds.transparency.0 | 有效值范围为1-10。 默认:5。 |
Fill | 0 | ds.fill.0 | 有效值范围为1-10。 默认:3。 如果绘制设置为"点"或"柱状",则填充参数不可用。 |
Missing data | 0 | ds.missingdatafunc.0 | 0 - (默认) 无; 1 - 连接; 2 - 视为0。 如果绘制设置为"点"或"柱状",则缺失数据参数不可用。 |
Y-axis | 0 | ds.axisy.0 | 0 - (默认) 左; 1 - 右。 |
Time shift | 1 | ds.timeshift.0 | 有效时间string(例如3600 、1h 等)。可使用时间后缀。也允许负值。 默认: "" (空)。 |
Aggregation function | 0 | ds.aggregate_function.0 | 0 - (默认) 无; 1 - 最小; 2 - 最大; 3 - 平均; 4 - 计数; 5 - 总和; 6 - 首个; 7 - 末个。 |
Aggregation interval | 1 | ds.aggregate_interval.0 | 有效时间string(例如3600 、1h 等)。可使用时间后缀。 默认: 1h 。 |
Aggregate | 0 | ds.aggregate_grouping.0 | 0 - (默认) 每个监控项; 1 - 数据集。 如果聚合函数设置为"无",则聚合参数不可用。 |
以下参数可用于配置显示选项。
参数 | 仪表板小部件字段 | 名称 | 取值 |
---|---|---|---|
History data selection | 0 | source | 0 - (默认) 自动; 1 - 历史数据; 2 - 趋势数据。 |
以下参数支持配置时间段。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Set custom time period | 0 | graph_time | 0 - (默认) 禁用; 1 - 启用。 |
From | 1 | time_from | 有效时间string,格式为YYYY-MM-DD hh:mm:ss 。同时支持时间段选择器值( now 、now/d 、now/w-1w 等)。默认值: now-1h 。 |
To | 1 | time_to | 有效时间string值,格式为YYYY-MM-DD hh:mm:ss 。同时支持时间段选择器值( now 、now/d 、now/w-1w 等)。默认值: now 。 |
以下参数可用于配置坐标轴。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Left Y | 0 | lefty | 0 - 禁用; 1 - (默认) 启用。 当Y轴(在数据集配置中)设置为"左侧"时可用。 |
Right Y | 0 | righty | 0 - (默认) 禁用; 1 - 启用。 当Y轴(在数据集配置中)设置为"右侧"时可用。 |
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 - (默认) 启用。 |
Number of rows | 0 | legend_lines | 有效值范围为 1-5。 默认值:1。 |
以下参数可用于配置问题功能。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Show problems | 0 | show_problems | 0 - (默认) 禁用; 1 - 启用。 |
|
Selected items only | 0 | graph_item_problems | 0 - 禁用; 1 - (默认) 启用。 |
|
Problem hosts | 1 | problemhosts.0 | Host名称。 注意:属性名称中的数字引用已配置的主机。 要配置多个主机,需为每个主机创建仪表板小部件字段object。 |
|
Severity | 0 | severities | 0 - 未分类; 1 - 信息; 2 - 警告; 3 - 一般; 4 - 严重; 5 - 灾难。 默认值:空(全部启用)。 注意:要配置多个值,需为每个值创建仪表板小部件字段object。 |
|
Problem | 1 | problem_name | 问题配置(不区分大小写,完整名称或部分名称)。 | |
Tags (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list) | ||||
评估类型 | 0 | evaltype | 0 - (默认) 与/或; 2 - 或。 |
|
标签名称 | 1 | tags.tag.0 | 任意string值。 配置标签时必须提供标签名称参数。 |
|
运算符 | 0 | tags.operator.0 | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 配置标签时必须提供运算符参数。 |
|
标签值 | 1 | tags.value.0 | 任意string值。 配置标签时必须提供标签值参数。 |
以下参数可用于配置覆盖项。
属性名称中的第一个数字(例如 or.主机.0.0, or.监控项.0.0)表示特定数据集, 而第二个数字(如果存在)则表示配置的主机或监控项。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Host pattern (required) |
1 | or.hosts.0.0 | Host名称或模式(例如Zabbix* )。 |
Item pattern (required) |
1 | or.items.0.0 | Item名称或模式(例如*: Number of processed *values per second )。 |
Base color | 1 | or.color.0 | 十六进制颜色代码(例如FF0000 )。 |
Width | 0 | or.width.0 | 有效值范围为1-10。 |
Draw | 0 | or.type.0 | 0 - 线型; 1 - 点型; 2 - 阶梯型; 3 - 柱状型。 |
Transparency | 0 | or.transparency.0 | 有效值范围为1-10。 |
Fill | 0 | or.fill.0 | 有效值范围为1-10。 |
Point size | 0 | or.pointsize.0 | 有效值范围为1-10。 |
Missing data | 0 | or.missingdatafunc.0 | 0 - 无; 1 - 连接; 2 - 视为0。 |
Y-axis | 0 | or.axisy.0 | 0 - 左; 1 - 右。 |
Time shift | 1 | or.timeshift.0 | 有效时间string(例如3600 、1h 等)。可使用时间后缀。允许负值。 |
以下示例仅描述图形小部件的仪表板小部件字段objects的配置。 有关配置仪表板的更多信息,请参阅dashboard.create
。
按以下方式配置图形部件:
请求:
{
"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": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "ds.hosts.0.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.0.0",
"value": "Zabbix server: Utilization of poller data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.width.0",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.0",
"value": 3
},
{
"type": 0,
"name": "ds.fill.0",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.1.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.1.0",
"value": "Zabbix server: Utilization of trapper data collector processes, in %"
},
{
"type": 1,
"name": "ds.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.width.1",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.1",
"value": 3
},
{
"type": 0,
"name": "ds.fill.1",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.2.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.2.0",
"value": "Zabbix server: Utilization of history syncer internal processes, in %"
},
{
"type": 1,
"name": "ds.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.width.2",
"value": 3
},
{
"type": 0,
"name": "ds.transparency.2",
"value": 3
},
{
"type": 0,
"name": "ds.fill.2",
"value": 1
},
{
"type": 1,
"name": "ds.hosts.3.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.items.3.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.color.3",
"value": "000000"
},
{
"type": 0,
"name": "ds.transparency.3",
"value": 0
},
{
"type": 0,
"name": "ds.fill.3",
"value": 0
},
{
"type": 0,
"name": "ds.axisy.3",
"value": 1
},
{
"type": 0,
"name": "ds.aggregate_function.3",
"value": 3
},
{
"type": 1,
"name": "ds.aggregate_interval.3",
"value": "1m"
},
{
"type": 0,
"name": "ds.aggregate_grouping.3",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_from",
"value": "now-3h"
},
{
"type": 0,
"name": "legend_lines",
"value": 2
},
{
"type": 0,
"name": "show_problems",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
响应: