分页查询应用监控或前端监控的相关监控指标。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的
Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
-
对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
arms:QueryMetricByPage | Read |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
IntervalInSec | integer | 是 |
数据片的时间间隔,单位为毫秒,最小值为 60000。 |
100000 |
StartTime | long | 是 |
起始时间的时间戳,精确到毫秒。 |
1667287695000 |
EndTime | long | 是 |
结束时间的时间戳,精确到毫秒。 |
1667546895000 |
OrderBy | string | 否 |
排序依据,可设为任一测量数据。 |
pid |
Metric | string | 是 |
需要查询的指标,不可自定义输入,请参见下文补充说明。 |
appstat.host |
Order | string | 否 |
排序标准。取值:
ASC
:升序。
DESC
:降序。
|
ASC |
CurrentPage | integer | 否 |
查询结果的页码,默认为
|
1 |
PageSize | integer | 否 |
此参数已不支持使用。查询结果的每页项目数量。 |
10 |
object [] | 否 |
筛选条件组合。 |
||
Key | string | 否 |
筛选条件组合,必须添加
|
pid |
Value | string | 否 |
筛选条件组合,必须添加
|
xxx@74xxx |
array | 否 |
指标对应的维度。 |
||
string | 否 |
指标对应的维度,请参见下文补充说明。最多可添加 5 个。 |
pid | |
array | 否 |
指标对应的测量数据。 |
||
string | 否 |
指标对应的测量数据,请参见下文补充说明。最多可添加 5 个。 |
instanceCount | |
array | 否 |
自定义过滤条件。 |
||
string | 否 |
自定义过滤条件,多个过滤条件之间使用半角逗号(,)分隔。 |
["not rpcType:40","not rpcType:41"] |
如何获取应用 pid
在 ARMS 控制台左侧导航栏选择 应用监控 > 应用列表 或 前端监控 > 前端列表 ,然后单击目标应用名称,以进入应用的总览页面。
此时浏览器地址栏中的 URL 即包含前端应用的
pid
,格式为
pid=xxx
。由于浏览器进行了编码,应用需要对
xxx%40xxx
格式的 pid 稍作修改。例如,如果 URL 中包含的 pid 为
eb4zdose6v%409781be0f44d****
,则需要将
%40
替换为
@
,即:
eb4zdose6v@9781be0f44d****
。
可查询的应用监控指标
请求参数 Filters 必须添加
pid
和
regionId
条件。已知具体的查询条件时,应将值传入
Filters
参数中,用于限定查询结果的范围。如果不知道具体的查询条件,可以将下表中的维度传入
Dimensions
参数,从而获得该维度所有可能值的列表。
指标(Metric) | 描述 | 维度(Dimensions) | 测量数据(Measures) |
---|---|---|---|
appstat.vm | 通用指标,对应应用详情下的 JVM 监控图表,包括 GC 指标、堆内存和非堆内存详情以及线程数。 |
- pid
- rootIp |
GC 指标:
- youngGcCount:JVM 监控 Young GC 次数 - oldGcCount:JVM 监控 Full GC 次数 - youngGcTime:JVM 监控 Young GC 耗时 - oldGcTime:JVM 监控 Full GC 耗时 - youngGcCountInstant:JVM 监控 Young GC 次数瞬时值 - oldGcCountInstant:JVM 监控 Full GC 次数瞬时值 - youngGcTimeInstant:JVM 监控 Young GC 耗时瞬时值 - oldGcTimeInstant:JVM 监控 Full GC 耗时瞬时值 |
appstat.vm | 通用指标,对应应用详情下的 JVM 监控图表,包括 GC 指标、堆内存和非堆内存详情以及线程数。 |
- pid
- rootIp |
堆内存和非堆内存详情:
- edenSpace:年轻代 eden 区 - oldGen:老年代 - survivorSpace:年轻代 survivor 区 - metaSpace:元空间 - nonHeapCommitted:非堆内存 - nonHeapInit:非堆内存初始值 - nonHeapMax:非堆内存最大值 - nonHeapUsed:非堆内存使用量 - directUsed:对外内存中 direct_buffer 已使用的大小 - directCapacity:对外内存中 direct_buffer 的总大小 |
appstat.vm | 通用指标,对应应用详情下的 JVM 监控图表,包括 GC 指标、堆内存和非堆内存详情以及线程数。 |
- pid
- rootIp |
线程数:
- threadCount:线程总数 - threadNewCount:新建线程数 - threadDeadlockCount:JVM 内死锁的个数 - threadRunnableCount:JVM 处于 Runnable 的线程个数 - threadTerminatedCount:终结线程数 - threadTimedWaitCount:处于 timed_waiting 状态的线程个数 - threadWaitCount:处于 waiting 状态的线程个数 - threadBlockedCount:阻塞线程数 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
instanceCount:实例数 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
CPU:
- systemCpuIdle:最近 5s 的空闲 CPU 使用率,控制台页面未展示 - systemCpuSystem:最近 5s 的系统 CPU 使用率 - systemCpuUser:最近 5s 的用户 CPU 使用率 - systemCpuIoWait:最近 5s 的等待 IO 完成的 CPU 使用率 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
物理内存:
- systemMemFree:当前系统的空闲内存(KB) - systemMemUsed:当前系统的已经使用的内存(KB) - systemMemTotal:当前系统的总内存(KB),控制台页面未展示 - systemMemBuffers:当前系统的 buffer cache 的内存数 - systemMemCached:当前系统的 page cache 里的内存数 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
磁盘:
- systemDiskFree:磁盘空闲字节数 - systemDiskUsage:磁盘使用率 - systemDiskTotal:磁盘总字节数,公共云控制台页面未展示 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
systemLoad:负载 |
appstat.host | 主机监控,包括实例数、CPU、物理内存、磁盘、负载、网络流量(Bytes)和网络数据包数量。 |
- pid
- rootIp |
网络:
- systemNetInPackets:最近 30 秒平均每秒网络接收到的报文数 - systemNetOutPackets:最近 30 秒平均每秒网络发送的字节数 - systemNetInErrs:最近 30 秒平均每秒网络接收的错误数 - systemNetOutErrs:最近 30 秒平均每秒网络发送的错误数 - systemNetInBytes:最近 30 秒平均每秒网络接收到的字节数 - systemNetOutBytes:最近 30 秒平均每秒网络发送的字节数 |
appstat.database | 数据库调用。 |
- pid
- rpcType:调用类型 - endpoint:数据库地址为 localhost: 3306 - destId:库名为 arms |
- rt:响应时间
- count:请求数 - error:错误数 - resultsize:仅支持 Mysql 5.X 版本 - slowcount:慢调用次数 |
appstat.incall | 应用详情。 |
- pid
- rpcType - rootIp - rpc - ppid |
- rt:响应时间
- count:请求数 - error:错误数 - exception:异常 - errorrate:错误率 - qps:每秒查询数 |
appstat.exception | 异常。 |
- pid
- rpc - endpoint - excepType - excepInfo |
- rt:响应时间
- count:请求数 - error:错误数 |
appstat.sql | 慢 SQL。 |
- pid
- rpc - endpoint - sqlId |
- rt:响应时间
- count:请求数 - error:错误数 - slowcount:慢调用次数 - resultsize:仅支持 Mysql 5.X 版本 说明:slow=true 时,limit 条件不生效。 |
appstat.mq.send | MQ 发送。 | 无 |
- rt:响应时间
- count:请求数 - error:错误数 - delay:调度延迟 |
appstat.mq.receive | MQ 接收。 | 无 |
- rt:响应时间
- count:请求数 - error:错误数 - delay:调度延迟 |
appstat.schedulerx | SchedulerX 的调用量。 |
- pid
- rpcType - rootIp - rpc |
count:请求数 |
appstat.elasticsearch | Elasticsearch 的调用量。 |
- rpc
- endpoint - opType:操作类型。例如 index、search 等。仅使用 Elasticsearch rest high level client 时支持。 |
count:请求数 |
appstat.redis | Redis 的调用量。 |
- pid
- rpcType - endpoint - opType - rpc |
count:请求数 |
appstat.status | 查询指定状态码下的调用次数(仅支持 HTTP 服务)。 |
- pid
- rootIp - rpc |
- 200:HTTP 状态码为 200(即正常)的调用次数
- 2xx:HTTP 状态码以 2 开头(即正常)的调用次数 - 3xx:HTTP 状态码为 3 开头的调用次数 - 4xx:HTTP 状态码以 4 开头(即客户端错误)的调用次数 - 5xx:HTTP 状态码以 5 开头(即服务端错误)的调用次数 |
可查询的前端监控指标
您可以使用 QueryMetric 接口查询前端监控的以下指标。
请求参数 Filters 必须添加
pid
和
regionId
条件。已知具体的查询条件时,应将值传入
Filters
参数中,用于限定查询结果的范围。如果不知道具体的查询条件,可以将下表中的维度传入
Dimensions
参数,从而获得该维度所有可能值的列表。
指标(Metric) | 描述 | 维度(Dimensions) | 测量数据(Measures) |
---|---|---|---|
webstat.api | API 成功率 |
- api(API 请求地址,不带参数)
- detector_app_version(客户端版本) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - release(版本号) - sr(屏幕分辨率) |
- count(请求次数)
- rate(API 成功率) - avg_time(平均耗时) |
webstat.api.detail | API 详情 |
- api(API 请求地址,不带参数)
- ct(网络制式) - detector_browser(浏览器) - detector_browser_version(浏览器版本) - detector_device(设备) - detector_os(操作系统) - detector_os_version(操作系统版本) - domain(域名) - ip_country_id(国家 ID 或区域 ID) - ip_isp(运营商) - ip_region_id(中国省市 ID) - msg(返回信息) - page(页面地址) - sr(屏幕分辨率) |
- count(请求次数)
- fail_count(失败次数) - fail_time(失败耗时) - fail_uv(失败影响用户数) - success_count(成功次数) - success_rate(成功率) - success_time(成功耗时) |
webstat.apicost | API 成功耗时 |
- api(API 请求地址,不带参数)
- code(返回状态码) - detector_app_version(客户端版本) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - release(版本号) - sr(屏幕分辨率) |
- count(成功次数)
- avg_time(成功耗时均值) |
webstat.apifailtime | API 失败耗时 |
- api(API 请求地址,不带参数)
- code(返回状态码) - detector_app_version(客户端版本) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - release(版本号) - sr(屏幕分辨率) |
- count(错误次数)
- avg_time(失败耗时均值) |
webstat.apimsg | API 消息聚类 |
- code(返回状态码)
- detector_app_version(客户端版本) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - msg(错误信息) - release(版本号) - sr(屏幕分辨率) - success(1 表示请求成功,0 表示请求失败) |
count(请求次数) |
webstat.avg | 自定义统计:均值统计 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - key(自定义 Key) - sr(屏幕分辨率) |
- count(总次数)
- pv(页面浏览量) - uv(用户访问量) - avg_val(平均值) |
webstat.errcate | 错误聚类排行 |
- msg(错误信息)
- ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - sr(屏幕分辨率) - release(版本号) - environment(环境) - detector_app_version(客户端版本) - detector_app(客户端 App) |
count(错误次数) |
webstat.index | 总览(访问量) |
- ct(网络制式)
- detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_isp(运营商) - ip_region_id(中国省市 ID) - page(页面地址) - sr(屏幕分辨率) |
- pv(页面浏览量)
- uv(独立访客) |
webstat.msg.top | 页面高频错误 |
- msg(错误信息)
- page(页面地址) |
- count(错误次数)
- error_uv(影响用户数) - 影响用户率(影响用户数÷总 UV) |
webstat.perf.bucket | 对应 ARMS 前端监控控制台的 访问速度 页面上的性能样本分层图。 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - page(页面地址) - sr(屏幕分辨率) |
- cfpt(自定义首屏)
- ctti(自定义首次可交互) - dns(DNS 查询耗时) - dom(DOM 解析耗时) - fmp(首屏时间) - fpt(首次渲染时间) - load(页面完全加载时间) - ready(DOM Ready 时间) - res(资源加载耗时) - ssl(SSL 安全连接耗时) - t1~t10(自定义性能指标) - tcp(TCP 连接耗时) - trans(内容传输耗时) - ttfb(请求响应耗时) - tti(首次可交互时间) |
webstat.perf.distribution | 对应 ARMS 前端监控控制台的 访问速度 页面上的性能分层图。 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - page(页面地址) - sr(屏幕分辨率) |
- cfpt(自定义首屏)
- ctti(自定义首次可交互) - dns(DNS 查询耗时) - dom(DOM 解析耗时) - fmp(首屏时间) - fpt(首次渲染时间) - load(页面完全加载时间) - ready(DOM Ready 时间) - res(资源加载耗时) - ssl(SSL 安全连接耗时) - t1~t10(自定义性能指标) - tcp(TCP 连接耗时) - trans(内容传输耗时) - ttfb(请求响应耗时) - tti(首次可交互时间) |
webstat.resource | 资源错误排行 |
- ct(网络制式)
- detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_isp(运营商) - ip_region_id(中国省市 ID) - node_name(错误类型) - page(页面地址) - sr(屏幕分辨率) - src(资源信息) |
count(资源错误数) |
webstat.resource | 对应 ARMS 前端监控控制台的 总览 页面的资源弹层。 |
- ct(网络制式)
- detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_isp(运营商) - ip_region_id(中国省市 ID) - node_name(错误类型) - page(页面地址) - sr(屏幕分辨率) - src(资源信息) |
count(错误次数) |
webstat.satisfy | 满意度 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - page(页面地址) - sr(屏幕分辨率) |
- bad(不满意:fpt>8000)
- good(满意:fpt<2000) - neutral(可容忍:fpt>2000 且 fpt<8000) - satisfy(满意指数) |
webstat.session | 慢加载追踪 | 无 |
- browser_version(浏览器版本)
- browser(浏览器) - date(开始时间) - dom(DOM 解析耗时) - ip_country_id(国家 ID 或区域 ID) - ip_country(中国省市) - ip_region_id(中国省市 ID) - ip_region(国家或区域) - load(页面完全加载) - page(页面地址) - sid(会话 ID) |
webstat.speed | 访问速度 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - release(版本号) - sr(屏幕分辨率) - page(页面地址) - environment(环境) |
- avg_cfpt(自定义首屏)
- count(样本量) - avg_ctti(自定义首次可交互) - avg_dns(DNS 查询耗时) - avg_dom(DOM 解析耗时) - avg_fmp(首屏时间) - avg_fpt(首次渲染时间) - avg_load(页面完全加载时间) - avg_ready(DOM Ready 时间) - avg_res(资源加载耗时) - avg_ssl(SSL 安全连接耗时) - avg_t1~t10(自定义性能指标) - avg_tcp(TCP 连接耗时) - avg_trans(内容传输耗时) - avg_ttfb(请求响应耗时) - avg_tti(首次可交互时间) |
webstat.stable | 错误率排行 |
- page(页面地址)
- ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - detector_browser(浏览器) - detector_device(设备) - detector_os(操作系统) - sr(屏幕分辨率) - msg(错误信息) - release(版本号) - environment(环境) - detector_app_version(客户端版本) - detector_app(客户端 App) |
- count(样本量)
- error_pv(错误样本量) - rate(JS 错误率) |
webstat.sum | 自定义统计:求和统计 |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - key(自定义 key) - sr(屏幕分辨率) |
- count(总次数)
- pv(页面浏览量) - sum_val(总和) - uv(独立访客) |
webstat.url | 访问的 URL |
- detector_browser(浏览器)
- detector_device(设备) - detector_os(操作系统) - ip_country_id(国家 ID 或区域 ID) - ip_region_id(中国省市 ID) - sr(屏幕分辨率) - uid - username(用户名) |
- pv(页面浏览量)
- uv(独立访客) |
返回参数
返回示例
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******", "Data": { "PageSize": 1, "Total": 87, "Page": 1, "Items": [ "date": 1667287680000, "instanceCount": 17, "rule": "query1", "pid": "null" "date": 1667290680000, "instanceCount": 17, "rule": "query1", "pid": "null" "Code": 200, "Success": true示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "StartTime is mandatory for this action.",
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
"Success": true,
"Data": {
"PageSize": 1,
"Total": 2,
"Page": 1,
"Completed": false,
"Items": [
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParameterMetricIllegal | The specified metric is invalid. | 参数metric非法 |
400 | ParameterMeasuresIllegal | The specified Measures is invalid. | Measures非法 |
400 | ParameterTimeStampIllegal | The specified timeStamp is invalid. | 时间参数非法 |
400 | ParameterOrderIllegal | The specified order is invalid. | 参数order非法 |
400 | ParameterZeroStrategyIllegal | The specified zeroStrategy is invalid. | 参数zeroStrategy非法 |
400 | ParameterPageSizeIllegal | The specified PageSize is invalid. | PageSize非法 |
400 | ParameterIntervalIllegal | The specified interval is invalid. | 参数Interval非法 |
400 | ParameterMeasuresMissing | You must specify measures. | 参数measures缺失 |
400 | ParameterDimensionsIllegal | The specified dimensions is invalid. | Dimensions非法 |
400 | ParameterPidMissing | You must specify pid. | 参数pid缺失 |
400 | ParameterRegionIdIllegal | The specified RegionId is invalid. | RegionId非法 |
400 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | 内部错误,建议重试。如果多次重试报错请联系钉钉服务账号。 |
400 | ParameterRegionIllegal | The specified region is invalid. | 地域参数非法 |
403 | APINotAuthorize | The current user is not authorized to access the interface. | 当前用户无权限访问该接口 |
404 | AppNotExist | The application does not exist. | 应用不存在 |
404 | RunningTaskNotExist | Application data collection task does not exist or has been stopped. | 应用数据采集任务不存在或已停止 |
429 | OperationIsThrottled | The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again. | 后端服务无法完整的处理当前请求,返回结果可能是不完整的,请调整操作条件后重试。 |
452 | OperationTimeOut | The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again. | 系统在处理当前请求时出现了超时,可能是请求涉及的资源过多导致系统无法在限定时间内处理完毕,请调整相关条件后重试。 |
访问 错误中心 查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OpenAPI 错误码发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 错误码发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 错误码发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 错误码发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 返回结构发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 入参发生变更 | 看变更集 | |||||||||||||
|
||||||||||||||
OpenAPI 入参发生变更 | 看变更集 | |||||||||||||
|
前端监控常见问题
https://arms-retcode.aliyuncs.com/r.png?
。
https://arms-retcode-sg.aliyuncs.com/r.png?
。
https://retcode-us-west-1.arms.aliyuncs.com/r.png?
。
https://arms-retcode.aliyuncs.com/r.png?
。
https://arms-retcode-sg.aliyuncs.com/r.png?
。
https://retcode-us-west-1.arms.aliyuncs.com/r.png?
。
- 本页导读 (1)