2022 Zabbix中国峰会
2022 Zabbix中国峰会

21 TOP主机

描述

这些参数及其可能的属性值允许配置dashboard.createdashboard.update方法中的TOP主机仪表盘小部件。

在创建或更新仪表盘时,不会验证小部件fields属性。 这允许用户修改内置小部件并创建自定义小部件,但同时也引入了错误创建或更新小部件的风险。 为确保TOP主机小部件的成功创建或更新,请参考下表中概述的参数要求。

参数

以下参数支持TOP主机小部件。

参数 类型 名称
刷新间隔 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟。
主机组 2 groupids 主机组 ID。

注意:要配置多个主机组,为每个主机组创建一个仪表盘小部件字段对象。
主机 3 hostids 主机 ID。

注意:要配置多个主机,为每个主机创建一个仪表盘小部件字段对象。对于多个主机,参数 主机组 必须要么完全未配置,要么配置了至少一个主机组,且配置的主机属于这些主机组。
主机标签(属性名称中的数字(例如tags.tag.0)引用标签评估列表中的标签顺序)
评估类型 0 evaltype 0 - (默认) 与/或;
2 - 或。
标签名称 1 tags.tag.0 任何字符串值。

如果配置 标签,需要参数 标签名称
运算符 0 tags.operator.0 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在。

如果配置 标签,需要参数 运算符
标签值 1 tags.value.0 任何字符串值。

如果配置 标签,需要参数 标签值
(见下文)
顺序 0 order 2 - (默认) 顶部N;
3 - 底部N。
排序列 0 column 从配置列中的列数值。
主机数量 0 count 有效值范围从1-100。

默认:10。

列具有通用参数以及根据参数数据配置而变化的附加参数。

对于所有与列相关的参数,属性名称中的数字(例如 columns.name.0)引用了为该参数配置的列。

对于所有列,支持以下参数。

参数 类型 名称
名称 1 columns.name.0 任何字符串值。
数据
(必需)
0 columns.data.0 1 - 监控项值;
2 - 主机名;
3 - 文本。
基础颜色
(必需)
1 columns.base_color.0 十六进制颜色代码(例如 FF0000)。
监控项值

如果数据设置为"监控项值",则支持以下参数。

阈值属性名称中的第一个数字(例如 columnsthresholds.color.0.0)引用了配置阈值的列, 而第二个数字引用了列表中阈值的位置,按升序排序。 然而,如果阈值配置的顺序不同,更新 Zabbix 前端小部件配置后的值将按升序排序 (例如 "threshold.threshold.0":"5""threshold.threshold.0":"1"; "threshold.threshold.1":"1""threshold.threshold.1": "5")。

参数 类型 名称
监控项 1 columns.item.0 有效的监控项名称。
时间偏移
(必需)
1 columns.timeshift.0 有效的数字或时间字符串值(例如 36001h)。
您可以使用时间后缀。允许负值。
聚合函数 0 columns.aggregate_function.0 0 - (默认) 无;
1 - 最小值;
2 - 最大值;
3 - 平均值;
4 - 计数;
5 - 求和;
6 - 第一个;
7 - 最后一个。
聚合间隔 1 columns.aggregate_interval.0 有效的时间字符串(例如 3600, 1h 等)。
您可以使用时间后缀

如果 聚合函数 设置为 ,则参数 聚合间隔 不可用。

默认:1h
显示 0 columns.display.0 1 - (默认) 原样;
2 - 条形图;
3 - 指示器。
最小值 1 columns.min.0 任何数值。

如果 显示 设置为"原样",则参数 最小值 不可用。
最大值 1 columns.max.0 任何数值。

如果 显示 设置为"原样",则参数 最大值 不可用。
历史数据 0 columns.history.0 1 - (默认) 自动;
2 - 历史记录;
3 - 趋势。
阈值
颜色 1 columnsthresholds.color.0.0 十六进制颜色代码(例如 FF0000)。

默认:""(空)。
阈值 1 columnsthresholds.threshold.0.0 任何字符串值。
文本

如果数据设置为"文本",则支持以下参数。

参数 类型 名称
文本 1 columns.text.0 任何字符串值,包括宏。
支持的宏:{HOST.}, {INVENTORY.}。

如果数据设置为"文本",则需要参数 文本

示例

以下示例旨在仅描述TOP主机仪表盘小部件的配置。 有关配置仪表盘的更多信息,请参见dashboard.create

配置一个TOP主机小部件

配置一个TOP主机小部件,用于展示主机组"4"中按CPU利用率排名的主机。 此外,配置以下自定义列:"主机名","利用率","1分钟平均","5分钟平均","15分钟平均","进程数"。

请求:

{
           "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
       }

响应:

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

另请参阅