腾讯云可观测平台 API 网关监控指标

这里说明了腾讯云 API 网关的监控指标及不同维度的查询方式。API 网关可按环境维度、API 维度、密钥对维度获取监控数据,并说明了各维度的具体查询参数取值。监控指标维度: API 网关提供环境维度、API 维度、密钥对维度的监控数据查询。环境维度查询: 包含 serviceId 和环境名的相关参数取值。API 维度查询: 在环境维度基础上增加 API 的 ID 参数取值。密钥对维度查询: 需开启白名单,包含 。

相关产品
腾讯云可观测平台 产品页,含版本规格、价格与购买入口。

一、命名空间

Namespace=QCE/APIGATEWAY

二、监控指标

指标英文名 指标中文名 指标说明 单位 维度 统计规则[period, statType]
Apiservererror404 404请求数 API 级别404错误数 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
Apiservererror502 502请求数 API 级别502错误数 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
ClientError 前台错误数 客户端发送到 API 网关的请求是非法请求,如鉴权不通过或者超过限流值的错误个数,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Clienterror429 429请求数 请求 API 网关被限流,返回429错误码的请求的个数 Count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
ConcurrentConnections 并发连接数 API 网关当前长连接的数量,按照所选择的时间粒度的平均值 count apiId, environmentName, serviceId [60s, sum]
[300s, max]
[3600s, max]
[86400s, max]
InTraffic 入口带宽流量 API 网关所发出的内网数据包的流量,按照所选择的时间粒度统计求和 MBytes apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Maxresponsetime 请求最大时延 API 网关对请求作出响应的最大时间,按照所选择的时间粒度的最大值 ms apiId, environmentName, serviceId [60s, max]
[300s, max]
[3600s, max]
[86400s, max]
NumOfReq 请求数 经过 API 网关的请求数量,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
OutTraffic 出口带宽流量 API 网关所发出的公网数据包的流量,按照所选择的时间粒度统计求和 MB apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
ResponseTime 请求平均时延 API 网关对请求作出响应的时间,按照所选择的时间粒度的平均值 ms apiId, environmentName, serviceId [60s, avg]
[300s, avg]
[3600s, avg]
[86400s, avg]
ServerError 后台错误数 API 网关将消息转发到后端服务,后端服务返回大于等于400错误状态码的个数,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Servererror4xx 4xx 请求数 API 网关尝试执行后端请求时,后端服务器返回4XX 错误码,此类错误的个数的统计,按照所选择的时间粒度统计求和。 Count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Servererror500 后台500错误 此类错误的个数的统计,按照所选择的时间粒度统计求和 Count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
ServerError504 504请求数 API 网关尝试执行后端请求时,后端 IP 不可触达的错误数。此类错误的个数的统计,按照所选择的时间粒度统计求和 Count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Servererror5xx 5xx请求数 API 网关尝试执行后端请求时,后端服务器返回5XX 错误码,此类错误的个数的统计,按照所选择的时间粒度统计求和。 Count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Serviceservererror404 404请求数 请求后端服务失败,请求所希望的资源未被在后端服务器上发现,此类错误的个数的统计,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
Serviceservererror502 502请求数 API 网关尝试执行后端请求时,从后端服务器接收到无效的响应,此类错误的个数的统计,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, sum]
[300s, sum]
[3600s, sum]
[86400s, sum]
SuccReq 成功请求数 经过 API 网关的有效调用请求数量,按照所选择的时间粒度统计求和 count apiId, environmentName, serviceId [60s, expr]
[300s, expr]

三、各维度对应参数总览

参数名称 维度名称 维度解释 格式
Instances.N.Dimensions.0.Name serviceId API 网关服务 ID 的维度名称 输入 String 类型维度名称:serviceId
Instances.N.Dimensions.0.Value serviceId 具体的 API 网关服务 ID 输入具体服务 ID,例如:service-12345jy
Instances.N.Dimensions.1.Name environmentName 环境维度名称 输入 String 类型维度名称:environmentName
Instances.N.Dimensions.1.Value environmentName 具体环境名称 输入环境名称,例如:release、test、repub
Instances.N.Dimensions.2.Name apiId/key apiId 或者 secretKey 的维度名称 输入 String 类型维度名称:apiId/key
Instances.N.Dimensions.2.Value apiId/secretId 具体的 apiId 或者 secretId 输入具体的 apiId 或者 secretId

四、维度说明

API 网关提供了获取以下三种级别监控数据的组合 :环境维度、API 维度、密钥对(SecretId 和 SecretKey)维度。

以下为 API 网关的三种维度组合的查询方式 :

五、1. 环境维度,入参取值

&Namespace=QCE/APIGATEWAY
&Instances.N.Dimensions.0.Name=serviceId
&Instances.N.Dimensions.0.Value=serviceId 的值
&Instances.N.Dimensions.1.Name=environmentName
&Instances.N.Dimensions.1.Value=环境名

六、2. API 维度,入参取值

&Namespace=QCE/APIGATEWAY
&Instances.N.Dimensions.0.Name=serviceId
&Instances.N.Dimensions.0.Value=serviceId 的值
&Instances.N.Dimensions.1.Name=environmentName
&Instances.N.Dimensions.1.Value=环境名
&Instances.N.Dimensions.2.Name=apiId
&Instances.N.Dimensions.2.Value=API 的 ID

七、3. 密钥对维度,入参取值(需要开启白名单)

&Namespace=QCE/APIGATEWAY
&Instances.N.Dimensions.0.Name=serviceId
&Instances.N.Dimensions.0.Value=serviceId 的值
&Instances.N.Dimensions.1.Name=environmentName
&Instances.N.Dimensions.1.Value=环境名
&Instances.N.Dimensions.2.Name=key
&Instances.N.Dimensions.2.Value=密钥对的 secretid

赞 (0)
上一篇 4天前
下一篇 4天前