这些参数及对应仪表板小部件字段objects的可选属性值允许通过dashboard.create
和dashboard.update
方法配置Top hosts部件。
小部件fields
属性在仪表板创建或update过程中不会进行验证。 这使得用户可以修改built-in widgets和create开发模块,但也存在错误创建或更新部件的风险。 为确保成功创建或updateTop 主机部件,请参考下文表格中列出的参数要求。
以下参数支持Top 主机小部件。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Refresh interval | 0 | rf_rate | 0 - 不刷新; 10 - 10秒; 30 - 30秒; 60 - (默认) 1分钟; 120 - 2分钟; 600 - 10分钟; 900 - 15分钟. |
|
Host groups | 2 | groupids | Host group ID. 注意: 要配置多个主机组,需为每个主机组create仪表板小部件字段object. |
|
Hosts | 3 | hostids | Host ID. 注意: 要配置多个主机,需为每个主机create仪表板小部件字段object. 对于多个主机,参数主机 groups必须完全不配置或至少配置一个包含这些主机的主机组. |
|
Host 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值. 配置Tags时必须提供Tag name参数. |
|
运算符 | 0 | tags.operator.0 | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在. 配置Tags时必须提供Operator参数. |
|
标签值 | 1 | tags.value.0 | 任意string值. 配置Tags时必须提供Tag value参数. |
|
Columns (see below) | ||||
Order | 0 | order | 2 - (默认) Top N; 3 - 底部N. |
|
Order column | 0 | column | 从配置列中获取的数值. | |
Host count | 0 | count | 有效值范围1-100. 默认: 10. |
列具有通用参数以及根据数据参数配置而定的附加参数。
所有与列相关的参数中,属性名称中的数字(例如columns.name.0)指向该参数所配置的对应列。
所有列均支持以下参数。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Name | 1 | columns.name.0 | 任意string值。 |
Data (required) |
0 | columns.data.0 | 1 - 监控项值; 2 - 主机名; 3 - 文本。 |
Base color (required) |
1 | columns.base_color.0 | 十六进制颜色代码(例如FF0000 )。 |
当数据设置为"监控项值"时支持以下参数。
Thresholds属性名中的第一个数字(例如columnsthresholds.color.0.0)引用配置阈值的列, 而第二个数字引用按升序排序的阈值在列表中的位置。 但是,如果阈值以不同顺序配置,在Zabbix前端更新小部件配置后,值将按升序重新排序 (例如"threshold.threshold.0":"5"
→ "threshold.threshold.0":"1"
;"threshold.threshold.1":"1"
→ "threshold.threshold.1": "5"
)。
参数 | 仪表板小部件字段 | 名称 | 值 | |
---|---|---|---|---|
Item | 1 | columns.item.0 | 有效的监控项名称。 | |
Time shift (required) |
1 | columns.timeshift.0 | 有效的数值或时间string值(例如3600 或1h )。可使用时间后缀。允许负值。 |
|
Aggregation function | 0 | columns.aggregate_function.0 | 0 - (默认) 无; 1 - 最小值; 2 - 最大值; 3 - 平均值; 4 - 计数; 5 - 求和; 6 - 第一个; 7 - 最后一个。 |
|
Aggregation interval | 1 | columns.aggregate_interval.0 | 有效的时间string(例如3600 、1h 等)。可使用时间后缀。 当聚合函数设置为无时,聚合间隔参数不可用。 默认: 1h 。 |
|
Display | 0 | columns.display.0 | 1 - (默认) 原样显示; 2 - 条形图; 3 - 指示器。 |
|
Min | 1 | columns.min.0 | 任意数值。 当显示设置为"原样显示"时,最小值参数不可用。 |
|
Max | 1 | columns.max.0 | 任意数值。 当显示设置为"原样显示"时,最大值参数不可用。 |
|
History data | 0 | columns.history.0 | 1 - (默认) 自动; 2 - 历史数据; 3 - 趋势数据。 |
|
Thresholds | ||||
颜色 | 1 | columnsthresholds.color.0.0 | 十六进制颜色代码(例如FF0000 )。默认: "" (空)。 |
|
阈值 | 1 | columnsthresholds.threshold.0.0 | 任意string值。 |
当Data设置为"Text"时支持以下参数。
参数 | 仪表板小部件字段 | 名称 | 值 |
---|---|---|---|
Text | 1 | columns.text.0 | 任意string值,包括宏。 支持的宏:{主机.*}、{INVENTORY.*}。 当Data设置为"Text"时,参数Text为必填项。 |
以下示例仅针对Top 主机小部件的仪表板小部件字段objects配置进行说明。 有关配置仪表板的更多信息,请参阅dashboard.create
。
配置一个显示Top 主机按CPU利用率排序的Top 主机部件,在主机组 "4"中展示。 同时配置以下自定义列:"主机名"、"Utilization"、"1m avg"、"5m avg"、"15m avg"、"Processes"。
请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "Utilization"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.item.2",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.item.3",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.item.4",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processes"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 1,
"name": "columns.item.5",
"value": "Number of processes"
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
响应: