Springboot实现链路追踪功能

最新推荐文章于 2025-06-11 10:33:04 发布

原创

最新推荐文章于 2025-06-11 10:33:04 发布 · 1.9k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot

前言

在日常开发中，一个业务的实现往往会调用很多个方法，当我们去看日志的时候，各种接口的日志打印出来，看着就头疼，压根没办法去定位，而链路追踪就能很好的帮助我们去查看接口从头至尾依次调用了哪些方法。

同时我们还可以通过链路追踪的traceId去日志文件中去定位问题，比如：

grep   'c03ed014b9b34252b872009d030904f7'    log.log
或者
# 查看上下5行
grep -5   'c03ed014b9b34252b872009d030904f7'    log.log

如图所示：
在这里插入图片描述

实现代码

本案例实现是通过springboot默认日志logback实现。

第一步：导入Maven依赖

    <!--lombok配置-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.16.10</version>
    </dependency>

第二步：添加整合logback，打印日志，logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <springProperty scope="context" name="log.path" source="log.path"/>
 <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
    <!-- 彩色日志格式 -->