15 监控项 历史记录

描述

这些参数以及相应 dashboard widget 字段对象的可选属性值，可用于在 dashboard.create 和 dashboard.update 方法中配置 Item history widget。

在创建或更新 dashboard 时，不会对 widget fields 属性进行校验。 这使用户可以修改 内置 widget 并创建 自定义 widget，但也会带来错误创建或更新 widget 的风险。 为确保成功创建或更新 Item history widget，请参阅下表中概述的参数行为。

参数

监控项 历史记录 小部件支持以下参数。

参数 仪表板小部件字段 名称 值
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 上配置 widget，则不支持此参数。
Advanced configuration (see below)
Reference 1 reference 任何由5字符组成的string值（例如，ABCDE 或 JBPNL）。此值在该widget所属的仪表板中必须唯一。

参数行为：
- 必填

列

列具有根据监控项参数的配置而变化的通用参数和附加参数。

对于与列相关的所有参数，属性名称中的数字（例如 columns.0.name）表示为其配置参数的列。

以下参数适用于所有列。

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

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

在 template dashboard 上配置 widget 时，仅应设置模板上配置的 监控项。

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

默认值：""（空）。

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

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

参数行为:
- 当显示设置为"Bar"或"Indicators"时支持
Max 1 columns.0.max 任意数值。

参数行为:
- 当显示设置为"Bar"或"Indicators"时支持
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 - 已启用。

高级配置

以下高级配置参数适用于 Item history 小部件。

参数 type 名称 值
新值 0 sortorder 0 - (默认) 顶部；
1 - 底部。
显示时间戳 0 show_timestamp 0 - (默认) 禁用；
1 - 启用。
显示列标题 0 show_column_header 0 - 关闭；
1 - 水平；
2 - (默认) 垂直。
时间段 1 time_period._reference DASHBOARD._timeperiod - 将 时间段 选择器 设为数据源；
ABCDE._timeperiod - 将 兼容的小部件（其 Reference 参数设置为 "ABCDE"）设为数据源。

默认值：DASHBOARD._timeperiod

或者，你也可以仅在 From 和 To 参数中设置时间段。
From 1 time_period.from 有效的时间字符串，支持绝对时间语法（YYYY-MM-DD hh:mm:ss）或 相对 时间语法（now、now/d、now/w-1w 等）。

参数行为：
- 如果未设置 时间段，则为 supported
- 如果设置了 time_period.to，则为 required
To 1 time_period.to 有效的时间字符串，支持绝对时间语法（YYYY-MM-DD hh:mm:ss）或 相对 时间语法（now、now/d、now/w-1w 等）。

参数行为：
- 如果未设置 时间段，则为 supported
- 如果设置了 time_period.from，则为 required

示例

以下示例仅用于描述仪表板中用于监控项历史记录小部件的get字段objects的配置。 有关配置仪表板的更多信息，请参见dashboard.create。

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

配置一个监控项 历史记录小部件get，用于显示两个数值型监控项 "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
}

另请参阅