摘要：當(dāng)前線程的子線程會(huì)繼承其父線程中的的內(nèi)容。若希望在線程池與主線程間傳遞，需配合和使用。

開發(fā)排查系統(tǒng)問題用得最多的手段就是查看系統(tǒng)日志，在分布式環(huán)境中一般使用ELK來統(tǒng)一收集日志，但是在并發(fā)大時(shí)使用日志定位問題還是比較麻煩，由于大量的其他用戶/其他線程的日志也一起輸出穿行其中導(dǎo)致很難篩選出指定請(qǐng)求的全部相關(guān)日志，以及下游線程/服務(wù)對(duì)應(yīng)的日志。

?

每個(gè)請(qǐng)求都使用一個(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，可以往其中添加鍵值對(duì)。MDC 中包含的內(nèi)容可以被同一線程中執(zhí)行的代碼所訪問。當(dāng)前線程的子線程會(huì)繼承其父線程中的 MDC 的內(nèi)容。當(dāng)需要記錄日志時(shí)，只需要從 MDC 中獲取所需的信息即可。MDC 的內(nèi)容則由程序在適當(dāng)?shù)臅r(shí)候保存進(jìn)去。對(duì)于一個(gè) Web 應(yīng)用來說，通常是在請(qǐng)求被處理的最開始保存這些數(shù)據(jù)。

?

由于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}

?

生成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;
    }
}

?

接收并保存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;
    }
}

注冊(cè)攔截器

public class DefaultWebMvcConfig extends WebMvcConfigurationSupport {
  @Override
  protected void addInterceptors(InterceptorRegistry registry) {
    //日志鏈路追蹤攔截器
    registry.addInterceptor(new TraceInterceptor()).addPathPatterns("/**");

    super.addInterceptors(registry);
  }
}

?

繼續(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;
    }
}

?

主要針對(duì)業(yè)務(wù)會(huì)使用線程池(異步、并行處理)，并且spring自己也有@Async注解來使用線程池，要解決這個(gè)問題需要以下兩個(gè)步驟

由于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> 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 {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        //加載TtlMDCAdapter實(shí)例
        TtlMDCAdapter.getInstance();
    }
}

?

增加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  Future submit(Callable 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  ListenableFuture submitListenable(Callable task) {
        Callable ttlCallable = TtlCallable.get(task);
        return super.submitListenable(ttlCallable);
    }
}

?

?

網(wǎng)關(guān)生成traceId值為13d9800c8c7944c78a06ce28c36de670

?

顯示的traceId與網(wǎng)關(guān)相同，這里特意模擬發(fā)生異常的場(chǎng)景

?

當(dāng)系統(tǒng)出現(xiàn)異常時(shí)，可直接通過該異常日志的traceId?的值，在日志中心中詢?cè)撜?qǐng)求的所有日志信息

?

附上我的開源微服務(wù)框架(包含本文中的代碼)，歡迎 star 關(guān)注

https://gitee.com/zlt2000/mic...