背景

在目前的Java web應用或者RPC應用中，當應用發生異常時，我們很難知道這些異常資訊到底是從哪發生(起點)，到哪結束(終點)，在一個日誌檔案中，哪條日誌資訊是發生異常的使用者產生的？在什麼時候發生的異常？我們想要定位這些的時候，發現並不是很容易，因為沒有一個唯一的識別符號，能從使用者的請求到響應這一個完整的過程給串聯起來。那麼鑑於這種情況，我們就需要一個能夠記錄使用者請求一進來就產生的id，當用戶請求完成之後，將這個id移除。這個id下文統稱reqId。

本文將簡述怎麼利用logback或者log4j實現請求id的埋點和基於http協議不同系統之間請求id的傳遞，以及最後的小實戰展示一下效果。

針對主流的APM軟體，大多數會存在traceId和spanId這種概念，這裡的reqId類似traceId

目前主流APM監控軟體

在有現成的輪子的情況下，其實我一般是不會重新造輪子，除非這個輪子不好用，一個半掛車的輪子安裝在自行車上很顯然是不合適的，不過，還是介紹下一些開源的輪子。

市面上大多數輪子都是基於谷歌的Dapper論文而實現的，而且還有不少是基於OpenTracing規範實現的，例如

• Zipkin
• Skywalking
• Cat
• Pinpoint

等等，其實還有其他的，這裡就不一一列舉了。這些軟體都很優秀，只是個人覺得，目前的應用場景還不是很適合使用這些這麼大的輪子，要不然我這破自行車裝這麼些個輪子，會顯得很突兀的。那麼針對自行車，要怎麼造一個比較合適自行車的輪子呢？

MDC介紹

在網上一搜MDC會出現很多相關的介紹，這裡只是簡單介紹一下，如果有需要，請自行百度吧。

MDC據我瞭解，在Log4j/slf4j都有支援，其底層實際上是使用了ThreadLocal，保證同一個執行緒內，這個reqId都是唯一的。只要是在同一個執行緒內打的日誌，其reqId都會被打印出來(通過配置logger patten %X{reqId})。

如何進行埋點和分散式支援？

上面簡單介紹了一下MDC，那麼在何時埋點才比較合適呢？接下來簡單說下SpringMVC和Servlet的埋點。然後再談一談怎麼在分散式中實現！

如何埋點

SpringMVC中的埋點

不管是SpringMVC應用還是SpringBoot應用，這裡都是一樣的，就一般情況而言，埋點都會在請求進來的時候埋下，請求結束的時候移除(避免記憶體洩漏)，在SpringMVC系的應用裡面，可以使用Interceptor

攔截器來實現這個功能，主要程式碼如下所示

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String reqId = IdUtil.objectId();
        MDC.put(Constants.REQ_ID_KEY, reqId);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 從MDC移除請求id
        MDC.remove(Constants.REQ_ID_KEY);
    }
}

值得注意的是，這個攔截器的執行順序應該儘量靠前，這樣在其他攔截器裡面發生的異常資訊也可以通過這個埋點進行追蹤。

Servlet中的埋點

在Servlet應用中，或者基於Servelt的應用中，都可以通過Filter來實現埋點這個操作，原理也是請求進來的時候將請求id進行埋點，請求結束的時候，從MDC移除這個請求id。下面看下在過濾器裡頭如何實現。

public class LogFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
         // 請求前，設定reqId到MDC
         String reqId = IdUtil.objectId();
         MDC.put(Constants.REQ_ID_KEY, reqId);
         chain.doFilter(request, response);
         // 從MDC移除reqId
         MDC.remove(Constants.REQ_ID_KEY);
    }
}

可以看到，其實不管是SpringMVC還是原生的Servlet Filter，都很簡單就實現了埋點這個動作。而且原理都是一樣的。

其實在SpringMVC內，如果是5以前，用的是webmvc的包，底層也是走Servlet，所有請求都是經過DispatchServlet這個Servlet進入，那麼一樣可以使用Filter來埋點！如果用的是webflux那就不能直接用Filter來埋點了。

如何在不同系統之間傳遞reqId?

現在假定這麼一種情況，如果同一家公司的不同系統之間，都採用統一的通訊協議以及序列化協議來實現，例如統一採用dubbo的rpc實現，或者統一基於http+json的形式。下面以比較簡單的http+json+springmvc來舉例子，如果採用其他mvc框架也是大同小異的。

在上述的埋點例子中，我們是在基於攔截器進行埋點進去，那麼當前請求是否是整個分散式請求鏈中的第一環呢？為了區分到底是不是第一個環(也就是最先接收到請求的那個環節)，我們約定，如果請求頭中，帶有x-forward-reqId的都不是第一環。那麼埋點的程式碼可以改寫成如下的樣子

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 針對分散式情況，先從header嘗試獲取reqId，如果獲取不到，則有可能是從當前服務開始發起呼叫的
        String reqId = request.getHeader(Constants.X_FORWARD_REQ_ID);
        if (StrUtil.isBlank(reqId)) {
            // 生成請求id並加入MDC
            reqId = IdUtil.objectId();
        }
        MDC.put(Constants.REQ_ID_KEY, reqId);
        return true;
    }

埋點的時候，先獲取請求頭是否有x-forward-reqId，如果有，則不再重新生成reqId，繼續沿用傳遞過來的reqId。那麼現在問題來了，怎麼將這個請求頭傳遞過去其他系統呢？下面舉例說明一下。

對於一般的http請求而言，大多數使用的客戶端都是httpclient、okhttp、httpurlconnection等，然而不同的情況配置不大相同，這裡也沒有辦法一一列舉出來。下面對筆者遇到過的幾種情況做出簡要分析，僅供參考：

• 如果採取的是使用zuul等作為閘道器的話，基本不用怎麼設定，請求經過閘道器之後，就生成reqId，從閘道器傳遞下去即可，因為其他系統的請求也會經過閘道器。
• 如果直接使用http客戶端對其他系統做呼叫，不管採用的是httpclient還是okhttp，皆可做全域性全域性配置，即構造一個HttpReqProxy的物件，在Proxy物件裡面將獲取到的請求頭設定進去，方便傳遞。
• 採用Spring的RestTemplate，這種時候可以編寫一個工具類，在工具類內注入RestTemplate或者new一個RestTemplate，然後通過HttpServletRequest request =((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest(); 獲取到request物件，從而獲取請求頭設定到RestTemplate中。

到此，就介紹完如何埋點到MDC，又如何利用請求頭進行傳遞reqId到其他系統中去。這裡只是給出一種思路，是一種很輕量級的解決方案，如果是比較大型的系統，還是建議使用類似zipkin這樣的完備的產品做追蹤。

Skywalking和zipkin目前都比較成熟，可以使用在大型專案中，只是說一些較為簡單的單體應用或者並不希望引入如此龐大的依賴的分散式應用可以考慮此種思路。該思路較為簡單，功能上也較為單一

小實戰

其實也算不上什麼實戰吧，本人之前寫過一篇部落格，《springboot2+logback將日誌輸出到oracle資料庫的踩坑之旅》介紹了怎麼使用logback將日誌存放到資料庫中，那麼我們加入到MDC的值也一併會被記錄進去，正是利用這個特性，可以將多個不同的系統的logback的DBAppender的資料庫連線指向同一個資料庫，那麼在資料庫裡面，就可以通過reqId查詢出對應的logger記錄，每條logger對應有其自己的eventid,根據這個可以查詢出對應的異常堆疊了。

以下貼出本人實現的截圖

檢視堆疊

相關推薦