应用性能监控
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 应用性能监控 > API 文档 > 数据结构

数据结构

最近更新时间：2024-04-25 01:09:14

我的收藏

本页目录：

APMKV

APM浮点数类型键值对

被如下接口引用：DescribeMetricRecords, DescribeServiceOverview。

名称 类型 描述
Key String Key值定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：name
Value Float Value值定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.0

APMKVItem

Apm通用KV结构

被如下接口引用：DescribeMetricRecords, DescribeServiceOverview。

名称 类型 描述
Key String Key值定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：name
Value String Value值定义
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxxx

ApmAgentInfo

apm Agent信息

被如下接口引用：DescribeApmAgent。

名称 类型 描述
AgentDownloadURL String Agent下载地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：https://agent.tapm.tencentyun.com/DownloadAgent
CollectorURL String Collector上报地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：http://xxx.xxx.xx:8080
Token String Token信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：14dac76ca10f4610f727ca68528758b43980251387493706d18988fa7d0621b7
PublicCollectorURL String 外网上报地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：http://xxx.xxx.xx:8080
InnerCollectorURL String 自研VPC上报地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：http://xxx.xxx.xx:8080
PrivateLinkCollectorURL String 内网上报地址(Private Link上报地址)
注意：此字段可能返回 null，表示取不到有效值。
示例值：http://xxx.xxx.xx:8080

ApmApplicationConfigView

应用相关的配置列表项

被如下接口引用：DescribeGeneralApmApplicationConfig。

名称 类型 必选 描述
InstanceKey String 否 实例ID
示例值：1o8yMC47u
ServiceName String 否 服务名
示例值：java-order-service
OperationNameFilter String 否 接口过滤
示例值：RPCServer/market.MarketService2/(.*?)
ExceptionFilter String 否 异常过滤
示例值：io.grpc.StatusRuntimeException,java.sql.(.*?)
ErrorCodeFilter String 否 错误码过滤
示例值：400,500
EventEnable Boolean 否 应用诊断开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
UrlConvergenceSwitch Integer 否 URL收敛开关 0 关 1 开
示例值：1
UrlConvergenceThreshold Integer 否 URL收敛阈值
示例值：50
UrlConvergence String 否 URL收敛规则正则
示例值：market.StockService.getStock(.*?),market.StockService.getPreDayS
UrlExclude String 否 URL排除规则正则
示例值：market.StockService.getStock(.*?),market.StockService.getPreDayS
IsRelatedLog Integer 否 是否开启日志 0 关 1 开
示例值：1
LogSource String 否 日志来源
注意：此字段可能返回 null，表示取不到有效值。
示例值：CLS
LogSet String 否 CLS日志集
示例值：postgres
LogTopicID String 否 日志主题ID
示例值：032f3078-10b6-46a0-978f-1696e8e79696
SnapshotEnable Boolean 否 线程剖析开关
示例值：false
SnapshotTimeout Integer 否 线程剖析超时阈值
示例值：2000
AgentEnable Boolean 否 探针开启开关
示例值：true
InstrumentList Array of Instrument 否 组件列表开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"Name":"dubbo","Enable":true},{"Name":"googlehttpclient","Enable":true},{"Name":"grpc","Enable":true},{"Name":"httpclient3","Enable":true},{"Name":"httpclient4","Enable":true},{"Name":"hystrix","Enable":true},{"Name":"lettuce","Enable":true},{"Name":"mongodb","Enable":true},{"Name":"mybatis","Enable":true},{"Name":"mysql","Enable":true},{"Name":"okhttp","Enable":true},{"Name":"redis","Enable":true},{"Name":"rxjava","Enable":true},{"Name":"spring-webmvc","Enable":true},{"Name":"tomcat","Enable":true}]
TraceSquash Boolean 否 链路压缩开关
示例值：true

ApmField

指标维度信息

被如下接口引用：DescribeMetricRecords, DescribeServiceOverview。

名称 类型 描述
CompareVal String 昨日同比指标值，已弃用，不建议使用
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
CompareVals Array of APMKVItem Compare值结果数组，推荐使用
注意：此字段可能返回 null，表示取不到有效值。
Value Float 指标值
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.0
Unit String 指标所对应的单位
注意：此字段可能返回 null，表示取不到有效值。
示例值：ms
Key String 请求数
示例值：req_count
LastPeriodValue Array of APMKV 同环比上周期具体数值
注意：此字段可能返回 null，表示取不到有效值。

ApmInstanceDetail

apm实例信息

被如下接口引用：DescribeApmInstances。

名称 类型 描述
AmountOfUsedStorage Float 存储使用量(MB)
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
Name String 实例名
注意：此字段可能返回 null，表示取不到有效值。
示例值：测试Demo
Tags Array of ApmTag 实例所属tag列表
注意：此字段可能返回 null，表示取不到有效值。
InstanceId String 实例ID
示例值：52Dpv13GR
CreateUin String 创建人Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：12543625
ServiceCount Integer 该实例已上报的服务端应用数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：2
CountOfReportSpanPerDay Integer 日均上报Span数
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
AppId Integer AppId信息
示例值：12653698
TraceDuration Integer Trace数据保存时长
注意：此字段可能返回 null，表示取不到有效值。
示例值：604800
Description String 实例描述信息
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 实例状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Region String 实例所属地域
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou
SpanDailyCounters Integer 实例上报额度
注意：此字段可能返回 null，表示取不到有效值。
示例值：500000
BillingInstance Integer 实例是否开通计费
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ErrRateThreshold Integer 错误率阈值
注意：此字段可能返回 null，表示取不到有效值。
示例值：30
SampleRate Integer 采样率阈值
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ErrorSample Integer 是否开启错误采样 0 关 1 开
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
SlowRequestSavedThreshold Integer 慢调用保存阈值
注意：此字段可能返回 null，表示取不到有效值。
示例值：500
LogRegion String cls日志所在地域
注意：此字段可能返回 null，表示取不到有效值。
示例值：ap-guangzhou
LogSource String 日志来源
注意：此字段可能返回 null，表示取不到有效值。
示例值：CLS
IsRelatedLog Integer 日志功能开关 0 关 | 1 开
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
LogTopicID String 日志主题ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxxxxx
ClientCount Integer 该实例已上报的客户端应用数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：3
TotalCount Integer 该实例已上报的总应用数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：5
LogSet String CLS日志集 | ES集群ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
MetricDuration Integer Metric数据保存时长
注意：此字段可能返回 null，表示取不到有效值。
示例值：30
CustomShowTags Array of String 用户自定义展示标签列表
注意：此字段可能返回 null，表示取不到有效值。
PayMode Integer 实例计费模式
1为预付费
0为按量付费
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
PayModeEffective Boolean 实例计费模式是否生效
注意：此字段可能返回 null，表示取不到有效值。
示例值：true

ApmMetricRecord

指标列表单元

被如下接口引用：DescribeMetricRecords, DescribeServiceOverview。

名称 类型 描述
Fields Array of ApmField field数组
Tags Array of ApmTag tag数组

ApmTag

维度（标签）对象

被如下接口引用：CreateApmInstance, DescribeApmInstances, DescribeGeneralMetricData, DescribeMetricRecords, DescribeServiceOverview, ModifyApmInstance, ModifyGeneralApmApplicationConfig。

名称 类型 必选 描述
Key String 是 维度Key(列名，标签Key)
示例值：region
Value String 是 维度值（标签值）
示例值：ap-guangzhou

Filter

查询过滤参数

被如下接口引用：DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview, DescribeTagValues。

名称 类型 必选 描述
Type String 是 过滤方式（=, !=, in）
示例值：=
Key String 是 过滤维度名
示例值：serviceName
Value String 是 过滤值，in过滤方式用逗号分割多个值
示例值：sso-api

GeneralFilter

查询过滤参数

被如下接口引用：DescribeGeneralMetricData。

名称 类型 必选 描述
Key String 是 过滤维度名
示例值：serviceName
Value String 是 过滤值
示例值：sso-api

Instrument

组件

被如下接口引用：DescribeGeneralApmApplicationConfig。

名称 类型 必选 描述
Name String 否 组件名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：Redis
Enable Boolean 否 组件开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：true

Line

指标曲线数据

被如下接口引用：DescribeGeneralMetricData。

名称 类型 描述
MetricName String 指标名
示例值：qps
MetricNameCN String 指标中文名
示例值：吞吐量
TimeSerial Array of Integer 时间序列
示例值：[1617124595, 1617124596, 1617124597]
DataSerial Array of Float 数据序列
注意：此字段可能返回 null，表示取不到有效值。
示例值：[1.0, 2.0, 3.0]
Tags Array of ApmTag 维度列表
注意：此字段可能返回 null，表示取不到有效值。

OrderBy

sql排序字段

被如下接口引用：DescribeGeneralMetricData, DescribeGeneralSpanList, DescribeMetricRecords, DescribeServiceOverview。

名称 类型 必选 描述
Key String 是 需要排序的字段
示例值：traceID
Value String 是 顺序排序/倒序排序
示例值：asc

QueryMetricItem

查询

被如下接口引用：DescribeMetricRecords, DescribeServiceOverview。

名称 类型 必选 描述
MetricName String 是 指标名
示例值：request_count
Compare String 否 同比，已弃用，不建议使用
示例值：YearOnYear
Compares Array of String 否 同比，支持多种同比方式

Span

Span对象

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
TraceID String 否 Trace Id
注意：此字段可能返回 null，表示取不到有效值。
示例值：7a23429a8f7d6685
Logs Array of SpanLog 否 日志
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
Tags Array of SpanTag 否 标签
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
Process SpanProcess 否 上报应用服务信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：{}
Timestamp Integer 否 产生时间戳(毫秒)
注意：此字段可能返回 null，表示取不到有效值。
示例值：1621843224175
OperationName String 否 Span名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：span_foo3
References Array of SpanReference 否 关联关系
注意：此字段可能返回 null，表示取不到有效值。
示例值：[]
StartTime Integer 否 产生时间戳(微秒)
注意：此字段可能返回 null，表示取不到有效值。
示例值：1621843224175963
Duration Integer 否 持续耗时(微妙)
注意：此字段可能返回 null，表示取不到有效值。
示例值：500098
SpanID String 否 Span Id
注意：此字段可能返回 null，表示取不到有效值。
示例值：7a23429a8f7d6685
StartTimeMillis Integer 否 产生时间戳(毫秒)
注意：此字段可能返回 null，表示取不到有效值。
示例值：1621843224175
ParentSpanID String 否 Parent Span Id
注意：此字段可能返回 null，表示取不到有效值。
示例值：7a23429a8f7d6685

SpanLog

Span日志部分

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
Timestamp Integer 是 日志时间戳
示例值：1621843224175
Fields Array of SpanTag 是 标签
示例值：tags[]

SpanProcess

服务相关信息

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
ServiceName String 是 应用服务名称
示例值：broker-gz-test
Tags Array of SpanTag 是 Tags 标签数组
示例值：tags[]

SpanReference

Span上下游关联关系

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
RefType String 是 关联关系类型
示例值：CHILD_OF
SpanID String 是 Span ID
示例值：7a23429a8f7d6685
TraceID String 是 Trace ID
示例值：7a23429a8f7d6685

SpanTag

标签

被如下接口引用：DescribeGeneralSpanList。

名称 类型 必选 描述
Type String 是 标签类型
示例值：string
Key String 是 标签Key
注意：此字段可能返回 null，表示取不到有效值。
示例值：status.code"
Value String 是 标签值
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
中国站