您可以在应用的业务日志中关联调用链的TraceId信息,从而在应用出现问题时,能够通过调用链的TraceId快速关联到业务日志,及时定位分析、解决问题。
前提条件
说明 仅应用监控专家版支持该功能。
您已将Agent版本升级至2.6.1.2及以上版本,具体操作,请参见更新Java探针版本。
- 已通过日志服务SLS完成日志采集,具体操作,请参见数据采集概述。
背景信息
ARMS在业务日志中关联调用链TraceId的功能基于MDC(Mapped Diagnostic Context)机制实现,支持主流的Log4j、Log4j2和Logback日志框架。开启关联业务日志与TraceId开关
- 登录ARMS控制台,在左侧导航栏选择 。
- 在应用列表页面顶部选择目标地域,然后单击目标应用名称。说明 语言列显示
图标的应用为接入应用监控的应用,显示-图标的应用为接入链路追踪的应用。
- 在左侧导航栏中单击应用设置,并在右侧单击自定义配置页签。
- 在自定义配置页签的应用日志关联配置区域,选择日志源为日志服务,打开关联业务日志与TraceId开关,选择日志服务所在地域,然后绑定Project和Logstore。说明
- 开启此开关后,业务日志中将会自动生成调用链的TraceId。
- 如果您还需要实现精准定位业务异常问题,请参见通过调用链路和日志分析定位业务异常问题。
- 在您业务日志的Layout的Pattern属性中添加
%X{EagleEye-TraceID}
配置。说明 如何在业务代码中获取{EagleEye-TraceID}
,请参见ARMS SDK使用说明。下面分别展示Log4j、Log4j2和Logback组件的示例配置文件:
- Log4j配置文件log4j.properties的修改示例:
log4j.appender.warn.layout=org.apache.log4j.PatternLayout log4j.appender.warn.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss}-[%p]-(%C:%L) - traceId:%X{EagleEye-TraceID} - %m%n
- Log4j2配置文件log4j2.xml的修改示例:
<console name="Console" target="SYSTEM_OUT"> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - traceId:%X{EagleEye-TraceID} - %m%n"/> </console>
- Logback配置文件logback.xml的修改示例:
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - traceId:%X{EagleEye-TraceID} - %msg%n</pattern> </encoder>
- Log4j配置文件log4j.properties的修改示例:
- 重启应用。在应用的业务日志中成功打印出TraceId信息,则说明业务日志关联调用链的TraceId关联成功,如下图所示。