全部产品
Search

搜索本产品

    应用实时监控服务ARMS：GetTraceAppConfig - 查询应用监控自定义设置

    文档中心

    应用实时监控服务ARMS：GetTraceAppConfig - 查询应用监控自定义设置

    更新时间：Nov 05, 2024

    查询应用监控中，某个应用的全部自定义设置（如调用链采样设置、Agent开关等）。此接口仅适用于接入应用监控的应用，不适用于接入可观测链路 OpenTelemetry 版的应用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    arms:GetTraceAppConfigget
    • TraceApp
      acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
      无
    		无

    请求参数

    名称类型必填描述示例值
    Pidstring是

    应用 ID。

    您可以通过以下两种方法获取 Pid：

    • API：ListTraceApps - 获取指定地域下全部应用监控任务的列表。

    • 控制台：在 ARMS 控制台的应用监控>应用列表页面单击目标应用名称。此时浏览器地址栏中的 URL 即包含应用的 Pid，格式为 pid=xxx。由于浏览器进行了编码，因此需要对 Pid 稍作修改。例如，如果 URL 中包含的 Pid 为 xxx%4074xxx，则需要将%40 替换为@，即：xxx@74xxx。

    注意

  • 通过控制台获取 Pid 的方法，仅适用于接入应用监控的应用，不适用于接入可观测链路 OpenTelemetry 版的应用。

  • 本文档所描述的接口 GetTraceAppConfig，也仅支持查询接入应用监控的应用的自定义设置。

    •
    		a2n80plglh@745eddxxx

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		78901766-3806-4E96-8E47-CFEF59E4****
    Datastring

    应用的自定义配置，格式为一个 JSON 字符串，每个配置的含义见返回参数补充说明。

    		{"profiler":{"enable":true}}
    Messagestring

    返回信息。

    		查询应用配置成功
    Codelong

    接口状态码。

    枚举值：
    • 2xx：成功。
    • 3xx：重定向。
    • 4xx：请求错误。
    • 5xx：服务器错误。
    		200
    Successboolean

    查询是否成功。

    枚举值：
    • true：成功。
    • false：失败。
    		true

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

    采样设置说明

    配置说明JSONPathType备注默认值
    采样策略profiler.sampling.useSamplingStrategyV2boolean取值：
    - true：自适应采样。
    - false：固定采样率。    		false
    采样率百分比profiler.sampling.ratedouble0~100 之间。
    固定采样率模式下生效。    		10
    全采样接口名profiler.sampling.v2config.spanNames4FullSampleStrString全采样接口名，多个由英文逗号分隔。空字符串
    全采样接口前缀profiler.sampling.v2config.spanNamePrefixes4FullSampleStrString全采样接口前缀。空字符串
    全采样接口后缀profiler.sampling.v2config.spanNameSuffixes4FullSampleStrString全采样接口后缀。空字符串

    探针开关设置说明

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

    线程分析设置说明

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

    应用日志关联配置说明

    配置说明JSONPathType备注默认值
    日志源profiler.logSourceString取值：
    - sls：日志服务 SLS。    		sls
    自动关联业务日志与 TraceIdprofiler.logging.enableboolean取值：
    - true：开启关联功能。
    - false：关闭关联功能。    		true
    日志自动填充 TraceIdprofiler.logging.injectTraceId2Log.enableboolean取值：
    - true：开启自动填充功能。
    - false：关闭自动填充功能。
    探针版本大于等于 4.1.6生效。    		true
    日志自动填充 SpanIdprofiler.logging.injectSpanId2Log.enableboolean取值：
    - true：开启自动填充功能。
    - false：关闭自动填充功能。
    探针版本大于等于 4.1.6生效。    		true
    日志服务绑定-区域profiler.SLS.regionIdString关联日志源所在的地域。空字符串
    日志服务绑定-Projectprofiler.SLS.projectString关联日志源所属 Project。空字符串
    日志服务绑定-Logstoreprofiler.SLS.logStoreString关联日志源 Logstore。空字符串
    日志服务绑定-关联索引profiler.SLS.indexString关联日志源索引。空字符串

    URL 收敛配置说明

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

    Arthas 配置说明

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

    持续剖析配置说明

    配置说明JSONPathType备注默认值
    总开关profiler.cp.enableboolean取值：
    - true：开启持续剖析功能。
    - false：关闭持续剖析功能。
    *该开关开启后，有两种配置模式，见下表。    		false
    CPU 热点profiler.cp.cpuEnableboolean取值：
    - true：开启 CPU 热点功能。
    - false：关闭 CPU 热点功能。    		false
    内存热点profiler.cp.allocEnableboolean取值：
    - true：开启内存热点功能。
    - false：关闭内存热点功能。    		false
    内存热点profiler.cp. wallClockEnableboolean取值：
    - true：开启代码热点功能。
    - false：关闭代码热点功能。    		false
    模式Key字段说明Value
    IP 白名单cp.allowIPsIP 白名单指定开启持续剖析的实例 IP，多个 IP 请使用英文逗号（,）分割。
    示例：192.168.0.1,192.168.0.2
    cp.allowNetwork网段地址请传递空字符串，否则将无法正常使用。
    网段地址cp.allowIPsIP 白名单请传递空字符串，否则将无法正常使用。
    cp.allowNetwork网段地址命中此网段地址范围的 IP 实例打开该功能。
    示例：192.168.2.0/24

    信息脱敏配置说明

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

    接口调用配置说明

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

    数据库调用配置说明

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

    调用链透传协议配置说明

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

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

    高级配置说明

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

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****\n",
  "Data": "{\"profiler\":{\"enable\":true}}",
  "Message": "查询应用配置成功",
  "Code": 200,
  "Success": true
}

    错误码

    HTTP status code错误码错误信息描述
    400ParameterPidMissingYou must specify pid.参数pid缺失
    404AppNotExistThe application does not exist.应用不存在
    500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.内部错误，建议重试。如果多次重试报错请联系钉钉服务账号。

    访问错误中心查看更多错误码。