SpringBoot利用MDC機(jī)制過濾單次請(qǐng)求的所有日志

更新時(shí)間：2024年04月15日 09:50:51 作者：牽著貓散步的鼠鼠

在服務(wù)出現(xiàn)故障時(shí),我們經(jīng)常需要獲取一次請(qǐng)求流程里的所有日志進(jìn)行定位 ,如何將一次數(shù)據(jù)上報(bào)請(qǐng)求中包含的所有業(yè)務(wù)日志快速過濾出來,就是本文要介紹的,需要的朋友可以參考下

1.前言

在服務(wù)出現(xiàn)故障時(shí)，我們經(jīng)常需要獲取一次請(qǐng)求流程里的所有日志進(jìn)行定位。如果請(qǐng)求只在一個(gè)線程里處理，則我們可以通過線程ID來過濾日志，但如果請(qǐng)求包含異步線程的處理，那么光靠線程ID就顯得捉襟見肘了。

比如華為IoT平臺(tái)，提供了接收設(shè)備上報(bào)數(shù)據(jù)的能力，當(dāng)數(shù)據(jù)到達(dá)平臺(tái)后，平臺(tái)會(huì)進(jìn)行一些復(fù)雜的業(yè)務(wù)邏輯處理，如數(shù)據(jù)存儲(chǔ)，規(guī)則引擎，數(shù)據(jù)推送，命令下發(fā)等等。由于這個(gè)邏輯之間沒有強(qiáng)耦合的關(guān)系，所以通常是異步處理。

如何將一次數(shù)據(jù)上報(bào)請(qǐng)求中包含的所有業(yè)務(wù)日志快速過濾出來，就是本文要介紹的。

2.MDC 是什么

SLF4J MDC（Mapped Diagnostic Context）是一個(gè)用于日志記錄的實(shí)用工具，它提供了線程級(jí)別的日志上下文信息管理功能。SLF4J（Simple Logging Facade for Java）本身是一個(gè)抽象層，允許我們?cè)谑褂貌煌娜罩究蚣埽ㄈ鏻og4j, logback等），而MDC是SLF4J的一部分，主要在logback和log4j中使用。

MDC允許我們?cè)谝粋€(gè)線程的執(zhí)行上下文中設(shè)置和獲取鍵值對(duì)。這些鍵值對(duì)在日志輸出中可以以占位符的形式被引用，從而在日志信息中輸出這些上下文信息。這特別有用，例如，在Web應(yīng)用中跟蹤用戶請(qǐng)求，或者在分布式系統(tǒng)中跟蹤跨服務(wù)的事務(wù)。

在設(shè)置和清除MDC數(shù)據(jù)時(shí)，通常使用put和remove方法，如：

MDC.put("requestId", "12345");
// ... logging statements ...
MDC.remove("requestId");

這樣，日志框架在記錄日志時(shí)，就可以在日志格式中包含這個(gè)requestId的值。

3.代碼實(shí)戰(zhàn)

通過上門的介紹你可能還是有點(diǎn)難理解，我們可以先實(shí)戰(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) {
 
        // 入口傳入請(qǐng)求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");
 
        // 出口移除請(qǐng)求ID
        MDC.remove(KEY);
 
    }
 
}

我們?cè)趍ain函數(shù)的入口調(diào)用MDC.put()方法傳入請(qǐng)求ID，在出口調(diào)用MDC.remove()方法移除請(qǐng)求ID。配置好log4j2.xml 文件后，運(yùn)行main函數(shù)，可以在控制臺(tái)看到以下日志輸出：

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

從日志中可以明顯地看到花括號(hào)中包含了（映射的）請(qǐng)求ID(requestId)，這其實(shí)就是我們定位（診斷）問題的關(guān)鍵字（上下文）。

有了MDC工具，只要在接口或切面植入put()和remove()代碼，在為服務(wù)定位問題時(shí)，我們就可以通過grep requestId=xxx *.log快速的過濾出某次請(qǐng)求的所有日志。

然而，MDC工具真的有我們所想的這么方便嗎？

回到我們開頭，一次請(qǐng)求可能涉及多線程異步處理，那么在多線程異步的場(chǎng)景下，它是否還能正常運(yù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) {
 
        // 入口傳入請(qǐng)求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();
 
        // 出口移除請(qǐng)求ID
        MDC.remove(KEY);
 
    }
 
}

代碼里我們新起了一個(gè)異步線程，并在匿名對(duì)象Runnable的run()方法打印日志。運(yùn)行main函數(shù)，可以在控制臺(tái)看到以下日志輸出：

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

不幸的是，請(qǐng)求ID在異步線程里不打印了。

這是怎么回事呢？要解決這個(gè)問題，我們就得知道MDC的實(shí)現(xiàn)原理。

由于篇幅有限，這里就暫不詳細(xì)介紹，MDC之所以在異步線程中不生效是因?yàn)榈讓硬捎肨hreadLocal 作為數(shù)據(jù)結(jié)構(gòu)，我們調(diào)用MDC.put()方法傳入的請(qǐng)求ID只在當(dāng)前線程有效。

知道了原理那么解決這個(gè)問題就輕而易舉了，我們可以使用裝飾器模式，新寫一個(gè)MDCRunnable類對(duì)Runnable接口進(jìn)行一層裝飾。

在創(chuàng)建MDCRunnable類時(shí)保存當(dāng)前線程的MDC值，在執(zhí)行run()方法時(shí)再將保存的MDC值拷貝到異步線程中去。代碼實(shí)現(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());
        }
    }
    
}

接著，我們需要對(duì)main函數(shù)里創(chuàng)建的Runnable實(shí)現(xiàn)類進(jì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) {
 
        // 入口傳入請(qǐng)求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>，用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();
 
        // 出口移除請(qǐng)求ID
        MDC.remove(KEY);
 
    }
 
}

執(zhí)行main函數(shù)，將會(huì)輸出以下日志：

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打印了！

4.總結(jié)

本文講述了如何使用MDC工具來快速過濾一次請(qǐng)求的所有日志，并通過裝飾器模式使得MDC工具在異步線程里也能生效。利用MDC，再配合AOP技術(shù)對(duì)所有的切面植入requestId，就可以將整個(gè)系統(tǒng)的任意流程的日志過濾出來。使用MDC工具，在開發(fā)自測(cè)階段，可以極大地節(jié)省定位問題的時(shí)間，提升開發(fā)效率；在運(yùn)維維護(hù)階段，可以快速地收集相關(guān)日志信息，加快分析速度。

以上就是SpringBoot利用MDC機(jī)制過濾單次請(qǐng)求的所有日志的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot MDC過濾請(qǐng)求日志的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: