欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2023-10-28 23:56:40
最近线上排查问题时候,发现请求太多导致日志错综复杂,没办法把用户在一次或多次请求的日志关联在一起,所以就利用SpringBoot+Logback手写了一个简单的链路追踪,下面详细介绍下。 [TOC] 一、实现原理 Spring Boot默认使用LogBack日志系统,并且已经引入了相关的jar包,所 ......

目录

最近线上排查问题时候,发现请求太多导致日志错综复杂,没办法把用户在一次或多次请求的日志关联在一起,所以就利用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,按照下面步骤操作。

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

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

推荐阅读

1.springboot中如何优雅的读取yml配置文件?
2.springboot中如何灵活的实现接口数据的加解密功能?
3.springboot中神奇的@enable*注解?
4.java中integer.parseint和integer.valueof,你还傻傻分不清吗?
5.springcloud系列-整合hystrix的两种方式


限时领取免费java相关资料,涵盖了java、redis、mongodb、mysql、zookeeper、spring cloud、dubbo/kafka、hadoop、hbase、flink等高并发分布式、大数据、机器学习等技术。
关注下方公众号即可免费领取:

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