SpringBoot+Logback实现一个简单的链路追踪功能
最近线上排查问题时候,发现请求太多导致日志错综复杂,没办法把用户在一次或多次请求的日志关联在一起,所以就利用SpringBoot+Logback手写了一个简单的链路追踪,下面详细介绍下。
一、实现原理
SpringBoot默认使用LogBack日志系统,并且已经引入了相关的jar包,所以我们无需任何配置便可以使用LogBack打印日志。
MDC(MappedDiagnosticContext,映射调试上下文)是log4j和logback提供的一种方便在多线程条件下记录日志的功能。
实现思路是在一个请求开始时,将请求相关的上下文信息(例如客户ID、客户的IP地址、sessionId、请求参数等)添加到MDC,然后配置好logback-spring.xml,则Logback组件将会在每条日志中打印出存放到MDC的信息,从而实现一个ID贯穿用户的所有操作。
二、代码实战
新建一个springboot项目spring-boot-log,按照下面步骤操作。
新建日志拦截器
日志拦截器在请求开始获取用户的sessionId,当然也可以生成一个UUID,生成后存放到MDC中。
SessionInterceptor代码如下:
/** *日志拦截器 *@Author:Java碎碎念 * */ publicclassSessionInterceptorextendsHandlerInterceptorAdapter{ /** *会话ID */ privatefinalstaticStringSESSION_KEY="sessionId"; @Override publicvoidpostHandle(HttpServletRequestarg0,HttpServletResponsearg1, Objectarg2,ModelAndViewarg3)throwsException{ } @Override publicbooleanpreHandle(HttpServletRequestrequest, HttpServletResponseresponse,Objecthandler)throwsException{ //Stringtoken=UUID.randomUUID().toString().replaceAll("-",""); //本例测试使用sessionId,也可以使用UUID等 Stringtoken=request.getSession().getId(); MDC.put(SESSION_KEY,token); returntrue; } @Override publicvoidafterCompletion(HttpServletRequestarg0, HttpServletResponsearg1,Objectarg2,Exceptionarg3) throwsException{ //删除 MDC.remove(SESSION_KEY); } }
新建配置类
新建InterceptorConfig,注册刚才的日志拦截器。
InterceptorConfig代码如下:
@Configuration publicclassInterceptorConfigimplementsWebMvcConfigurer{ @Bean publicSessionInterceptorgetSessionInterceptor(){ returnnewSessionInterceptor(); } @Override publicvoidaddInterceptors(InterceptorRegistryregistry){ registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/*"); } }
修改logback-spring.xml
配置logback-spring.xml,获取日志拦截器添加的sessionId并打印到日志中,配置文件中获取方式如下:
%X{sessionId}
本例中打印sessionId到控制台和文件,完整配置如下:
%date[%thread][%X{sessionId}]%-5level%logger{80}-%msg%n ${log.base}.log ${log.base}.%d{yyyy-MM-dd}.log.zip %date[%thread][%X{sessionId}]%-5level%logger{80}-%msg%n
添加controller
新建TestLogController,打印日志。
代码如下:
@RestController publicclassTestLogController{ Loggerlog=LoggerFactory.getLogger(getClass()); /** *测试登录 */ @RequestMapping(value="/testLogin") publicStringtestLogin(){ log.info("用户登录成功!"); return"ok"; } /** *测试下单 */ @RequestMapping(value="/testNewOrder") publicStringtestNewOrder(){ log.info("用户创建了订单!"); log.info("请求完成,返回ok!"); return"ok"; } /** *测试购买 */ @RequestMapping(value="/testPay") publicStringtestPay(){ 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实现一个简单的链路追踪功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。