Springboot接口日志加入链路追踪traceId方式

 更新时间:2025年08月15日 09:38:17   作者:Geek-SX  
文章介绍通过添加依赖、配置logback-spring.xml、使用@LogTrace注解和LogTraceAspect切面实现请求日志追踪,测试时日志中可显示traceId

Springboot接口日志加入链路追踪traceId

1.注解 LogTrace

package com.bt.springboot.common.annotation;

import java.lang.annotation.*;

/**
 * 链路追踪
 *
 * @author
 */
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogTrace {
}

2.切面 LogTraceAspect

package com.bt.springboot.common.aspect;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import java.util.UUID;

/**
 * 链路追踪
 *
 * @author
 */
@Aspect
@Component
@Slf4j
public class LogTraceAspect {

    /**
	 * 与 logback-spring.xml 中的变量一致
     */
    private static final String TRACE_ID = "traceId";

    /**
     * 定义切点 切点为
     */
    @Pointcut("@within(com.bt.springboot.common.annotation.LogTrace)")
    public void printLog(){
    }

    /**
     * 环绕通知
     */
    @Around(value = "printLog()")
    public Object webLogAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 方法执行前加上链路号
        String traceId = UUID.randomUUID().toString().replaceAll("-", "");
        MDC.put(TRACE_ID, traceId);
        Object proceed = joinPoint.proceed();
        MDC.remove(TRACE_ID);
        return proceed;
    }
}

3.添加依赖

<!-- 链路追踪 -->
        <dependency>
            <groupId>org.apache.skywalking</groupId>
            <artifactId>apm-toolkit-logback-1.x</artifactId>
            <version>8.0.1</version>
        </dependency>

4.修改logback-spring.xml

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--
         <encoder>:对日志进行格式化。
         <target>:字符串System.out(默认)或者System.err
         -->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] [%-5level] %logger{50} - %msg%n</pattern>
            </layout>
        </encoder>
    </appender>

5.测试 在类或方法上加上注解@LogTrace

package com.bt.springboot.web.controller;

import com.bt.springboot.common.annotation.LogTrace;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * @author zkx
 * @Date 2022/4/8 11:36
 */
@LogTrace
@Slf4j
@RestController
public class TestController {

	@GetMapping("/test")
	public void test(){
		log.info("info");
	}
}

  • 发送请求 日志可查看到traceId

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • springboot 多环境切换的方法

    springboot 多环境切换的方法

    这篇文章主要介绍了springboot 多环境切换的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • JDK8安装与配置实践超详细指南

    JDK8安装与配置实践超详细指南

    本文详细介绍了在Windows 64位系统上安装和配置JDK8的步骤,包括JDK8下载、环境变量设置及安装验证,同时提供了JDK8新特性如Lambda表达式、StreamAPI等的概览,旨在帮助Java开发者有效利用JDK8新特性进行开发,需要的朋友可以参考下
    2024-10-10
  • 轻松掌握Java适配器模式

    轻松掌握Java适配器模式

    这篇文章主要帮助大家轻松掌握Java适配器模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-09-09
  • Java回溯法解决全排列问题流程详解

    Java回溯法解决全排列问题流程详解

    从n个不同元素中任取m(m≤n)个元素,按照一定的顺序排列起来,叫做从n个不同元素中取出m个元素的一个排列。当m=n时所有的排列情况叫全排列。这篇文章主要介绍了Java回溯法解决全排列问题
    2022-10-10
  • java 垃圾回收机制以及经典垃圾回收器详解

    java 垃圾回收机制以及经典垃圾回收器详解

    这篇文章主要介绍了java 垃圾回收机制以及经典垃圾回收器详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • MyBatis Generator生成数据库模型实现示例

    MyBatis Generator生成数据库模型实现示例

    这篇文章主要为大家介绍了MyBatis Generator生成数据库模型实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12
  • Java @Scheduled定时任务不执行解决办法

    Java @Scheduled定时任务不执行解决办法

    这篇文章主要给大家介绍了关于Java @Scheduled定时任务不执行解决的相关资料,当@Scheduled定时任务不执行时可以根据以下步骤进行排查和解决,需要的朋友可以参考下
    2023-10-10
  • SpringBoot如何优雅的整合Swagger Api自动生成文档

    SpringBoot如何优雅的整合Swagger Api自动生成文档

    在多人协作的开发过程中,API文档不仅可以减少等待,也能保证开发的持续进行,这篇文章主要给大家介绍了关于SpringBoot如何优雅的整合Swagger Api自动生成文档的相关资料,需要的朋友可以参考下
    2021-07-07
  • idea开启mybatis控制台SQL日志打印的代码示例

    idea开启mybatis控制台SQL日志打印的代码示例

    本文主要介绍了idea开启mybatis控制台SQL日志打印的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-12-12
  • 详解Spring Data JPA系列之投影(Projection)的用法

    详解Spring Data JPA系列之投影(Projection)的用法

    本篇文章主要介绍了详解Spring Data JPA系列之投影(Projection)的用法,具有一定的参考价值,有兴趣的可以了解一下
    2017-07-07

最新评论