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项目启动找不到启动类的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java HashSet的Removals()方法注意事项

    Java HashSet的Removals()方法注意事项

    这篇文章主要介绍了Java HashSet的Removals()方法注意事项,文章围绕制主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-06-06
  • 自己动手写的mybatis分页插件(极其简单好用)

    自己动手写的mybatis分页插件(极其简单好用)

    最近做了个项目,需要用到mybatis分页功能,网上找了很多插件,都不太合适,于是就自己动手写了个mybatis分页插件功能,非常不错,代码简单易懂,需要的朋友参考下吧
    2016-11-11
  • Mybatis查询多条记录并返回List集合的方法

    Mybatis查询多条记录并返回List集合的方法

    这篇文章主要介绍了Mybatis查询多条记录并返回List集合的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • Java实现二维码功能的实例代码

    Java实现二维码功能的实例代码

    今天这篇文章,主要是利用Java实现二维码功能,本文思路清晰,需要的朋友参考下
    2017-02-02
  • 基于Java实现双向链表

    基于Java实现双向链表

    这篇文章主要为大家详细介绍了基于Java实现双向链表,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • Java实现删除排序链表中的重复元素的方法

    Java实现删除排序链表中的重复元素的方法

    这篇文章主要介绍了Java实现删除排序链表中的重复元素的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02
  • java对象转化成String类型的四种方法小结

    java对象转化成String类型的四种方法小结

    在java项目的实际开发和应用中,常常需要用到将对象转为String这一基本功能。本文就详细的介绍几种方法,感兴趣的可以了解一下
    2021-08-08
  • DUBBO 日志过滤器,输出dubbo 接口调用入参、出参等信息(最新推荐)

    DUBBO 日志过滤器,输出dubbo 接口调用入参、出参等信息(最新推荐)

    这篇文章主要介绍了DUBBO 日志过滤器,输出dubbo 接口调用入参、出参等信息,首先自定义一个过滤器 DubboLoggerFilter.java,本文结合示例代码给大家讲解的非常详细,需要的朋友可以参考下
    2022-12-12
  • SpringBoot实现分布式验证码登录方案小结

    SpringBoot实现分布式验证码登录方案小结

    验证码登录作为一种有效的防护手段,可以防止恶意gongji、暴力pojie等,本文主要介绍了SpringBoot实现分布式验证码登录方案小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-12-12

最新评论