Spring boot结合SkyWalking-Trace工具类实现日志打印请求链路traceid

news2024/11/27 18:29:22

背景：

随着业务的复杂化、解耦化，运维人员和开发人员需要对请求链路跟踪来快速发现和定位问题，基于应用已经集成了SkyWalking的前提下，如何通过获取SkyWalking生成的统一traceId并加入打印日志中，方便开发人员能够根据链路ID快速搜索单个请求的全链路日志呢？

基本思路：

trace-id的生成：

结合apm-toolkit-trace提供的工具类获取请求的trace-id，前提是应用已经集成对接了SkyWalking

trace-id的存放：

一种轻量级的实现，通过 MDC 机制，将请求的 trace-id 放入到MDC中，在日志打印时，通过 MDC 中的 trace-id 将同一个请求的每一条日志串联起来。因为 MDC 是线程隔离且安全的。

trace-id的打印：

通过修改logback.xml配置中pattern增加输出参数%X{traceId}来控制。

trace-id存放的触发机制：

通常实现方式，采用增加日志拦截器的做法，将拦截服务所有外部请求，在请求前置处理中将生成trace-id并保存入MDC中。

代码示例：

通用做法-开发三板斧：依赖、配置、注解与编码

依赖

<!-- skywalking依赖包 打印traceid -->
<dependency>
			<groupId>org.apache.skywalking</groupId>
			<artifactId>apm-toolkit-trace</artifactId>
			<version>8.7.0</version>
</dependency>

配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds">
    <jmxConfigurator/>

    <contextName>logback</contextName>

    <springProperty scope="context" name="module_name" source="spring.application.name"/>
    <!-- 读取apollo配置中心设置的变量 -->
    <springProperty scope="context" name="version" source="app.version"/>
    <springProperty scope="context" name="env" source="app.env"/>

    <timestamp key="log_date" datePattern="yyyy-MM-dd"/>

    <!--自定义输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} - thead=%thread - level=%-5level - class=%logger{20} - token=%X{token} - traceId=%X{traceId} - content=%msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="debug">
        <appender-ref ref="STDOUT"/>
    </root>

</configuration>

编码

(1) 自定义拦截器LoggerInterceptor

package com.zzia.demo.interceptor;

import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.skywalking.apm.toolkit.trace.TraceContext;


@Component
public class LoggerInterceptor implements HandlerInterceptor {

    /**
     * @return 返回 true 放行、放回 false 拦截
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("进入拦截器，前置通知" + request.getRequestURI());
        // 过滤掉确认的 options 请求
        if ("OPTIONS".equals(request.getMethod())) {
            return true;
        }

        // 单链路上下文信息存入MDC

        // 请求凭证
        String token = request.getHeader("__ub_token");
        MDC.put("token", token);
        //每次请求生成唯一的请求标识，作为内部链路的日志追踪标识
        MDC.put("traceId", TraceContext.traceId());
        // 业务身份字段可扩展加入
        String userId = "123456";
        MDC.put("userId", userId);

        if (token != null) {
            return true;
        }

        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("后置通知");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("最终通知");
        MDC.clear();
    }
}

(2) 注册拦截器

package com.zzia.demo.interceptor;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;


@Configuration
public class MyLoggerConfigurer implements WebMvcConfigurer {

    @Autowired
    LoggerInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(myInterceptor)    // 添加自定义拦截器
                .excludePathPatterns("/index") // 设置放行路径
                .addPathPatterns("/**");       // 设置拦截路径
    }
}