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

调用链路采样字段说明

Key	字段说明	Value
sampling.enable	采样开关	取值： - true：开启采样开关。 - false：关闭采样开关。
sampling.rate	采样率	0~100 之间，默认为 10。

总开关字段说明

Key	字段说明	Value
enable	Agent 总开关	取值： - true：开启 Agent 总开关。 - false：关闭 Agent 总开关。

阈值字段说明

Key	字段说明	Value
thresholds.limit	限流阈值	默认为 100。
thresholds.interface	接口响应时间阈值	默认为 500，单位为 ms。
thresholds.sql	慢 SQL 查询阈值	默认为 500，单位为 ms。

高级字段说明

Key	字段说明	Value
defined.excludeurl	无效接口调用过滤	支持以英文逗号（,）分隔多个接口调用。 默认值为：/**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg。 示例：/service/taobao,/service/status。
callstack.maxLength	方法堆栈最大长度	默认为 128，支持最大长度 400 条。
exception.stacktrace	同类异常堆栈区分深度	默认为 2，基于此堆栈深度识别同类型的异常。修改此配置会造成非预期的统计行为，请谨慎操作。
callsql.maxLength	采集 SQL 最大长度	默认为 1024 个字符，最小长度为 256 个字符，最大长度为 4096 个字符。
jdbc.tracesqlbindvalue	采集 SQL 绑定值	取值： - true：开启捕获 PrepareStatement 参数绑定变量值开关。 - false：关闭捕获 PrepareStatement 参数绑定变量值开关。
jdbc.tracesqlraw	原始 SQL	取值： - true：开启捕获原始 SQL 语句开关。 - false：关闭捕获原始 SQL 语句开关。
exception.whitelist	异常过滤	使用正则表达式匹配异常类全名，多个异常请使用英文逗号（,）分隔。例如：java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException。此处输入的异常不会显示在应用详情和异常分析页面的图表中。
error.skip	错误数过滤	默认情况下，大于 400 的状态码会计入错误数，您可以设置需要忽略的状态码，多个错误码使用英文逗号（,）分隔，例如：429 或 429,512。Agent 2.5.7.2 以上版本支持。
compress.enable	调用链压缩	取值： - true：开启调用链开关。 - false：关闭调用链压缩开关。
param.maxLength	请求入参最大长度	默认为 512。高于默认值会消耗额外的系统资源，请谨慎操作。
quantile.enable	分位数统计	取值： - true：开启分位数统计开关。 - false：关闭分位数统计开关。
threadpoolmonitor.enable	线程池、连接池监控	需要应用重启生效。 取值： - true：开启线程池、连接池监控开关。 - false：关闭线程池、连接池监控开关。
async.autoTransmit	自动透传异步	仅在探针版本大于等于 2.8.3 时生效。 需要应用重启生效。该功能会对提交到线程池中的 Runnable、Callable 任务进行封装以传递上下文。存在一定风险，请谨慎操作。 取值： - true：开启自动透传异步开关。 - false：关闭自动透传异步开关。
thread.match.package	异步透传扫描包名	仅在探针版本大于等于 2.7.1.3 时生效。 需要应用重启生效。当对应包名下的 Runnable/Callable/Supplier 在创建时，会自动捕获 Trace 上下文并传递到新线程。多个包名可采用英文逗号（,）分隔。
responseInject.enable	请求中返回 TraceId 的开关	取值： - true：开启返回 TraceId 的开关。 - false：关闭返回 TraceId 的开关。

线程字段说明

Key	字段说明	Value
tprof.enableThreadProfiler	线程分析总控开关	取值： - true：开启线程分析总控开关。 - false：关闭线程分析总控开关。 开启后自动保存慢调用本地方法栈。
tprof.threadProfilerSlowInteractionRt	慢调用监听触发阈值	默认为 2000。耗时高于该阈值才启动线程分析，建议设为耗时的 99 分位线。低于 2000ms 会增加 CPU 消耗，不可小于 500ms。
tprof.enableThreadStackRecorder	线程分析方法栈	取值： - true：开启线程分析方法栈。 - false：关闭线程分析方法栈。 开启后每隔 5 分钟采集一次方法栈。

应用日志关联字段说明

Key	字段说明	Value
logging.enable	关联业务日志与 TraceId 开关	取值： - true：开启关联业务日志与 TraceId 开关。 - false：关闭关联业务日志与 TraceId 开关。 开启后业务日志中会自动生成调用链的 TraceId，此设置在重启应用后生效。支持 Log4j/Log4j2/Logback 日志组件。业务应用需要在日志的 Layout 中通过声明%X{EagleEye-TraceID}来输出 TraceId 信息。
SLS.project	当前区域业务日志的 project	当前区域业务日志的 project。
SLS.logStore	当前区域业务日志的 logstore	当前区域业务日志的 logstore。
SLS.index	当前区域业务日志的关联索引	取值： - 当指定全文索引时，不传。 - 指定字段索引时，取值为相应的字段名。例如：SLS.index: tag。 字段索引及全文索引的区别，请参见配置索引。

URL 收敛字段说明

Key	字段说明	Value
convergence.enable	收敛 URL	取值： - true：开启收敛 URL。 - false：关闭收敛 URL。
convergence.minServerSize	收敛阈值	大于此阈值即进行收敛。
convergence.pattern	收敛规则正则	可使用正则表达式设置收敛规则，多个正则表达式之间以英文逗号（,）分隔，直接填写 URL 原文表示不收敛此 URL，例如：/service/(.*?)/demo。

Arthas 诊断字段说明

注：Arthas 诊断相关配置仅在探针版本大于等于 2.7.1.3 时生效，其他前提条件请参见 Arthas 诊断。

Key	字段说明	Value
arthas.enable	Arthas 开关	取值： - true：开启 Arthas 开关。 - false：关闭 Arthas 开关。
arthas.enableIps	生效实时 IP	配置启用 Arthas 诊断的 IP，如果填写，Arthas 诊断仅对特定 IP 有效，不填写则默认对所有 IP 生效。多个 IP 请使用英文逗号（,）分割。

持续剖析字段说明

注：持续剖析相关配置仅在探针版本大于等于 2.7.3.5 时生效，其他前提条件请参见持续剖析。

Key	字段说明	Value
cp.enable	持续剖析开关	取值： - true：开启持续剖析开关。 - false：关闭持续剖析开关。 *该开关开启后，需要配置生效 IP，否则该开关不会生效。配置模式包括以下两种。

模式	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

信息脱敏字段说明 注：信息脱敏相关配置仅在探针版本大于等于 2.9.0 时生效。

Key	字段说明	Value
sanitizer.enable	信息脱敏开关	取值： - true：开启信息脱敏开关。 - false：关闭信息脱敏开关。
sanitizer.keys	脱敏规则	默认支持如示例规则，对 key 进行直接匹配，以 password 为例 ，规则等同于正则式 .*password.*，不分区大小写。多个规则之间以英文逗号分隔。 示例：password,secret,key,token,credentials