skywalking项目打印traceId

深藏阁楼爱情的钟 2022-11-07 01:50 433阅读 0赞

# 1、背景 #

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

# 2、引入依赖 #

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

# 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>
    	
    	
    
    	
    	<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>
    
    	
    	<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>
    	
    	
    	<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][https_gitee.com_xixingzhe2_learn_tree_master_skywalking]

[https_gitee.com_xixingzhe2_learn_tree_master_skywalking]: https://gitee.com/xixingzhe2/learn/tree/master/skywalking