查询监控数据 | OceanBase 文档中心

查询监控数据

更新时间：2024-08-22 13:55:46

功能说明

查询指定指标的监控数据。需要指定查询的时间区间、指标的数组。通过标签指定查询的范围，并将数据以指定的标签汇总。结果以时序的形式来输出。

无论选择多大的时间范围，结果数据规模都会趋近于 1440 个采样点。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

请求路径

GET /api/v2/monitor/metric

请求参数

参数	类型	必选	示例值	描述
startTime	Datetime	是	2020-02-16T05:32:16+08:00	监控数据的开始时间。
endTime	Datetime	是	2020-02-16T07:32:16+08:00	监控数据的结束时间。
metrics	StringArray	是	io_read_time,io_write_time	监控指标的数组。
groupBy	StringArray	是	app,obregion,ob_cluster_id	监控数据的汇总标签。其中： app：监控数据采集的来源。可以取值为 `host`、`ob` 或 `obproxy`，分别代表主机监控、OceanBase 监控和 OBProxy 监控。 obregion：即 ob_cluster_name，监控的 OceanBase 集群名称。 ob_cluster_id：监控的 OceanBase 集群 ID。
interval	Integer	是	60	监控数据的时间粒度，单位为秒。
minStep	Integer	否	10	查询采样间隔，代表最小监控结果采样时间间隔，默认值为 0。
maxPoints	Integer	否	360	监控结果最大返回点数，默认值为 1440。
labels	StringArray	是	app:ob,obregion=foo	监控数据的过滤条件。

返回结果

基础数据结构

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	监控采样的数组，数据结构见下表。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的服务端的地址。

监控采样的数据结构，数据结构根据查询的监控指标来确定。

参数	类型	说明
timestamp	Integer	采样的时间点，为距 1970-01-01 00:00:00 的秒数。
指标名A	Float	对应指标的采样值
指标名B	Float	对应指标的采样值

示例

请求示例

请求 2020-11-11 18:30:00.000+08:00 至 2020-11-11 19:00:00.000+08:00 的监控数据；请求的监控指标为 net_recv 和 net_send ，采样间隔为 60 秒；指标值为 app=ob, obregion=ob1,ob_cluster_id=1；监控数据以 app、obregion、ob_cluster_id 三个标签来汇总：

/api/v2/monitor/metric?startTime=2020-11-11T18%3A30%3A00.000%2B08%3A00&endTime=2020-11-11T19%3A00%3A00.000%2B08%3A00&interval=60&metrics=net_recv%2Cnet_send&labels=app%3Aob%2Cobregion%3Aob1%2Cob_cluster_id%3A1&groupBy=app%2Cobregion%2Cob_cluster_id

返回示例

{
    "duration":113,
    "server": "a83ad33525",
    "status":200,
    "successful":true,
    "timestamp":"2020-11-17T19:01:45.404+08:00",
    "traceId":"0d40b2d8e6984e49",
    "data":{
        "contents":[
            {
                "net_recv":0.3,
                "net_send":0.31,
                "timestamp":1605609840
            },
            {
                "net_recv":0.29,
                "net_send":0.3,
                "timestamp":1605610800
            }
        ],
        "page":{
            "number":2,
            "size":2147483647,
            "totalElements":30,
            "totalPages":1
        }
    }
}