28 Top 监控项
描述
这些参数及对应仪表板小部件字段objects的可选属性值，允许通过dashboard.create和dashboard.update方法配置Top items部件。
小部件fields的属性在仪表板创建或update过程中不会进行验证。 这使得用户可以修改built-in widgets和createcustom widgets，但也存在错误创建或更新部件的风险。 为确保成功创建或updateTop监控项部件，请参考下文表格中列出的参数行为。
参数
以下参数支持用于Top 监控项小部件。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - 不刷新; 10 - 10秒; 30 - 30秒; 60 - (默认) 1分钟; 120 - 2分钟; 600 - 10分钟; 900 - 15分钟. |
|
| Host groups | 2 | groupids.0 | Host group ID. 注意: 要配置多个主机组，create一个仪表板小部件字段object，为每个主机组在属性名称中使用递增数字. 如果在template dashboard上配置小部件，则不支持此参数. |
|
| 主机 groups (Widget) | 1 | groupids._reference | 替代Host group ID:ABCDE._hostgroupids - 设置一个部件兼容性（其Reference参数设置为"ABCDE"）作为主机组的数据源.如果在template dashboard上配置小部件，则不支持此参数. |
|
| Hosts | 3 | hostids.0 | Host ID. 注意: 要配置多个主机，create一个仪表板小部件字段object，为每个主机在属性名称中使用递增数字. 对于多个主机，参数主机 groups必须完全不配置或至少配置一个主机组，其中包含配置的主机. 如果在template dashboard上配置小部件，则不支持此参数. |
|
| 主机 (Widget/Dashboard) | 1 | hostids._reference | 替代Host ID:DASHBOARD.hostids - 设置覆盖主机作为主机的数据源;ABCDE._hostids - 设置一个部件兼容性（其Reference参数设置为"ABCDE"）作为主机的数据源.如果在template dashboard上配置小部件，则不支持此参数. |
|
| Host tags | ||||
| Evaluation type | 0 | host_tags_evaltype | 0 - (默认) And/Or; 2 - Or. 如果在template dashboard上配置小部件，则不支持此参数. |
|
| Tag name | 1 | host_tags.0.tag | 任何string值. 注意: 属性名称中的数字引用标签评估列表中的标签顺序. 参数行为: - 必需 如果配置主机 tags 如果在template dashboard上配置小部件，则不支持此参数. |
|
| Operator | 0 | host_tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在. 注意: 属性名称中的数字引用标签评估列表中的标签顺序. 参数行为: - 必需 如果配置主机 tags 如果在template dashboard上配置小部件，则不支持此参数. |
|
| Tag value | 1 | host_tags.0.value | 任何string值. 注意: 属性名称中的数字引用标签评估列表中的标签顺序. 参数行为: - 必需 如果配置主机 tags 如果在template dashboard上配置小部件，则不支持此参数. |
|
| Layout | 0 | layout | 0 - (默认) 水平; 1 - 垂直. |
|
| Show problems | 0 | show_problems | 0 - 全部; 1 - (默认) 未抑制; 2 - 无. |
|
| Items (see below) | ||||
高级配置
以下为Top 监控项小部件支持的高级配置参数.
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Host ordering | ||||
| Order by | 0 | host_ordering_order_by | 0 - (默认) 主机名; 3 - 监控项 值. |
|
| 监控项 模式 | 1 | host_ordering_item.0 | Item 名称或模式 (例如 "*: 每秒处理的*值数量"). 注意: 要配置多个监控项模式，需为每个监控项模式create一个仪表板小部件字段object，并在属性名称中使用递增数字. 在template dashboard上配置小部件时，只应设置模板上配置的监控项的模式. 参数行为: - 必填 如果排序依据设置为"监控项 值" |
|
| Order | 0 | host_ordering_order | 2 - (默认) Top N; 3 - 底部N. |
|
| Limit | 0 | host_ordering_limit | 有效值范围为1-100. 默认: 10. |
|
| Item ordering | ||||
| Order by | 0 | item_ordering_order_by | 1 - 主机; 2 - 监控项 名称; 3 - (默认) 监控项 值. |
|
| 主机 模式 | 1 | item_ordering_host.0 | Host 名称或模式. 注意: 要配置多个主机模式，需为每个主机模式create一个仪表板小部件字段object，并在属性名称中使用递增数字. 参数行为: - 必填 如果排序依据设置为"主机" |
|
| Order | 0 | item_ordering_order | 2 - (默认) Top N; 3 - 底部N. |
|
| Limit | 0 | item_ordering_limit | 有效值范围为1-100. 默认: 10. |
|
列
属性名称中的第一个数字（例如columns.0.监控项.0, columns.0.item_tags_evaltype）表示特定列，而第二个数字（如果存在）表示配置的实体（例如监控项模式，标签）。
| 参数 | 仪表板小部件字段 | 名称 | 值 | |
|---|---|---|---|---|
| Item patterns | 1 | columns.0.items.0 | Item名称或模式（例如"*: 每秒处理的*值数量"）。 注意：要配置多个监控项模式，create为每个监控项模式创建一个仪表板小部件字段object，并在属性名称中递增第二个数字。 在template dashboard上配置小部件时，只应设置模板上配置的监控项的模式。 参数行为: - 必填 |
|
| Item tags | ||||
| 评估类型 | 0 | columns.0.item_tags_evaltype | 0 - (默认) 与/或; 2 - 或。 |
|
| 标签名称 | 1 | columns.0.item_tags.0.tag | 任何string值。 注意：属性名称中的第二个数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置监控项标签则为必填 |
|
| 运算符 | 0 | columns.0.item_tags.0.operator | 0 - 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在。 注意：属性名称中的第二个数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置监控项标签则为必填 |
|
| 标签值 | 1 | columns.0.item_tags.0.value | 任何string值。 注意：属性名称中的第二个数字引用标签评估列表中的标签顺序。 参数行为: - 如果配置监控项标签则为必填 |
|
| Base color | 1 | columns.0.base_color | 十六进制颜色代码（例如FF0000）。 |
|
| Display value as | 0 | columns.0.display_value_as | 1 - (默认) 数字; 2 - 文本。 |
|
| Display | 0 | columns.0.display | 1 - (默认) 原样; 2 - 条形图; 3 - 指示器; 6 - 迷你图。 |
|
| Min | 1 | columns.0.min | 任何数值。支持Suffixes（例如"1d", "2w", "4K", "8G"）。 参数行为: - 如果显示值类型设置为"数字"且显示设置为"条形图"或"指示器"则为支持 |
|
| Max | 1 | columns.0.max | 任何数值。支持Suffixes（例如"1d", "2w", "4K", "8G"）。 参数行为: - 如果显示值类型设置为"数字"且显示设置为"条形图"或"指示器"则为支持 |
|
| Sparkline | ||||
| 宽度 | 0 | columns.0.sparkline.width | 可能的值范围为0-10。 默认：1。 参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 填充 | 0 | columns.0.sparkline.fill | 可能的值范围为0-10。 默认：3。 参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 颜色 | 1 | columns.0.sparkline.color | 十六进制颜色代码（例如FF0000）。默认： 42A5F5。参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 时间段 | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - 将Time period selector设置为数据源;ABCDE._timeperiod - 将部件兼容性（其reference参数等于ABCDE）设置为数据源。默认： DASHBOARD._timeperiod或者，您可以在从和到参数中仅设置时间段。 参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 从 | 1 | columns.0.sparkline.time_period.from | 有效的绝对时间string（YYYY-MM-DD hh:mm:ss）或relative时间语法（now, now/d, now/w-1w等）。参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 到 | 1 | columns.0.sparkline.time_period.to | 有效的绝对时间string（YYYY-MM-DD hh:mm:ss）或relative时间语法（now, now/d, now/w-1w等）。参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| 历史数据 | 0 | columns.0.sparkline.history | 0 - (默认) 自动; 1 - 历史; 2 - 趋势。 参数行为: - 如果显示设置为"迷你图"则为支持 |
|
| Thresholds | ||||
| 颜色 | 1 | columns.0.thresholds.0.color | 十六进制颜色代码（例如FF0000）。参数行为: - 如果显示值类型设置为"数字"则为支持 |
|
| 阈值 | 1 | columns.0.thresholds.0.threshold | 任何数值。支持Suffixes（例如"1d", "2w", "4K", "8G"）。 参数行为: - 如果显示值类型设置为"数字"则为支持 |
|
| Highlights | ||||
| 高亮 | 1 | columns.0.highlights.0.color | 十六进制颜色代码（例如FF0000）。参数行为: - 如果显示值类型设置为"文本"则为支持 |
|
| 阈值 | 1 | columns.0.highlights.0.pattern | 任何正则表达式。 参数行为: - 如果显示值类型设置为"文本"则为支持 |
|
| Decimal places | 0 | columns.0.decimal_places | 可能的值范围为0-10。 默认：2。 |
|
| Advanced configuration | ||||
| Aggregation function | 0 | columns.0.aggregate_function | 如果显示值类型设置为"数字": 0 - (默认) 未使用; 1 - 最小值; 2 - 最大值; 3 - 平均值; 4 - 计数; 5 - 总和; 6 - 第一个; 7 - 最后一个。 如果显示值类型设置为"文本": 0 - (默认) 未使用; 4 - 计数; 6 - 第一个; 7 - 最后一个。 |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - 将Time period selector设置为数据源;ABCDE._timeperiod - 将部件兼容性（其reference参数等于ABCDE）设置为数据源。默认： DASHBOARD._timeperiod或者，您可以在从和到参数中仅设置时间段。 参数行为: - 如果聚合函数设置为"最小值", "最大值", "平均值", "计数", "总和", "第一个", "最后一个"则为支持 |
|
| 从 | 1 | columns.0.time_period.from | 有效的绝对时间string（YYYY-MM-DD hh:mm:ss）或relative时间语法（now, now/d, now/w-1w等）。参数行为: - 如果时间段未设置且聚合函数设置为"最小值", "最大值", "平均值", "计数", "总和", "第一个", "最后一个"则为支持 |
|
| 到 | 1 | columns.0.time_period.to | 有效的绝对时间string（YYYY-MM-DD hh:mm:ss）或relative时间语法（now, now/d, now/w-1w等）。参数行为: - 如果时间段未设置且聚合函数设置为"最小值", "最大值", "平均值", "计数", "总和", "第一个", "最后一个"则为支持 |
|
| History data | 0 | columns.0.history | 0 - (默认) 自动; 1 - 历史; 2 - 趋势。 参数行为: - 如果显示值类型设置为"数字"则为支持 |
|
示例
以下示例仅描述Top 监控项小工具中仪表板小工具字段objects的配置. 有关配置仪表板的更多信息，请参阅dashboard.create.
配置顶部监控项部件
配置一个Top 监控项小部件，用于显示主机 "10084"的数据，且仅显示标签名称为"component"且包含值"cpu"的监控项。 此外，使用位于Top的主机显示数据，并采用彩色计量条进行单元格展示。
执行请求:
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "topitems",
"name": "Top items",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostids.0",
"value": 10084
},
{
"type": 1,
"name": "columns.0.items.0",
"value": "*"
},
{
"type": 1,
"name": "columns.0.item_tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "columns.0.item_tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "columns.0.item_tags.0.value",
"value": "cpu"
},
{
"type": 0,
"name": "columns.0.display",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}响应: