skywalking项目打印traceId

1、背景

在我们系统或者应用中集成了skywalking后，我就可以进行链路的跟踪了。我们在使用ELK或者其他的一些日志分析工具查找日志。如果要跟踪系统调用链，我们需要在日志中打印出traceId。

2、引入依赖

<!--skywalking traceId start-->
<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-logback-1.x</artifactId>
    <version>8.4.0</version>
</dependency>
<!--skywalking traceId end-->

3、修改logback.xml

在对应的appender中添加

<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
 <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
  <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - [%tid] - %msg%n</pattern>
 </layout>
</encoder>

Logback中的encoder本身是包含一个layout的，在有此Appender中是可以直接用encoder中的layout部分的。
encoder的class是LayoutWrappingEncoder，不是PatternLayoutEncoder。
使用%tid 来占trace-id的位置，默认TID:N/A，当有请求调用时，会显示trace-id。

修改

layout的class采用skywalking中才改的org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout。
在pattern中添加[%tid] tid参数是用来打印traceId的值。

全部logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
 <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
 <!-- <property name="LOG_HOME" value="d:" /> -->

 <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
 <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
   <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
    <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - [%tid] - %msg%n</pattern>
   </layout>
  </encoder>
 </appender>

 <!-- info日志输出 -->
 <appender name="InfoFile"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <File>${LOG_HOME:-c:/}logs/info/info.log</File>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
   <FileNamePattern>${LOG_HOME:-c:/}logs/info/info-%d{yyyy-MM-dd}.%i.log
   </FileNamePattern>
   <MaxHistory>60</MaxHistory>
   <TimeBasedFileNamingAndTriggeringPolicy
    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    <MaxFileSize>5MB</MaxFileSize>
   </TimeBasedFileNamingAndTriggeringPolicy>
  </rollingPolicy>
  <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
   <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - [%tid] - %msg%n</pattern>
  </layout>
  <filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 只打印错误日志 -->
   <level>INFO</level>
   <onMatch>ACCEPT</onMatch>
   <onMismatch>DENY</onMismatch>
  </filter>
 </appender>
 
 <!-- error日志输出 -->
 <appender name="ErrorFile"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <File>${LOG_HOME:-c:/}logs/error/error.log</File>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
   <FileNamePattern>${LOG_HOME:-c:/}logs/error/error-%d{yyyy-MM-dd}.%i.log
   </FileNamePattern>
   <MaxHistory>60</MaxHistory>
   <TimeBasedFileNamingAndTriggeringPolicy
    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    <MaxFileSize>5MB</MaxFileSize>
   </TimeBasedFileNamingAndTriggeringPolicy>
  </rollingPolicy>
  <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
   <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - [%tid] - %msg%n</pattern>
  </layout>
  <filter class="ch.qos.logback.classic.filter.LevelFilter"><!-- 只打印错误日志 -->
   <level>ERROR</level>
   <onMatch>ACCEPT</onMatch>
   <onMismatch>DENY</onMismatch>
  </filter>
 </appender>
 
 <!-- 所有日志输出 -->
 <appender name="AllFile"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <File>${LOG_HOME:-c:/}logs/all/all.log</File>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
   <FileNamePattern>${LOG_HOME:-c:/}logs/all/all-%d{yyyy-MM-dd}.%i.log
   </FileNamePattern>
   <MaxHistory>60</MaxHistory>
   <TimeBasedFileNamingAndTriggeringPolicy
    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    <MaxFileSize>5MB</MaxFileSize>
   </TimeBasedFileNamingAndTriggeringPolicy>
  </rollingPolicy>
  <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
   <pattern>[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - [%tid] - %msg%n</pattern>
  </layout>
 </appender>

 <root level="info">
  <appender-ref ref="stdout" />
  <appender-ref ref="InfoFile" />
  <appender-ref ref="ErrorFile" />
  <appender-ref ref="AllFile" />
 </root>
</configuration>

4、示例代码

https://gitee.com/xixingzhe2/learn/tree/master/skywalking