利用SpringBoot+Logback手写一个简单的链路追踪

Java碎碎念 2021-04-28

栏目: 精品阅读 ·

来源: Java碎碎念

简介  这篇文章主要介绍了利用SpringBoot+Logback手写一个简单的链路追踪以及相关的经验技巧,文章约17510字,浏览量239,点赞数5,值得参考!

优质文章,第一时间送达

最近线上排查问题时候,发现请求太多导致日志错综复杂,没办法把用户在一次或多次请求的日志关联在一起,所以就利用SpringBoot+Logback手写了一个简单的链路追踪,下面详细介绍下。

本文目录

一、实现原理二、代码实战三、测试

一、实现原理

Spring Boot默认使用LogBack日志系统,并且已经引入了相关的jar包,所以我们无需任何配置便可以使用LogBack打印日志。

MDC(Mapped Diagnostic Context,映射调试上下文)是log4j和logback提供的一种方便在多线程条件下记录日志的功能。

二、代码实战

新建一个spring boot项目spring-boot-log,按照下面步骤操作。

  1. 新建日志拦截器

日志拦截器在请求开始获取用户的sessionId,当然也可以生成一个UUID,生成后存放到MDC中。
SessionInterceptor代码如下:

/**
 * 日志拦截器
 * @Author: Java碎碎念
 *
 */

public class SessionInterceptor extends HandlerInterceptorAdapter {
    /**
     * 会话ID
     */

    private final static String SESSION_KEY = "sessionId";


    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1,
                           Object arg2, ModelAndView arg3)
 throws Exception 
{
    }

    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response, Object handler)
 throws Exception 
{

//        String token = UUID.randomUUID().toString().replaceAll("-","");
        //本例测试使用sessionId,也可以使用UUID等
        String token = request.getSession().getId();
        MDC.put(SESSION_KEY, token);
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest arg0,
                                HttpServletResponse arg1, Object arg2, Exception arg3)

            throws Exception 
{
        // 删除
        MDC.remove(SESSION_KEY);
    }
}
  1. 新建配置类

新建InterceptorConfig,注册刚才的日志拦截器。

InterceptorConfig代码如下:

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Bean
    public SessionInterceptor getSessionInterceptor() {
        return new SessionInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/*");
    }
}
  1. 修改logback-spring.xml

配置logback-spring.xml,获取日志拦截器添加的sessionId并打印到日志中,配置文件中获取方式如下:

%X{sessionId}

本例中打印sessionId到控制台和文件,完整配置如下:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="log.base" value="./log/logback"/>
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n
            </pattern>
        </encoder>
    </appender>

    <appender name="logfile"
              class="ch.qos.logback.core.rolling.RollingFileAppender">

        <File>${log.base}.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${log.base}.%d{yyyy -MM-dd}.log.zip</FileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern> %date [%thread] [%X{sessionId}]  %-5level %logger{80} - %msg%n
            </pattern>
        </encoder>
    </appender>
    <logger name="com.sample" level="TRACE"/>
    <root>
        <level value="INFO"/>
        <appender-ref ref="stdout"/>
        <appender-ref ref="logfile"/>
    </root>
</configuration>
  1. 添加controller

新建TestLogController,打印日志。

代码如下:

@RestController
public class TestLogController {

    Logger log = LoggerFactory.getLogger(getClass());

    /**
     * 测试登录
     */

    @RequestMapping(value = "/testLogin")
    public String testLogin() {
        log.info("用户登录成功!");
        return "ok";
    }

    /**
     * 测试下单
     */

    @RequestMapping(value = "/testNewOrder")
    public String testNewOrder() {
        log.info("用户创建了订单!");
        log.info("请求完成,返回ok!");
        return "ok";
    }

    /**
     * 测试购买
     */

    @RequestMapping(value = "/testPay")
    public String testPay() {
        log.info("用户付款!");
        return "ok";
    }
}

三、测试

打开浏览器连续访问接口testLogin、testNewOrder和testPay,模拟用户登录、下单、付款操作,控制台和文件中打印的日志中已经包含了sessonId信息,打印的结果如下:

[http-nio-8888-exec-1] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO  com.example.springbootlog.controller.TestLogController - 用户登录成功!
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO  com.example.springbootlog.controller.TestLogController - 用户创建了订单!
[http-nio-8888-exec-2] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO  com.example.springbootlog.controller.TestLogController - 请求完成,返回ok
[http-nio-8888-exec-3] [CB8E7DB250A31F2BE6C05B30633B9A95] INFO  com.example.springbootlog.controller.TestLogController - 用户付款!

到此SpringBoot+Logback手写一个简单的链路追踪功能已经全部实现,有问题欢迎留言沟通哦!

推荐阅读






Java碎碎念公众号




以上就是本文的全部内容,希望对大家的学习有所帮助,本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

相关文章

【踩坑记】SpringBoot使用Logback

启动SpringBoot报错LoggerFactory is not a Logback ...

SpringBoot 集成ZooKeeper 框架实现LogBack 日志输出

SpringBoot集成logback彩色日志配置以及banner启动设置(炫酷到爆炸!)

SpringBoot 项目打包war 包部署Tomcat,logback 日志记录不生效解决办法

使用idea 搭建一个 SpringBoot + Mybatis + logback 的maven 项目

为什么在SpringBoot中可以直接使用LogBack、Log4j、Log4j2等?

Spring boot 启动过程解析 logback(示例代码)