SpringBoot+Logback实现一个简单的链路追踪功能

 更新时间:2019年10月31日 13:37:39   转载 作者:java_lover  
Spring Boot默认使用LogBack日志系统,并且已经引入了相关的jar包,所以我们无需任何配置便可以使用LogBack打印日志。这篇文章主要介绍了SpringBoot+Logback实现一个简单的链路追踪功能,需要的朋友可以参考下

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

一、实现原理

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

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

实现思路是在一个请求开始时,将请求相关的上下文信息(例如客户ID、客户的IP地址、sessionId、请求参数等)添加到MDC,然后配置好logback-spring.xml,则Logback组件将会在每条日志中打印出存放到MDC的信息,从而实现一个ID贯穿用户的所有操作。

二、代码实战

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

新建日志拦截器

日志拦截器在请求开始获取用户的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);
  }
}

新建配置类

新建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("/*");
  }
}

修改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>

添加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手写一个简单的链路追踪功能已经全部实现,有问题欢迎留言沟通哦!

完整源码地址: https://github.com/suisui2019/springboot-study

总结

以上所述是小编给大家介绍的SpringBoot+Logback实现一个简单的链路追踪功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

相关文章

  • Java依赖倒转原则_动力节点Java学院整理

    Java依赖倒转原则_动力节点Java学院整理

    这篇文章主要介绍了Java依赖倒转原则的定义及问题由来解决方案,感兴趣的朋友一起看看吧
    2017-08-08
  • Java中支持可变参数详解

    Java中支持可变参数详解

    那个可变参数的就是个数组,你传多少个参数都被放到那个数组里面。这样方便了程序员,因为如果不确定要传的参数的个数的话,我们要写带1个参数的,带2个参数,带3个参数的,这样很麻烦。 该进后的这个方法,我们只要写一个函数就好,可以传任意个参数。
    2015-05-05
  • IntelliJ IDEA使用maven实现tomcat的热部署

    IntelliJ IDEA使用maven实现tomcat的热部署

    这篇文章主要介绍了IntelliJ IDEA使用maven实现tomcat的热部署,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • java 中sendredirect()和forward()方法的区别

    java 中sendredirect()和forward()方法的区别

    这篇文章主要介绍了java 中sendredirect()和forward()方法的区别,需要的朋友可以参考下
    2017-08-08
  • Spring Security OAuth2 实现登录互踢的示例代码

    Spring Security OAuth2 实现登录互踢的示例代码

    这篇文章主要介绍了Spring Security OAuth2实现登录互踢的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • Spring中循环依赖的解决方法详析

    Spring中循环依赖的解决方法详析

    这篇文章主要给大家介绍了关于Spring中循环依赖的解决方法,文中通过示例代码介绍的非常详细,对大家学习或者使用spring具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-08-08
  • Java String类正则操作示例

    Java String类正则操作示例

    这篇文章主要介绍了Java String类正则操作,结合实例形式分析了java针对数字的正则验证、过滤及邮箱正则验证相关操作技巧,需要的朋友可以参考下
    2019-07-07
  • Java计算程序代码执行时间的方法小结

    Java计算程序代码执行时间的方法小结

    这篇文章主要介绍了Java计算程序代码执行时间的方法,结合实例形式总结分析了java采用毫秒数及纳秒数计算程序运行时间的相关操作技巧,需要的朋友可以参考下
    2017-11-11
  • Kotlin基础教程之操作符与操作符重载

    Kotlin基础教程之操作符与操作符重载

    这篇文章主要介绍了Kotlin基础教程之操作符与操作符重载的相关资料,需要的朋友可以参考下
    2017-05-05
  • Java基于余弦方法实现的计算相似度算法示例

    Java基于余弦方法实现的计算相似度算法示例

    这篇文章主要介绍了Java基于余弦方法实现的计算相似度算法,简单说明了余弦相似性的概念、原理并结合实例形式分析了java实现余弦相似性算法的相关操作技巧,需要的朋友可以参考下
    2017-08-08

最新评论