应用性能监控数据结构

APMKV

APM 浮点数类型键值对

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

名称	类型	必选	描述
Key	String	否	Key 值定义示例值：Name
Value	Float	否	Value 值定义示例值：0.0

APMKVItem

APM 通用 KV 结构

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

名称	类型	必选	描述
Key	String	是	Key 值定义示例值：Name
Value	String	是	Value 值定义示例值：CloudMonitor

ApmAgentInfo

APM Agent 信息

被如下接口引用：DescribeApmAgent。

名称	类型	描述
AgentDownloadURL	String	Agent 下载地址示例值：https://agent.tapm.tencentyun.com/DownloadAgent
CollectorURL	String	Collector 上报地址示例值：http://xxx.xxx.xx:8080
Token	String	Token 信息示例值：14dac76ca10f4610f727ca68528758b43980251387493706d18988fa7d0621b7
PublicCollectorURL	String	外网上报地址示例值：http://xxx.xxx.xx:8080
InnerCollectorURL	String	自研 VPC 上报地址示例值：http://xxx.xxx.xx:8080
PrivateLinkCollectorURL	String	内网上报地址( Private Link 上报地址) 示例值：http://xxx.xxx.xx:8080

ApmApplicationConfigView

应用相关的配置列表项

被如下接口引用：DescribeGeneralApmApplicationConfig。

名称	类型	必选	描述
InstanceKey	String	否	业务系统 ID 示例值：apm-059oXBfTL
ServiceName	String	否	应用名示例值：java-order-service
OperationNameFilter	String	否	接口过滤示例值：RPCServer/market.MarketService2/(.*?)
ExceptionFilter	String	否	错误类型过滤示例值：io.grpc.StatusRuntimeException,java.sql.(.*?)
ErrorCodeFilter	String	否	HTTP 状态码过滤示例值：400,500
EventEnable	Boolean	否	应用诊断开关（已废弃）示例值：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	否	日志源示例值：CLS
LogSet	String	否	日志集示例值：postgres
LogTopicID	String	否	日志主题示例值：032f3078-10b6-46a0-978f-1696e8e79696
SnapshotEnable	Boolean	否	方法栈快照开关 true 开启 false 关闭示例值：false
SnapshotTimeout	Integer	否	慢调用监听触发阈值示例值：2000
AgentEnable	Boolean	否	探针总开关示例值：true
InstrumentList	Array of Instrument	否	组件列表开关（已废弃）
TraceSquash	Boolean	否	链路压缩开关（已废弃）示例值：true
DisableMemoryUsed	Integer	否	探针熔断内存阈值示例值：90
DisableCpuUsed	Integer	否	探针熔断CPU阈值示例值：90

ApmField

指标维度信息

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

名称	类型	描述
Key	String	指标名示例值：qps
Value	Float	指标数值示例值：0.01
Unit	String	指标所对应的单位示例值：ms
CompareVals	Array of APMKVItem	同比结果数组，推荐使用注意：此字段可能返回 null，表示取不到有效值。
LastPeriodValue	Array of APMKV	同比上一个周期的具体指标数值注意：此字段可能返回 null，表示取不到有效值。
CompareVal	String	同比指标值，已弃用，不建议使用示例值：0
NameCN	String	指标中文名示例值：吞吐量
NameEN	String	指标英文名示例值：QPS

ApmInstanceDetail

APM 业务系统信息

被如下接口引用：DescribeApmInstances。

名称	类型	描述
InstanceId	String	业务系统 ID 示例值：apm-52Dpv13GR
Name	String	业务系统名示例值：测试 Demo
Description	String	业务系统描述信息示例值：业务系统描述
Status	Integer	业务系统状态。{ 1: 初始化中; 2: 运行中; 4: 限流} 示例值：1
Region	String	业务系统所属地域示例值：ap-guangzhou
Tags	Array of ApmTag	业务系统 Tag 列表
AppId	Integer	AppID 信息示例值：12653698
CreateUin	String	创建人 Uin 示例值：12543625
AmountOfUsedStorage	Float	存储使用量(单位：MB) 示例值：100
ServiceCount	Integer	该业务系统服务端应用数量示例值：2
CountOfReportSpanPerDay	Integer	日均上报 Span 数示例值：100
TraceDuration	Integer	Trace 数据保存时长（单位：天）示例值：7
SpanDailyCounters	Integer	业务系统上报额度示例值：500000
BillingInstance	Integer	业务系统是否已开通计费（0=未开通，1=已开通）示例值：1
ErrRateThreshold	Integer	错误警示线（单位：%）示例值：30
SampleRate	Integer	采样率（单位：%）示例值：1
ErrorSample	Integer	是否开启错误采样（0=关, 1=开）示例值：0
SlowRequestSavedThreshold	Integer	采样慢调用保存阈值（单位：ms）示例值：500
LogRegion	String	CLS 日志所在地域示例值：ap-guangzhou
LogSource	String	日志源示例值：CLS
IsRelatedLog	Integer	日志功能开关（0=关， 1=开）示例值：0
LogTopicID	String	日志主题 ID 示例值：cls-acv12b
ClientCount	Integer	该业务系统客户端应用数量示例值：3
TotalCount	Integer	该业务系统最近2天活跃应用数量示例值：5
LogSet	String	CLS 日志集示例值：cls-v1241nb
MetricDuration	Integer	Metric 数据保存时长（单位：天）示例值：30
CustomShowTags	Array of String	用户自定义展示标签列表示例值：["custom_key_1"]
PayMode	Integer	业务系统计费模式（1为预付费，0为按量付费）示例值：1
PayModeEffective	Boolean	业务系统计费模式是否生效示例值：true
ResponseDurationWarningThreshold	Integer	响应时间警示线（单位：ms）示例值：500
Free	Integer	是否免费（0=否，1=限额免费，2=完全免费），默认0 示例值：0
DefaultTSF	Integer	是否 TSF 默认业务系统（0=否，1=是）示例值：0
IsRelatedDashboard	Integer	是否关联 Dashboard（0=关, 1=开）示例值：0
DashboardTopicID	String	关联的 Dashboard ID 示例值：dashboard-vcav134
IsInstrumentationVulnerabilityScan	Integer	是否开启组件漏洞检测（0=关， 1=开）示例值：0
IsSqlInjectionAnalysis	Integer	是否开启 SQL 注入分析（0=关， 1=开）示例值：0
StopReason	Integer	限流原因。{ 1: 正式版限额; 2: 试用版限额; 4: 试用版到期; 8: 账号欠费 } 示例值：1
IsRemoteCommandExecutionAnalysis	Integer	是否开远程命令执行检测（0=关， 1=开）示例值：0
IsMemoryHijackingAnalysis	Integer	是否开内存马执行检测（0=关， 1=开）示例值：0
LogIndexType	Integer	CLS索引类型(0=全文索引，1=键值索引) 示例值：0
LogTraceIdKey	String	traceId的索引key: 当CLS索引类型为键值索引时生效示例值：trace_id
IsDeleteAnyFileAnalysis	Integer	是否开启删除任意文件检测（0-关闭，1-开启）示例值：0
IsReadAnyFileAnalysis	Integer	是否开启读取任意文件检测（0-关闭，1-开启）示例值：0
IsUploadAnyFileAnalysis	Integer	是否开启上传任意文件检测（0-关闭，1-开启）示例值：0
IsIncludeAnyFileAnalysis	Integer	是否开启包含任意文件检测（0-关闭，1-开启）示例值：0
IsDirectoryTraversalAnalysis	Integer	是否开启目录遍历检测（0-关闭，1-开启）示例值：0
IsTemplateEngineInjectionAnalysis	Integer	是否开启模板引擎注入检测（0-关闭，1-开启）示例值：0
IsScriptEngineInjectionAnalysis	Integer	是否开启脚本引擎注入检测（0-关闭，1-开启）示例值：0
IsExpressionInjectionAnalysis	Integer	是否开启表达式注入检测（0-关闭，1-开启）示例值：0
IsJNDIInjectionAnalysis	Integer	是否开启JNDI注入检测（0-关闭，1-开启）示例值：0
IsJNIInjectionAnalysis	Integer	是否开启JNI注入检测（0-关闭，1-开启）示例值：0
IsWebshellBackdoorAnalysis	Integer	是否开启Webshell后门检测（0-关闭，1-开启）示例值：0
IsDeserializationAnalysis	Integer	是否开启反序列化检测（0-关闭，1-开启）示例值：0
Token	String	业务系统鉴权 token 示例值：oXauxrxnxuz
UrlLongSegmentThreshold	Integer	URL长分段收敛阈值示例值：40
UrlNumberSegmentThreshold	Integer	URL数字分段收敛阈值示例值：5

ApmMetricRecord

指标列表单元

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

名称	类型	描述
Fields	Array of ApmField	field数组，用于指标的查询结果
Tags	Array of ApmTag	tag数组，用于区分 Groupby 的对象

ApmServiceMetric

apm应用指标信息

被如下接口引用：DescribeApmServiceMetric。

名称	类型	描述
Fields	Array of ApmField	filed数组注意：此字段可能返回 null，表示取不到有效值。示例值：[]
Tags	Array of ApmTag	tag数组注意：此字段可能返回 null，表示取不到有效值。示例值：[]
ServiceDetail	ServiceDetail	应用信息注意：此字段可能返回 null，表示取不到有效值。示例值：{}

ApmTag

维度（标签）对象

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

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

Filter

查询过滤参数

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

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

GeneralFilter

查询过滤参数

被如下接口引用：DescribeGeneralMetricData。

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

Instrument

组件

被如下接口引用：DescribeGeneralApmApplicationConfig。

名称	类型	必选	描述
Name	String	否	组件名称示例值：Redis
Enable	Boolean	否	组件开关示例值：true

Line

指标曲线数据

被如下接口引用：DescribeGeneralMetricData。

名称	类型	描述
MetricName	String	指标名示例值：qps
MetricNameCN	String	指标中文名示例值：吞吐量
TimeSerial	Array of Integer	时间序列示例值：[1617124595, 1617124596, 1617124597]
DataSerial	Array of Float	数据序列示例值：[1.0, 2.0, 3.0]
Tags	Array of ApmTag	维度列表
MetricUnit	String	指标数据单位示例值：个/秒

OrderBy

排序字段

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

名称	类型	必选	描述
Key	String	是	需要排序的字段，现支持 startTIme, endTime, duration 示例值：startTime
Value	String	是	asc 顺序排序 / desc 倒序排序示例值：asc

QueryMetricItem

查询

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

名称	类型	必选	描述
MetricName	String	是	指标名示例值：request_count
Compares	Array of String	否	同比，现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比) 示例值：CompareByYesterday
Compare	String	否	同比，已弃用，不建议使用示例值：CompareByYesterday

ServiceDetail

应用详细信息

被如下接口引用：DescribeApmServiceMetric。

名称	类型	必选	描述
ServiceID	String	否	应用ID 注意：此字段可能返回 null，表示取不到有效值。示例值：svc-test
InstanceKey	String	否	业务系统ID 注意：此字段可能返回 null，表示取不到有效值。示例值：apm-test
AppID	Integer	否	用户appid 注意：此字段可能返回 null，表示取不到有效值。示例值：123
CreateUIN	String	否	主账号uin 注意：此字段可能返回 null，表示取不到有效值。示例值：12
ServiceName	String	否	应用名注意：此字段可能返回 null，表示取不到有效值。示例值：demo
ServiceDescription	String	否	应用描述注意：此字段可能返回 null，表示取不到有效值。示例值：describe
Region	String	否	地域注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou
Tags	Array of ApmTag	否	标签注意：此字段可能返回 null，表示取不到有效值。
InstanceName	String	否	业务系统名称示例值：travy-test