作者：朱樂陶脆诉，軟件架構(gòu)師，具備多年Java開發(fā)及架構(gòu)設(shè)計(jì)經(jīng)驗(yàn)伐坏，擅長微服務(wù)領(lǐng)域
作者博客：https://blog.csdn.net/zlt2000
背景
開發(fā)排查系統(tǒng)問題用得最多的手段就是查看系統(tǒng)日志怔匣，在分布式環(huán)境中一般使用ELK來統(tǒng)一收集日志，但是在并發(fā)大時(shí)使用日志定位問題還是比較麻煩桦沉，由于大量的其他用戶/其他線程的日志也一起輸出穿行其中導(dǎo)致很難篩選出指定請求的全部相關(guān)日志每瞒，以及下游線程/服務(wù)對應(yīng)的日志。
解決思路
每個(gè)請求都使用一個(gè)唯一標(biāo)識(shí)來追蹤全部的鏈路顯示在日志中纯露，并且不修改原有的打印方式(代碼無入侵) 使用Logback的MDC機(jī)制日志模板中加入traceId標(biāo)識(shí)剿骨，取值方式為%X{traceId}
MDC（Mapped Diagnostic Context，映射調(diào)試上下文）是 log4j 和 logback 提供的一種方便在多線程條件下記錄日志的功能埠褪。MDC 可以看成是一個(gè)與當(dāng)前線程綁定的Map浓利，可以往其中添加鍵值對。MDC 中包含的內(nèi)容可以被同一線程中執(zhí)行的代碼所訪問钞速。當(dāng)前線程的子線程會(huì)繼承其父線程中的 MDC 的內(nèi)容贷掖。當(dāng)需要記錄日志時(shí)，只需要從 MDC 中獲取所需的信息即可渴语。MDC 的內(nèi)容則由程序在適當(dāng)?shù)臅r(shí)候保存進(jìn)去苹威。對于一個(gè) Web 應(yīng)用來說，通常是在請求被處理的最開始保存這些數(shù)據(jù)驾凶。
方案實(shí)現(xiàn)
由于MDC內(nèi)部使用的是ThreadLocal所以只有本線程才有效牙甫，子線程和下游的服務(wù)MDC里的值會(huì)丟失；所以方案主要的難點(diǎn)是解決值的傳遞問題调违，主要包括以幾下部分：
API網(wǎng)關(guān)中的MDC數(shù)據(jù)如何傳遞給下游服務(wù)
服務(wù)如何接收數(shù)據(jù)窟哺，并且調(diào)用其他遠(yuǎn)程服務(wù)時(shí)如何繼續(xù)傳遞
異步的情況下(線程池)如何傳給子線程
修改日志模板
logback配置文件模板格式添加標(biāo)識(shí)%X{traceId}
網(wǎng)關(guān)添加過濾器
生成traceId并通過header傳遞給下游服務(wù)
@Component
public class TraceFilter extends ZuulFilter {
? ? @Autowired
? ? private TraceProperties traceProperties;
? ? @Override
? ? public String filterType() {
? ? ? ? return FilterConstants.PRE_TYPE;
? ? }
? ? @Override
? ? public int filterOrder() {
? ? ? ? return FORM_BODY_WRAPPER_FILTER_ORDER - 1;
? ? }
? ? @Override
? ? public boolean shouldFilter() {
? ? ? ? //根據(jù)配置控制是否開啟過濾器
? ? ? ? return traceProperties.getEnable();
? ? }
? ? @Override
? ? public Object run() {
? ? ? ? //鏈路追蹤id
? ? ? ? String traceId = IdUtil.fastSimpleUUID();
? ? ? ? MDC.put(CommonConstant.LOG_TRACE_ID, traceId);
? ? ? ? RequestContext ctx = RequestContext.getCurrentContext();
? ? ? ? ctx.addZuulRequestHeader(CommonConstant.TRACE_ID_HEADER, traceId);
? ? ? ? return null;
? ? }
}
下游服務(wù)增加spring攔截器
接收并保存traceId的值攔截器
public class TraceInterceptor implements HandlerInterceptor {
? ? @Override
? ? public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
? ? ? ? String traceId = request.getHeader(CommonConstant.TRACE_ID_HEADER);
? ? ? ? if (StrUtil.isNotEmpty(traceId)) {
? ? ? ? ? ? MDC.put(CommonConstant.LOG_TRACE_ID, traceId);
? ? ? ? }
? ? ? ? return true;
? ? }
}
注冊攔截器
public class DefaultWebMvcConfig extends WebMvcConfigurationSupport {
? @Override
? protected void addInterceptors(InterceptorRegistry registry) {
? ? //日志鏈路追蹤攔截器
? ? registry.addInterceptor(new TraceInterceptor()).addPathPatterns("/**");
? ? super.addInterceptors(registry);
? }
}
下游服務(wù)增加feign攔截器
繼續(xù)把當(dāng)前服務(wù)的traceId值傳遞給下游服務(wù)
public class FeignInterceptorConfig {
? ? @Bean
? ? public RequestInterceptor requestInterceptor() {
? ? ? ? RequestInterceptor requestInterceptor = template -> {
? ? ? ? ? ? //傳遞日志traceId
? ? ? ? ? ? String traceId = MDC.get(CommonConstant.LOG_TRACE_ID);
? ? ? ? ? ? if (StrUtil.isNotEmpty(traceId)) {
? ? ? ? ? ? ? ? template.header(CommonConstant.TRACE_ID_HEADER, traceId);
? ? ? ? ? ? }
? ? ? ? };
? ? ? ? return requestInterceptor;
? ? }
}
解決父子線程傳遞問題
主要針對業(yè)務(wù)會(huì)使用線程池(異步、并行處理)翰萨，并且spring自己也有@Async注解來使用線程池脏答，要解決這個(gè)問題需要以下兩個(gè)步驟
重寫logback的LogbackMDCAdapter
由于logback的MDC實(shí)現(xiàn)內(nèi)部使用的是ThreadLocal不能傳遞子線程，所以需要重寫替換為阿里的TransmittableThreadLocal
TransmittableThreadLocal 是Alibaba開源的、用于解決 “在使用線程池等會(huì)緩存線程的組件情況下傳遞ThreadLocal” 問題的 InheritableThreadLocal 擴(kuò)展殖告。若希望 TransmittableThreadLocal 在線程池與主線程間傳遞阿蝶，需配合 TtlRunnable 和 TtlCallable 使用。
TtlMDCAdapter類
package org.slf4j;
import com.alibaba.ttl.TransmittableThreadLocal;
import org.slf4j.spi.MDCAdapter;
public class TtlMDCAdapter implements MDCAdapter {
? ? /**
? ? * 此處是關(guān)鍵
? ? */
? ? private final ThreadLocal<Map<String, String>> copyOnInheritThreadLocal = new TransmittableThreadLocal<>();
? ? private static TtlMDCAdapter mtcMDCAdapter;
? ? static {
? ? ? ? mtcMDCAdapter = new TtlMDCAdapter();
? ? ? ? MDC.mdcAdapter = mtcMDCAdapter;
? ? }
? ? public static MDCAdapter getInstance() {
? ? ? ? return mtcMDCAdapter;
? ? }
其他代碼與ch.qos.logback.classic.util.LogbackMDCAdapter一樣黄绩，只需改為調(diào)用copyOnInheritThreadLocal變量
TtlMDCAdapterInitializer類用于程序啟動(dòng)時(shí)加載自己的mdcAdapter實(shí)現(xiàn)
public class TtlMDCAdapterInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
? ? @Override
? ? public void initialize(ConfigurableApplicationContext applicationContext) {
? ? ? ? //加載TtlMDCAdapter實(shí)例
? ? ? ? TtlMDCAdapter.getInstance();
? ? }
}
擴(kuò)展線程池實(shí)現(xiàn)
增加TtlRunnable和TtlCallable擴(kuò)展實(shí)現(xiàn)TTL
public class CustomThreadPoolTaskExecutor extends ThreadPoolTaskExecutor {
? ? @Override
? ? public void execute(Runnable runnable) {
? ? ? ? Runnable ttlRunnable = TtlRunnable.get(runnable);
? ? ? ? super.execute(ttlRunnable);
? ? }
? ? @Override
? ? public <T> Future<T> submit(Callable<T> task) {
? ? ? ? Callable ttlCallable = TtlCallable.get(task);
? ? ? ? return super.submit(ttlCallable);
? ? }
? ? @Override
? ? public Future<?> submit(Runnable task) {
? ? ? ? Runnable ttlRunnable = TtlRunnable.get(task);
? ? ? ? return super.submit(ttlRunnable);
? ? }
? ? @Override
? ? public ListenableFuture<?> submitListenable(Runnable task) {
? ? ? ? Runnable ttlRunnable = TtlRunnable.get(task);
? ? ? ? return super.submitListenable(ttlRunnable);
? ? }
? ? @Override
? ? public <T> ListenableFuture<T> submitListenable(Callable<T> task) {
? ? ? ? Callable ttlCallable = TtlCallable.get(task);
? ? ? ? return super.submitListenable(ttlCallable);
? ? }
}
場景測試
測試代碼如下
api網(wǎng)關(guān)打印的日志
網(wǎng)關(guān)生成traceId值為13d9800c8c7944c78a06ce28c36de670
請求跳轉(zhuǎn)到文件服務(wù)時(shí)打印的日志
顯示的traceId與網(wǎng)關(guān)相同羡洁，這里特意模擬發(fā)生異常的場景
ELK聚合日志通過traceId查詢整條鏈路日志
當(dāng)系統(tǒng)出現(xiàn)異常時(shí)，可直接通過該異常日志的traceId的值爽丹，在日志中心中詢該請求的所有日志信息
源碼下載
附上我的開源微服務(wù)框架(包含本文中的代碼)筑煮，歡迎 star 關(guān)注
https://gitee.com/zlt2000/microservices-platform
源網(wǎng)絡(luò)，版權(quán)歸原創(chuàng)者所有粤蝎。如有侵權(quán)煩請告知真仲，我們會(huì)立即刪除并表示歉意。
更多技術(shù)初澎，歡迎關(guān)注下方公眾號(hào)
