16 监控项 历史

描述

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

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

参数

以下参数适用于监控项历史小部件。

参数 仪表板小部件字段 名称
Refresh interval 0 rf_rate 0 - 不刷新;
10 - 10秒;
30 - 30秒;
60 - (默认) 1分钟;
120 - 2分钟;
600 - 10分钟;
900 - 15分钟.
Layout 0 layout 0 - (默认) 水平;
1 - 垂直.
Columns (see below)
Show lines 0 show_lines 取值范围为1-100.

默认: 25.
Override host 1 override_hostid._reference ABCDE._hostid - 将部件兼容性(其Reference参数设置为"ABCDE")作为主机的数据源;
DASHBOARD._hostid - 将仪表板覆盖主机作为主机的数据源.

如果在template dashboard上配置小部件,则不支持此参数.
Advanced configuration (see below)
Reference 1 reference 任何由5个字符组成的string值(例如ABCDEJBPNL). 此值在所属仪表板中必须唯一.

参数行为:
- 必填

列具有通用参数以及根据监控项参数配置而定的附加参数.

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

所有列均支持以下参数。

参数 仪表板小部件字段 名称
Name 1 columns.0.name 任意string值。

参数行为:
- 必填
Item 4 columns.0.itemid Item ID。

template dashboard上配置部件时,仅应设置模板上配置的监控项。

参数行为:
- 必填
Base color 1 columns.0.base_color 十六进制颜色代码(例如FF0000)。

默认值:""(空)。

如果配置的监控项是数值类型监控项,则支持以下列参数。

参数 仪表板小部件字段 名称
Display 0 columns.0.display 1 - (默认) 原样显示;
2 - 条形图;
3 - 指示器.
Min 1 columns.0.min 任意数值.

参数行为:
- 支持显示设置为"条形图"或"指示器"时
Max 1 columns.0.max 任意数值.

参数行为:
- 支持显示设置为"条形图"或"指示器"时
Thresholds
颜色 1 columns.0.thresholds.0.color 十六进制颜色代码 (例如 FF0000).
阈值 1 columns.0.thresholds.0.threshold 任意数值. Suffixes (例如 "1d", "2w", "4K", "8G") 支持.
History data 0 columns.0.history 0 - (默认) 自动;
1 - 历史数据;
2 - 趋势数据.

如果配置的监控项为字符、文本或日志类型监控项,则支持以下列参数。

参数 仪表板小部件字段 名称
Highlights
高亮 1 columns.0.highlights.0.color 十六进制颜色代码(例如FF0000)。
阈值 1 columns.0.highlights.0.pattern 任意正则表达式。
Display 0 columns.0.display 1 - (默认) 原样显示;
4 - HTML;
5 - 单行。
单行 0 columns.0.max_length 取值范围1-500。

默认值:100。

参数行为:
- 支持显示设置为"单行"时
Use monospace font 0 columns.0.monospace_font 0 - (默认) 使用默认字体;
1 - 使用等宽字体。
Display local time 0 columns.0.local_time 0 - (默认) 显示时间戳;
1 - 显示本地时间。

参数行为:
- 支持监控项设置为日志类型监控项,且显示时间戳设置为"启用"时

如果配置的监控项是二进制类型监控项,则支持以下列参数。

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

高级配置

以下高级配置参数适用于监控项历史小部件。

参数 仪表板小部件字段 名称
New values 0 sortorder 0 - (默认) Top;
1 - 底部.
Show timestamp 0 show_timestamp 0 - (默认) 禁用;
1 - 启用.
Show column header 0 show_column_header 0 - 关闭;
1 - 水平;
2 - (默认) 垂直.
Time period 1 time_period._reference DASHBOARD._timeperiod - 将Time period selector设置为数据源;
ABCDE._timeperiod - 将部件兼容性(其参考参数设置为"ABCDE")设置为数据源.

默认: DASHBOARD._timeperiod

或者,您也可以仅在参数中设置时间段.
1 time_period.from 有效的绝对时间string(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w, 等)。

参数行为:
- 支持 如果时间段未设置
1 time_period.to 有效的绝对时间string(YYYY-MM-DD hh:mm:ss)或relative时间语法(now, now/d, now/w-1w, 等)。

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

示例

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

配置监控项历史记录小部件

配置一个显示两个数值型监控项 "42269"和"42270"最新数据的监控项历史部件。 此外,将监控项列配置为垂直显示,列名水平显示;将数据显示限制为15行,并包含单独的时间戳列。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "itemhistory",
                               "name": "Item history",
                               "x": "0",
                               "y": "0",
                               "width": "18",
                               "height": "6",
                               "view_mode": "0",
                               "fields": [
                                   {
                                       "type": "0",
                                       "name": "layout",
                                       "value": "1"
                                   },
                                   {
                                       "type": "1",
                                       "name": "columns.0.name",
                                       "value": "CPU utilization"
                                   },
                                   {
                                       "type": "4",
                                       "name": "columns.0.itemid",
                                       "value": "42269"
                                   },
                                   {
                                       "type": "1",
                                       "name": "columns.1.name",
                                       "value": "Memory utilization"
                                   },
                                   {
                                       "type": "4",
                                       "name": "columns.1.itemid",
                                       "value": "42270"
                                   },
                                   {
                                       "type": "0",
                                       "name": "show_lines",
                                       "value": "15"
                                   },
                                   {
                                       "type": "0",
                                       "name": "show_timestamp",
                                       "value": "1"
                                   },
                                   {
                                       "type": "0",
                                       "name": "show_column_header",
                                       "value": "1"
                                   },
                                   {
                                       "type": "1",
                                       "name": "reference",
                                       "value": "KIVKD"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅