首页 应用实时监控服务ARMS API参考指南 API目录 应用监控 SaveTraceAppConfig - 应用监控自定义设置

SaveTraceAppConfig - 应用监控自定义设置

调用SaveTraceAppConfig接口进行应用监控的自定义设置(如调用链采样设置、Agent开关等)。

调试

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

调试

授权信息

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

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

请求参数

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

应用的ID标识串。获取方式请参见如何获取应用PID

a2n80plglh@745eddxxx
Settingsarray

自定义设置列表。

object
Keystring

自定义设置,各设置的详细字段见下文说明。

  • 调用链路采样相关
  • 总开关设置
  • 阈值设置
  • 高级设置
  • 线程设置
  • 内存快照设置
  • URL收敛设置
  • 业务日志关联设置
  • 业务监控设置
sampling.enable
Valuestring

自定义设置,各设置的详细字段见下文说明。

  • 调用链路采样相关
  • 总开关设置
  • 阈值设置
  • 高级设置
  • 线程设置
  • 内存快照设置
  • URL收敛设置
  • 业务日志关联设置
  • 业务监控设置
true

调用链路采样字段说明

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

总开关字段说明

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

阈值字段说明

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

高级字段说明

Key字段说明Value
defined.excludeurl无效接口调用过滤支持以英文逗号(,)分隔多个接口调用。示例:/service/taobao,/service/status。
callstack.maxLength方法堆栈最大长度间阈值默认为128,支持最大长度400条。
callsql.maxLength采集SQL最大长度默认为1024个字符,最小长度为256个字符,最大长度为4096个字符。
exception.whitelist异常过滤使用正则表达式匹配异常类全名,多个异常请使用英文逗号(,)分隔。例如:java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException。此处输入的异常不会显示在应用详情和异常分析页面的图表中。
error.skip错误数过滤默认情况下,大于400的状态码会计入错误数,您可以设置需要忽略的状态码,多个错误码使用英文逗号(,)分隔,例如:429或429,512。Agent 2.5.7.2以上版本支持。
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分钟采集一次方法栈。

URL收敛字段说明

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

业务日志关联字段说明

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
字段索引及全文索引的区别,请参见配置索引

业务监控字段说明

Key字段说明Value
scenario.enable业务监控开关取值:
- true:开启业务监控开关。
- false:关闭业务监控开关。
控制业务监控是否生效,Agent 2.6.2以上版本支持。
scenario.http.encodingHTTP编码默认为UTF-8,用于对HTTP参数解析,请按实际情况设置。

返回参数

名称类型描述示例值
object
Datastring

操作是否成功。

success
RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

{
    "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
    "Data": "success"
}

XML格式

<SaveTraceAppConfigResponse>
    <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>
    <Data>success</Data>
</SaveTraceAppConfigResponse>

错误码

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

变更历史

变更时间变更内容概要操作
2022-04-18
变更项变更内容
阿里云首页 应用实时监控服务ARMS 相关技术圈