GetTraceAppConfig_应用实时监控服务ARMS_API文档

在返回的自定义配置中，各个 JSONPath 与对应的开关如下所示。 （注：由于修改时机不同，返回的自定义配置中可能不存在某项配置，此时默认值将生效）

采样设置说明

配置说明	JSONPath	Type	备注	默认值
采样策略	profiler.sampling.useSamplingStrategyV2	boolean	取值： - true：自适应采样。 - false：固定采样率。	false
采样率百分比	profiler.sampling.rate	double	0~100 之间。 固定采样率模式下生效。	10
全采样接口名	profiler.sampling.v2config.spanNames4FullSampleStr	String	全采样接口名，多个由英文逗号分隔。	空字符串
全采样接口前缀	profiler.sampling.v2config.spanNamePrefixes4FullSampleStr	String	全采样接口前缀。	空字符串
全采样接口后缀	profiler.sampling.v2config.spanNameSuffixes4FullSampleStr	String	全采样接口后缀。	空字符串

探针开关设置说明

配置说明	JSONPath	Type	备注	默认值
应用监控启停	profiler.enable	boolean	取值： - true：开启应用监控。 - false：关闭应用监控。	true
dubbo 插件开关	profiler.dubbo.enable	boolean	取值： - true：开启 dubbo 插件。 - false：关闭 dubbo 插件。	true
mongodb 插件开关	profiler.mongodb.enable	boolean	取值： - true：开启 mongodb 插件。 - false：关闭 mongodb 插件。	true
hsf 插件开关	profiler.hsf.enable	boolean	取值： - true：开启 hsf 插件。 - false：关闭 hsf 插件。	true
httpclient3 插件开关	profiler.httpclient3.enable	boolean	取值： - true：开启 httpclient3 插件。 - false：关闭 httpclient3 插件。	true
httpclient4 插件开关	profiler.httpclient4.enable	boolean	取值： - true：开启 httpclient4 插件。 - false：关闭 httpclient4 插件。	true
jdkhttp 插件开关	profiler.jdkhttp.enable	boolean	取值： - true：开启 jdkhttp 插件。 - false：关闭 jdkhttp 插件。	true
jetty 插件开关	profiler.jetty.enable	boolean	取值： - true：开启 jetty 插件。 - false：关闭 jetty 插件。	true
mybatis 插件开关	profiler.mybatis.enable	boolean	取值： - true：开启 mybatis 插件。 - false：关闭 mybatis 插件。	true
mysql 插件开关	profiler.mysql.enable	boolean	取值： - true：开启 mysql 插件。 - false：关闭 mysql 插件。	true
okhttp 插件开关	profiler.okhttp.enable	boolean	取值： - true：开启 okhttp 插件。 - false：关闭 okhttp 插件。	true
oracle 插件开关	profiler.oracle.enable	boolean	取值： - true：开启 oracle 插件。 - false：关闭 oracle 插件。	true
postgresql 插件开关	profiler.postgresql.enable	boolean	取值： - true：开启 postgresql 插件。 - false：关闭 postgresql 插件。	true
redis 插件开关	profiler.redis.enable	boolean	取值： - true：开启 redis 插件。 - false：关闭 redis 插件。	true
spring 插件开关	profiler.spring.enable	boolean	取值： - true：开启 spring 插件。 - false：关闭 spring 插件。	true
springboot 插件开关	profiler.springboot.enable	boolean	取值： - true：开启 springboot 插件。 - false：关闭 springboot 插件。	true
tomcat 插件开关	profiler.tomcat.enable	boolean	取值： - true：开启 tomcat 插件。 - false：关闭 tomcat 插件。	true
lettuce 插件开关	profiler.lettuce.enable	boolean	取值： - true：开启 lettuce 插件。 - false：关闭 lettuce 插件。	true
grpc 插件开关	profiler.grpc.enable	boolean	取值： - true：开启 grpc 插件。 - false：关闭 grpc 插件。	true
thrift 插件开关	profiler.thrift.enable	boolean	取值： - true：开启 thrift 插件。 - false：关闭 thrift 插件。	true
hystrix 插件开关	profiler.hystrix.enable	boolean	取值： - true：开启 hystrix 插件。 - false：关闭 hystrix 插件。	true
rxjava 插件开关	profiler.rxjava.enable	boolean	取值： - true：开启 rxjava 插件。 - false：关闭 rxjava 插件。	true
memcached 插件开关	profiler.memcached.enable	boolean	取值： - true：开启 memcached 插件。 - false：关闭 memcached 插件。	true
druid 插件开关	profiler.jdbc.druid.enable	boolean	取值： - true：开启 druid 插件。 - false：关闭 druid 插件。	true
weblogic 插件开关	profiler.weblogic.enable	boolean	取值： - true：开启 weblogic 插件。 - false：关闭 weblogic 插件。	true
elasticjob 插件开关	profiler.elasticjob.enable	boolean	取值： - true：开启 elasticjob 插件。 - false：关闭 elasticjob 插件。	true
elasticsearch 插件开关	profiler.elasticsearch.enable	boolean	取值： - true：开启 elasticsearch 插件。 - false：关闭 elasticsearch 插件。	true
hikaricp 插件开关	profiler.jdbc.hikaricp.enable	boolean	取值： - true：开启 hikaricp 插件。 - false：关闭 hikaricp 插件。	true
influxdb 插件开关	profiler.influxdb.enable	boolean	取值： - true：开启 influxdb 插件。 - false：关闭 influxdb 插件。	true
kafka 插件开关	profiler.kafka.enable	boolean	取值： - true：开启 kafka 插件。 - false：关闭 kafka 插件。	true
netty 插件开关	profiler.netty.enable	boolean	取值： - true：开启 netty 插件。 - false：关闭 netty 插件。	true
play 插件开关	profiler.play.enable	boolean	取值： - true：开启 play 插件。 - false：关闭 play 插件。	true
reactor 插件开关	profiler.reactor.enable	boolean	取值： - true：开启 reactor 插件。 - false：关闭 reactor 插件。	true
redisson 插件开关	profiler.redis.redisson.enable	boolean	取值： - true：开启 redisson 插件。 - false：关闭 redisson 插件。	true
rabbitmq 插件开关	profiler.rabbitmq.client.enable	boolean	取值： - true：开启 rabbitmq 插件。 - false：关闭 rabbitmq 插件。	true
schedulerx 插件开关	profiler.schedulerx.enable	boolean	取值： - true：开启 schedulerx 插件。 - false：关闭 schedulerx 插件。	true
undertow 插件开关	profiler.undertow.enable	boolean	取值： - true：开启 undertow 插件。 - false：关闭 undertow 插件。	true
vertx 插件开关	profiler.vertx.enable	boolean	取值： - true：开启 vertx 插件。 - false：关闭 vertx 插件。	true
xxljob 插件开关	profiler.xxljob.enable	boolean	取值： - true：开启 xxljob 插件。 - false：关闭 xxljob 插件。	true
onsclient 插件开关	profiler.onsclient.enable	boolean	取值： - true：开启 onsclient 插件。 - false：关闭 onsclient 插件。	true
quartz 插件开关	profiler.quartz.enable	boolean	取值： - true：开启 quartz 插件。 - false：关闭 quartz 插件。	true
servlet 插件开关	profiler.servlet.enable	boolean	取值： - true：开启 servlet 插件。 - false：关闭 servlet 插件。	true
liberty 插件开关	profiler.liberty.enable	boolean	取值： - true：开启 liberty 插件。 - false：关闭 liberty 插件。	true
akka 插件开关	profiler.akka.enable	boolean	取值： - true：开启 akka 插件。 - false：关闭 akka 插件。	true
cassandra 插件开关	profiler.cassandra.enable	boolean	取值： - true：开启 cassandra 插件。 - false：关闭 cassandra 插件。	true
opentelemetry 插件开关	profiler.opentelemetry.enable	boolean	取值： - true：开启 opentelemetry 插件。 - false：关闭 opentelemetry 插件。	true
googlehttpclient 插件开关	profiler.googlehttpclient.enable	boolean	取值： - true：开启 googlehttpclient 插件。 - false：关闭 googlehttpclient 插件。	true
ning 插件开关	profiler.ning.asynchttpclient.enable	boolean	取值： - true：开启 ning 插件。 - false：关闭 ning 插件。	true

线程分析设置说明

配置说明	JSONPath	Type	备注	默认值
线程分析总控开关	profiler.tprof.enableJvmThreadStatistic	boolean	取值： - true：开启线程分析。 - false：关闭线程分析。	true
定期保存本地方法栈信息	profiler.tprof.enableThreadStackRecorder	boolean	取值： - true：开启定期保存本地方法栈。 - false：关闭定期保存本地方法栈。	false
高耗时调用阈值	profiler.tprof. threadProfilerSlowInteractionRt	int	单位 ms，高于该阈值的调用会自动保存本地方法栈。	2000

应用日志关联配置说明

配置说明	JSONPath	Type	备注	默认值
日志源	profiler.logSource	String	取值： - sls：日志服务 SLS。	sls
自动关联业务日志与 TraceId	profiler.logging.enable	boolean	取值： - true：开启关联功能。 - false：关闭关联功能。	true
日志自动填充 TraceId	profiler.logging.injectTraceId2Log.enable	boolean	取值： - true：开启自动填充功能。 - false：关闭自动填充功能。 探针版本大于等于 4.1.6生效。	true
日志自动填充 SpanId	profiler.logging.injectSpanId2Log.enable	boolean	取值： - true：开启自动填充功能。 - false：关闭自动填充功能。 探针版本大于等于 4.1.6生效。	true
日志服务绑定-区域	profiler.SLS.regionId	String	关联日志源所在的地域。	空字符串
日志服务绑定-Project	profiler.SLS.project	String	关联日志源所属 Project。	空字符串
日志服务绑定-Logstore	profiler.SLS.logStore	String	关联日志源 Logstore。	空字符串
日志服务绑定-关联索引	profiler.SLS.index	String	关联日志源索引。	空字符串

URL 收敛配置说明

配置说明	JSONPath	Type	备注	默认值
收敛 URL	profiler.convergence.enable	boolean	取值： - true：开启收敛 URL 功能。 - false：关闭收敛 URL 功能。	true
收敛阈值	profiler.convergence.minServerSize	long	大于此阈值进行收敛。	1000
收敛规则	profiler.convergence.pattern	String	每条规则是一个正则表达式。 例：/service/(.*?)/demo。 多个规则之间以英文逗号分隔。	空字符串

Arthas 配置说明

配置说明	JSONPath	Type	备注	默认值
Arthas 开关	profiler.arthas.enable	boolean	取值： - true：开启 Arthas 功能。 - false：关闭 Arthas 功能。	false
生效实时 IP	profiler.arthas.enableIps	string	开启 Arthas 功能的生效 IP，多个 IP 用英文逗号分隔。 空字符串表示对所有 IP 生效。	空字符串

持续剖析配置说明

配置说明	JSONPath	Type	备注	默认值
总开关	profiler.cp.enable	boolean	取值： - true：开启持续剖析功能。 - false：关闭持续剖析功能。 *该开关开启后，有两种配置模式，见下表。	false
CPU 热点	profiler.cp.cpuEnable	boolean	取值： - true：开启 CPU 热点功能。 - false：关闭 CPU 热点功能。	false
内存热点	profiler.cp.allocEnable	boolean	取值： - true：开启内存热点功能。 - false：关闭内存热点功能。	false
代码热点	profiler.cp.wallClockEnable	boolean	取值： - true：开启代码热点功能。 - false：关闭代码热点功能。	false

模式	Key	字段说明	Value
IP 白名单	cp.allowIPs	IP 白名单	指定开启持续剖析的实例 IP，多个 IP 请使用英文逗号（,）分割。 示例：192.168.0.1,192.168.0.2
	cp.allowNetwork	网段地址	请传递空字符串，否则将无法正常使用。
网段地址	cp.allowIPs	IP 白名单	请传递空字符串，否则将无法正常使用。
	cp.allowNetwork	网段地址	命中此网段地址范围的 IP 实例打开该功能。 示例：192.168.2.0/24

信息脱敏配置说明

配置说明	JSONPath	Type	备注	默认值
脱敏开关	profiler.sanitizer.enable	boolean	取值： - true：开启脱敏功能。 - false：关闭脱敏功能。	true
脱敏规则	profiler.sanitizer.keys	String	对敏感 key 包含词的匹配规则，不区分大小写，多个 IP 用英文逗号分隔。	true

接口调用配置说明

配置说明	JSONPath	Type	备注	默认值
慢调用阈值	profiler.thresholds.interface	long	单位 ms，高于该阈值的响应时间会被标记为慢调用。	500
异常白名单	profiler.exception.whitelist	String	指定异常名正则表达式，白名单命中的异常不参与异常相关图表的统计，多个规则用英文逗号分隔。	空字符串
异常过滤父类继承	profiler.exception.filterByParentClass	boolean	取值： - true：开启该功能。 - false：关闭该功能。 打开后，异常过滤中可配置父类异常。 探针版本大于等于 4.1.6生效。	true
HTTP 状态码白名单	profiler.error.skip	String	指定忽略错误的 HTTP 状态码，白名单设置中的状态码将在错误统计中被忽略，多个状态码用英文逗号分隔。	空字符串
无效接口调用过滤	profiler.defined.excludeurl	String	指定忽略的接口调用，每条规则是一个正则表达式，多个状态码用英文逗号分隔。	/**/*.jpg,/**/*.png,/**/*.js, /**/*.jpeg,/**/*.pdf,/**/*.xlsx, /**/*.txt,/**/*.docs,/**/*.gif, /**/*.csv

数据库调用配置说明

配置说明	JSONPath	Type	备注	默认值
慢 SQL 阈值	profiler.thresholds.sql	long	单位 ms，高于该阈值的 SQL 调用会被标记为慢调用。	500
采集 SQL 最大保留长度	profiler.callsql.maxLength	long	当 SQL 语句大于该阈值的时候，会被截断。	1024
展示 SQL 中的变量绑定值	profiler.jdbc.tracesqlbindvalue	boolean	取值： - true：开启该功能。 - false：关闭该功能。 开启后会捕获 PrepareStatement 参数绑定的变量值，并在页面展示。仅支持 MySQL。	false
展示 SQL 中的常量值	profiler.jdbc. tracesqlraw	boolean	取值： - true：开启该功能。 - false：关闭该功能。 开启后捕获原始 SQL 语句。	false

调用链透传协议配置说明

注：调用链透传协议配置仅在探针版本大于等于 4.1.x 时生效。

配置说明	JSONPath	Type	备注	默认值
透传协议	profiler.trace.protocol.name	String	取值： - Unset：未设置。 - W3C ：OpenTelemetry - W3C。 - SkyWalking ：SkyWalking。 - Zipkin ：Zipkin - B3。 - Jaeger ：Jaeger。 - EagleEye ：EagleEye。	Unset
透传模式	profiler.trace.protocol. strategy	String	取值： - PriorityUse ：优先。 - ForceUse ：强制。	PriorityUse

高级配置说明

配置说明	JSONPath	Type	备注	默认值
探针每秒最大链路采集量	profiler.thresholds.limit	int	保护性手段，防止大流量场景下因为链路采集影响业务正常运行。	100
方法堆栈最大保留长度	profiler.callstack.maxLength	int	超出长度的方法栈将会在采集的时候被截断。 探针版本大于等于 4.0.0已弃用该配置。	128
同类异常堆栈区分深度	profiler.exception.stacktrace	int	基于此堆栈深度识别同类型的异常。	2
请求入参最大展示长度	profiler.param.maxLength	int	请求入参最大展示的长度。	512
自定义 RabbitMQ 消费者	profiler.rabbitmq.client.consumer.classes	String	指定 RabbitMQ 消费者的全类名，多个消费者用英文逗号分隔。 探针版本大于等于 4.0.0已弃用该配置。	空字符串
自定义 Kafka 消费方法	profiler.kafka.consumer.entryPoint	String	指定 kafka 消费者的消费。 探针版本大于等于 4.0.0已弃用该配置。	空字符串
kafka 发送消息自动透传上下文	profiler.kafka.enableInjectKafkaHeaders	boolean	发送时是否自动往 kafka 消息中添加若干个 Header 用以将发送链路以及消费链路关联。 探针版本大于等于 4.0.0已弃用该配置。	false
异步透传扫描包名	profiler.thread.match.package	String	当对应包名下的 Runnable/Callable/Supplier 在创建时，会自动捕获 Trace 上下文并传递到新线程。多个包名可采用英文逗号（,）分隔。 探针版本大于等于 4.0.0已弃用该配置。	空字符串
HTTP 返回结果中包含 TraceId	profiler.responseInject.enable	boolean	取值： - true：开启返回 TraceId 的开关。 - false：关闭返回 TraceId 的开关。	false