Skywalking配置traceId

1.引言

1.1 SkyWalking概述

SkyWalking是一个开源的分布式系统观测平台，旨在解决微服务和云原生架构中常见的性能监控和故障排除问题。自2015年由Apache基金会孵化以来，SkyWalking已经成为全球范围内广泛使用的APM（应用性能管理）解决方案之一。

1.2 traceId作用

在分布式系统中，traceId（追踪ID）起着关键作用。它是唯一的标识符，用于标记和跟踪一个请求在不同服务之间的传递过程。通过traceId，我们可以追踪到一个请求从进入系统到完成的整个路径，详细了解各个服务之间的调用关系和时间耗费，从而迅速定位问题和瓶颈。本篇文章将介绍如何在SkyWalking中配置和使用traceId。

2.traceId配置

skywalking提供了 log4j, log4j2, 和 logback 日志库的traceId配置方法，这里以logback为例

2.1 添加maven依赖工具包：

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

2.2 在 logback-spring.xml 日志配置文件中添加 [%tid] 配置

1）appender修改，layout中使用TraceIdPatternLogbackLayout

<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
    <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
        <pattern>${CONSOLE_LOG_PATTERN}</pattern>
    </layout>
    <charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>

2）CONSOLE_LOG_PATTERN添加[%tid]占位符

<property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{36} -%msg%n"/>

完整logback-spring.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--引入通用定义-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />

    <!--引入运行参数-->
    <springProperty name="APP_NAME" scope="context" source="spring.application.name"/>
    <springProperty name="LOG_DIR" scope="context" source="log.dir"/>
    <property name="LOG_DIR" value="${LOG_DIR}}"/>

    <!--定义日志文件的名称-->
    <property name="LOG_NAME" value="${LOG_DIR}/${APP_NAME}"/>

    <!--定义日志文件格式-->
    <property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{36} -%msg%n"/>
    <property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{36} -%msg%n"/>
  


    <!-- 按照每天生成日志文件并压缩 -->
    <appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名 -->
            <FileNamePattern>${LOG_NAME}_%d{yyyy-MM-dd}_%i.log
            </FileNamePattern>
            <MaxHistory>30</MaxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>1024MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <pattern>${FILE_LOG_PATTERN}</pattern>
            </layout>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
    </appender>
    <appender name="CONSOLE" 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>${CONSOLE_LOG_PATTERN}</pattern>
            </layout>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
    </appender>

    <!--网络请求日志级别-->
    <logger name="com.netflix" level="DEBUG"/>
    <logger name="org.apache.http" level="DEBUG"/>

    <root level="info">
        <appender-ref ref="FILE_INFO"/>
        <appender-ref ref="CONSOLE"/>
    </root>

</configuration>

3.测试结果

同时，也可以根据日志中的traceId，在skywalking页面进行检索查看详细的trace信息

注意：正常请求会显示TID也就是traceId，当非客户端请求时打印的是[TID:N/A]或[TID:Ignored_trace]

参考资料：

1. https://github.com/apache/skywalking-java/blob/main/docs/en/setup/service-agent/java-agent/Application-toolkit-logback-1.x.md#print-skywalking-context-in-your-logs
2. https://zhuanlan.zhihu.com/p/596247594?utm_id=0