文档

业务日志关联调用链的TraceId信息

更新时间:

您可以在应用的业务日志中关联调用链的TraceId信息,从而在应用出现问题时,能够通过调用链的TraceId快速关联到业务日志,及时定位分析、解决问题。

前提条件

说明

仅应用监控专家版支持该功能。

背景信息

ARMS在业务日志中关联调用链TraceId的功能基于MDC(Mapped Diagnostic Context)机制实现,支持主流的Log4j、Log4j2和Logback日志框架。

开启关联业务日志与TraceId开关

  1. 登录ARMS控制台,在左侧导航栏选择应用监控 > 应用列表

  2. 应用列表页面顶部选择目标地域,然后单击目标应用名称。

    说明

    语言列显示Java图标图标的应用为接入应用监控的应用,显示-图标的应用为接入可观测链路 OpenTelemetry 版的应用。

  3. 在左侧导航栏中单击应用设置,并在右侧单击自定义配置页签。

  4. 自定义配置页签的应用日志关联配置区域,选择日志源为日志服务,打开关联业务日志与TraceId开关,选择日志服务所在地域,然后绑定Project和Logstore。

    Link Business Logs with TraceId

    说明
  5. 在您业务日志的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的修改示例:

      PatternLayout

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

      JsonLayout

      <JsonLayout   complete="false" compact="true" eventEol="true"
                    properties="false" locationInfo="true"
                    includeStacktrace="true" stacktraceAsString="true"
                    objectMessageAsJsonObject="true" >
          <KeyValuePair key="EagleEye-TraceID" value="${ctx:EagleEye-TraceID}" />
      </JsonLayout>
    • Logback配置文件logback.xml的修改示例:

      PatternLayout

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

      JsonLayout

      <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
      	<providers>
      		<timestamp/>
      		<threadName/>
      		<logLevel/>
      		<loggerName/>
      		<message/>
      		<callerData/>
      		<stackTrace/>
      		<pattern>
      			<pattern>
      				{
      				"EagleEye-TraceID": "%X{EagleEye-TraceID}"
      				}
      			</pattern>
      		</pattern>
      	</providers>
      </encoder>
  6. 重启应用。

    在应用的业务日志中成功打印出TraceId信息,则说明业务日志关联调用链的TraceId关联成功,如下图所示。dg_am_log_traceid

  7. (可选)配置SLS日志采集接入,将应用日志上传至上述步骤绑定的Project和Logstore中。

    ARMS默认不会采集应用日志。

  • 本页导读 (1)