Spring?Boot快速過濾出一次請求的所有日志
出現(xiàn)故障時,我們經(jīng)常需要獲取一次請求流程里的所有日志進行定位。
如果請求只在一個線程里處理,則我們可以通過線程ID來過濾日志,但如果請求包含異步線程的處理,那么光靠線程ID就顯得捉襟見肘了。
華為IoT平臺,提供了接收設(shè)備上報數(shù)據(jù)的能力, 當(dāng)數(shù)據(jù)到達平臺后,平臺會進行一些復(fù)雜的業(yè)務(wù)邏輯處理,如數(shù)據(jù)存儲,規(guī)則引擎,數(shù)據(jù)推送,命令下發(fā)等等。由于這個邏輯之間沒有強耦合的關(guān)系,所以通常是異步處理。如何將一次數(shù)據(jù)上報請求中包含的所有業(yè)務(wù)日志快速過濾出來,就是本文要介紹的。
1、正文
SLF4J日志框架提供了一個MDC(Mapped Diagnostic Contexts)工具類,谷歌翻譯為映射的診斷上下文 ,從字面上很難理解,我們可以先實戰(zhàn)一把。
public?class?Main?{ ????private?static?final?String?KEY?=?"requestId"; ????private?static?final?Logger?logger?=?LoggerFactory.getLogger(Main.class); ???? ????public?static?void?main(String[]?args)?{ ????????//?入口傳入請求ID ????????MDC.put(KEY,?UUID.randomUUID().toString()); ???????? ????????//?打印日志 ????????logger.debug("log?in?main?thread?1"); ????????logger.debug("log?in?main?thread?2"); ????????logger.debug("log?in?main?thread?3"); ????????//?出口移除請求ID ????????MDC.remove(KEY); ????} }
我們在main函數(shù)的入口調(diào)用MDC.put()
方法傳入請求ID,在出口調(diào)用MDC.remove()
方法移除請求ID。配置好log4j2.xml 文件后,運行main函數(shù),可以在控制臺看到以下日志輸出:
2018-02-17 13:19:52.606 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 1
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 2
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 3
從日志中可以明顯地看到花括號中包含了 (映射的)請求ID(requestId),這其實就是我們定位(診斷)問題的關(guān)鍵字(上下文) 。有了MDC工具,只要在接口或切面植入put()
和remove()
代碼,在現(xiàn)網(wǎng)定位問題時,我們就可以通過grep requestId=xxx *.log
快速的過濾出某次請求的所有日志。
2、進階
然而,MDC工具真的有我們所想的這么方便嗎?回到我們開頭,一次請求可能涉及多線程異步處理,那么在多線程異步的場景下,它是否還能正常運作呢?Talk is cheap, show me the code。
public?class?Main?{ ????private?static?final?String?KEY?=?"requestId"; ????private?static?final?Logger?logger?=?LoggerFactory.getLogger(Main.class); ????public?static?void?main(String[]?args)?{ ????????//?入口傳入請求ID ????????MDC.put(KEY,?UUID.randomUUID().toString()); ????????//?主線程打印<font?style="color:?#1e6bb8;word-wrap:?break-word;font-weight:?bold;border-bottom:?1px?solid">日志</font> ????????logger.debug("log?in?main?thread"); ????????//?異步線程打印<font?style="color:?#1e6bb8;word-wrap:?break-word;font-weight:?bold;border-bottom:?1px?solid">日志</font> ????????new?Thread(new?Runnable()?{ ????????????@Override ????????????public?void?run()?{ ????????????????logger.debug("log?in?other?thread"); ????????????} ????????}).start(); ????????//?出口移除請求ID ????????MDC.remove(KEY); ????} }
代碼里我們新起了一個異步線程,并在匿名對象Runnable的run()方法打印日志。運行main函數(shù),可以在控制臺看到以下日志輸出:
2018-02-17 14:05:43.487 {requestId=e6099c85-72be-4986-8a28-de6bb2e52b01} [main] DEBUG cn.wudashan.Main - log in main thread
2018-02-17 14:05:43.490 {} [Thread-1] DEBUG cn.wudashan.Main - log in other thread
不幸的是,請求ID在異步線程里不打印了。這是怎么回事呢?
要解決這個問題,我們就得知道MDC的實現(xiàn)原理。由于篇幅有限,這里就暫不詳細介紹,MDC之所以在異步線程中不生效是因為底層采用ThreadLocal 作為數(shù)據(jù)結(jié)構(gòu),我們調(diào)用MDC.put()
方法傳入的請求ID只在當(dāng)前線程有效。
感興趣的小伙伴可以自己深入一下代碼細節(jié)。
知道了原理那么解決這個問題就輕而易舉了,我們可以使用裝飾器模式 ,新寫一個MDCRunnable類
對Runnable接口
進行一層裝飾。
在創(chuàng)建MDCRunnable類
時保存當(dāng)前線程的MDC值,在執(zhí)行run()
方法時再將保存的MDC值拷貝到異步線程中去。
代碼實現(xiàn)如下:
public?class?MDCRunnable?implements?Runnable?{ ????private?final?Runnable?runnable; ????private?final?Map<String,?String>?map; ????public?MDCRunnable(Runnable?runnable)?{ ????????this.runnable?=?runnable; ????????//?保存當(dāng)前線程的MDC值 ????????this.map?=?MDC.getCopyOfContextMap(); ????} ????@Override ????public?void?run()?{ ????????//?傳入已保存的MDC值 ????????for?(Map.Entry<String,?String>?entry?:?map.entrySet())?{ ????????????MDC.put(entry.getKey(),?entry.getValue()); ????????} ????????//?裝飾器模式,執(zhí)行run方法 ????????runnable.run(); ????????//?移除已保存的MDC值 ????????for?(Map.Entry<String,?String>?entry?:?map.entrySet())?{ ????????????MDC.remove(entry.getKey()); ????????} ????} }
接著,我們需要對main函數(shù)里創(chuàng)建的Runnable實現(xiàn)類進行裝飾:
public?class?Main?{ ????private?static?final?String?KEY?=?"requestId"; ????private?static?final?Logger?logger?=?LoggerFactory.getLogger(Main.class); ????private?static?final?ExecutorService?EXECUTOR?=?Executors.newSingleThreadExecutor(); ????public?static?void?main(String[]?args)?{ ????????//?入口傳入請求ID ????????MDC.put(KEY,?UUID.randomUUID().toString()); ????????//?主線程打印日志 ????????logger.debug("log?in?main?thread"); ????????//?異步線程打印日志,用MDCRunnable裝飾Runnable ????????new?Thread(new?MDCRunnable(new?Runnable()?{ ????????????@Override ????????????public?void?run()?{ ????????????????logger.debug("log?in?other?thread"); ????????????} ????????})).start(); ????????//?異步線程池打印日志,用MDCRunnable裝飾Runnable ????????EXECUTOR.execute(new?MDCRunnable(new?Runnable()?{ ????????????@Override ????????????public?void?run()?{ ????????????????logger.debug("log?in?other?thread?pool"); ????????????} ????????})); ????????EXECUTOR.shutdown(); ????????//?出口移除請求ID ????????MDC.remove(KEY); ????} }
執(zhí)行main函數(shù),將會輸出以下日志:
2018-03-04 23:44:05.343 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [main] DEBUG cn.wudashan.Main - log in main thread
2018-03-04 23:44:05.346 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [Thread-1] DEBUG cn.wudashan.Main - log in other thread
2018-03-04 23:44:05.347 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [pool-2-thread-1] DEBUG cn.wudashan.Main - log in other thread pool
Congratulations! 經(jīng)過我們的努力,最終在異步線程和線程池中都有requestId打印了!
3、總結(jié)
本文講述了如何使用MDC工具來快速過濾一次請求的所有日志,并通過裝飾器模式使得MDC工具在異步線程里也能生效。
有了MDC,再通過AOP技術(shù)對所有的切面植入requestId,就可以將整個系統(tǒng)的任意流程的日志過濾出來。
使用MDC工具,在開發(fā)自測階段,可以極大地節(jié)省定位問題的時間,提升開發(fā)效率;在運維維護階段,可以快速地收集相關(guān)日志信息,加快分析速度。
到此這篇關(guān)于Spring Boot快速過濾出一次請求的所有日志的文章就介紹到這了,更多相關(guān)Spring Boot過濾日志內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
mybatis插件優(yōu)雅實現(xiàn)字段加密的示例代碼
在很多時候,我們都需要字段加密,比如郵箱,密碼,電話號碼等,本文主要介紹了mybatis插件優(yōu)雅實現(xiàn)字段加密的示例代碼,感興趣的可以了解一下2023-11-11Intellij Idea 多模塊Maven工程中模塊之間無法相互引用問題
這篇文章主要介紹了Intellij Idea 多模塊Maven工程中模塊之間無法相互引用問題,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01