当前位置: 首页 > 科技观察

SpringBoot如何快速过滤掉一个请求的所有日志?

时间:2023-03-11 22:42:33 科技观察

当出现故障时,我们往往需要获取请求过程中的所有日志进行定位。如果请求只在一个线程中处理,我们可以通过线程ID过滤日志,但是如果请求中包含异步线程的处理,那么单独线程ID就会捉襟见肘。华为物联网平台提供接收设备上报数据的能力。当数据到达平台后,平台会进行一些复杂的业务逻辑处理,如数据存储、规则引擎、数据推送、命令下发等。由于这个逻辑之间没有强耦合关系,所以通常是异步处理的。如何快速过滤掉一个数据上报请求中包含的所有业务日志,就是本文要介绍的内容。1、正文SLF4J日志框架提供了一个MDC(MappedDiagnosticContexts)工具类。Google将其翻译成映射的诊断上下文。从字面上很难理解。我们可以先做。publicclassMain{privatestaticfinalStringKEY="requestId";privatestaticfinalLoggerlogger=LoggerFactory.getLogger(Main.class);publicstaticvoidmain(String[]args){//入口传入请求IDMDC.put(KEY,UUID.randomUUID().toString());//打印日志logger.debug("loginmainthread1");logger.debug("登录主线程2");logger.debug("登录主线程3");//退出移除请求IDMDC.remove(KEY);}}我们在main函数入口调用MDC.put()传入requestID,在exit调用MDC.remove()方法removerequestid。配置log4j2.xml文件后,运行main函数,可以在控制台看到如下日志输出:2018-02-1713:19:52.606{requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0}[main]DEBUGcn.wudashan.Main-登录主线程12018-02-1713:19:52.609{requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0}[main]DEBUGcn.wudashan.Main-登录主线程22018-02-1713:19:52.609{requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0}[main]DEBUGcn.wudashan.Main-loginmainthread3从日志中可以明显看出大括号中包含(mapped)请求ID(requestId),其实就是我们定位(诊断)问题的关键词(上下文)。使用MDC工具,只要在接口或切面植入put()和remove()代码,在现网定位问题时,通过greprequestId=xxx*即可快速过滤掉某个请求的所有日志。日志。2.高级但是,MDC工具真的有我们想象的那么方便吗?回到最开始,一个请求可能会涉及到多线程的异步处理,那么在多线程的异步场景下,还能正常工作吗?话不多说,给我看看代码。publicclassMain{privatestaticfinalStringKEY="requestId";privatestaticfinalLoggerlogger=LoggerFactory.getLogger(Main.class);publicstaticvoidmain(String[]args){//入口传入请求IDMDC.put(KEY,UUID.randomUUID().toString());//主线程打印Loglogger.debug("loginmain线”);//异步线程打印lognewThread(newRunnable(){@Overridepublicvoidrun(){logger.debug("登录其他线程");}}).start();//exit移除请求IDMDC.remove(KEY);}}代码中,我们新建了一个异步线程,并在匿名对象Runnable的run()方法中打印日志。运行main函数,可以在控制台看到如下日志输出:2018-02-1714:05:43.487{requestId=e6099c85-72be-4986-8a28-de6bb2e52b01}[main]DEBUGcn.wudashan.Main-loginmainthread2018-02-1714:05:43.490{}[Thread-1]DEBUGcn.wudashan.Main-loginotherthread不幸的是,异步线程中没有打印请求ID。这里发生了什么?要解决这个问题,我们就不得不知道MDC的实现原理。限于篇幅,这里就不详细介绍了。MDC之所以在异步线程中不生效,是因为底层使用了ThreadLocal作为数据结构。调用MDC.put()方法传入的requestID只在当前线程有效。有兴趣的朋友可以自行深挖代码细节。知道了原理,解决这个问题就很容易了。我们可以使用装饰器模式,写一个新的MDCRunnable类来装饰Runnable接口。在创建MDCRunnable类时保存当前线程的MDC值,在执行run()方法时将保存的MDC值复制到异步线程中。代码实现如下:publicclassMDCRunnableimplementsRunnable{privatefinalRunnablerunnable;私人最终Map地图;publicMDCRunnable(Runnablerunnable){this.runnable=runnable;//保存当前线程的MDC值this.map=MDC.getCopyOfContextMap();}@Overridepublicvoidrun(){//传入保存的MDC值for(Map.Entryentry:map.entrySet()){MDC.put(entry.getKey(),entry.getValue());}//装饰器模式,执行run方法runnable.run();//删除保存的MDC值for(Map.Entryentry:map.entrySet()){MDC.remove(entry.getKey());}}}接下来,我们需要对main函数中创建的Runnable实现类进行修饰:publicclassMain{privatestaticfinalStringKEY="requestId";privatestaticfinalLoggerlogger=LoggerFactory.getLogger(Main.class);privatestaticfinalExecutorServiceEXECUTOR=Executors.newSingleThreadExecutor();公共静态无效main(String[]args){//入口传入请求IDMDC.put(KEY,UUID.randomUUID().toString());//主线程打印日志logger.debug("loginmainthread");//异步线程打印日志,用MDCRunnable装饰RunnablenewThread(newMDCRunnable(newRunnable(){@Overridepublicvoidrun(){logger.debug("loginotherthread");}})).start();//异步线程池打印日志,用MDCRunnable装饰RunnableEXECUTOR.execute(newMDCRunnable(newRunnable(){@Overridepublicvoidrun(){logger.debug("登录其他线程池");}}));EXECUTOR.shutdown();//退出移除请求IDMDC.remove(KEY);}}执行main函数,会输出如下日志:2018-03-0423:44:05.343{requestId=5ee2a117-e090-41d8-977b-cef5dea09d34}[main]DEBUGcn.wudashan.Main-login主线程2018-03-0423:44:05.346{requestId=5ee2a117-e090-41d8-977b-cef5dea09d34}[Thread-1]DEBUGcn。wudashan.Main-登录其他thread2018-03-0423:44:05.347{requestId=5ee2a117-e090-41d8-977b-cef5dea09d34}[pool-2-thread-1]DEBUGcn.wudashan.Main-登录其他线程池恭喜!经过我们的努力,终于在异步线程和线程池中都打印出了requestId!3.小结本文介绍如何使用MDC工具快速过滤一个请求的所有日志,并使用装饰器模式让MDC工具在异步线程中生效。有了MDC,再用AOP技术,把requestId植入到各个环节,就可以过滤掉整个系统任何一个进程的日志。使用MDC工具可以大大节省开发自测阶段定位问题的时间,提高开发效率;在运维阶段,可以快速收集相关日志信息,加快分析速度。