这篇文章给大家聊聊关于微服务日志链路追踪实践，以及对应的知识点，希望对各位有所帮助，不要忘了收藏本站哦。

最近想在项目中添加一个简单的分布式请求跟踪功能，从前端向网关发起请求，然后从网关调用Spring Cloud的微服务。在这些过程中，我希望从日志中看到一个分布式的ID链接，通过请求的ID可以追踪整个链接，方便排查问题。

[[378163]]

现成的解决方案自然是使用SkyWalking、Spring Cloud Sleuth、Zipkin等组件。但考虑到主要目的是记录一个可以在整个每个服务中使用的ID，以方便日志查询，所以不想引入太多复杂的组件，最终决定通过MDC在日志中输出追踪到的ID，以及然后在Feign和RestTemplate中传递微服务中的请求ID。

主要包括几个步骤：

前端生成请求ID，并将请求头添加到网关。通过WebFilter拦截并添加到MDC中。将其输出到日志中。将请求ID放入Feign和RequestTemplate中，并带到HTTP的头部。微服务交付。每个微服务也是通过WebFilter来实现的。拦截并添加MDC，并在日志中输出MDC。 MDC（Mapped Diagnostic Context，映射调试上下文）是Log4j和Logback提供的功能，方便多线程情况下进行日志记录。 MDC可以看成是绑定到当前线程的哈希表，可以向其中添加键值对。

MDC的关键操作：

将值设置为MDC：MDC.put(key, value);从MDC获取值：MDC.get(key);将MDC的内容打印到日志中：%X{key}新增 TraceId 工具类首先添加一个TraceIdUtils工具类，用于定义TRACE_ID的常量值以及设置和生成TRACE_ID的方法。后续所有的代码操作都是通过这个估计类来进行的。

importorg.apache.commons.lang.RandomStringUtils;importorg.apache.commons.lang.StringUtils;importorg.slf4j.MDC;publicclassTraceIdUtils{publicstaticfinalStringTRACE_ID='traceId';privatestaticfinalintMAX_ID_LENGTH=10;/***生成traceId*/privatestaticStringgenTraceId(){ returnRandomStringUtils.randomAlphanumeric(MAX_ID_LENGTH);}/***设置traceId*/publicstaticvoidsetTraceId(StringtraceId){//如果参数为空则生成新的IDtraceId=StringUtils.isBlank(traceId)?genTraceId():traceId;//放入traceId前往MDC MDC.put(TRACE_ID,StringUtils.substring(traceId,-MAX_ID_LENGTH));}/***获取traceId*/publicstaticStringgetTraceId(){//获取StringtraceId=MDC.get(TRACE_ID);//如果traceId为空的话，生成一个新的ID returnStringUtils.isBlank(traceId)?genTraceId():traceId;}}通过 WebFilter 添加 TraceId 过滤器添加GenericFilterBean，从请求头中获取TraceIdUtils.TRACE_ID对应的值。该值在前端发起请求时或者微服务之间使用。将被传递，如果没有，TraceIdUtils.setTraceId 将生成一个。

importorg.springframework.core.annotation.Order;importorg.springframework.web.filter.GenericFilterBean;@WebFilter(urlPatterns='/*',filterName='traceIdFilter')Order(1)publicclassTraceIdFilterextendsGenericFilterBean{@OverridepublicvoiddoFilter(ServletRequestrequest,ServletResponseresponse,FilterChainfil terChain ; }不要忘记添加@ServletComponentScan注解到SpringBoot启动类，否则自定义的Filter不会生效其中“com.yourtion.trace.filter”为TraceIdFilter所在的包名。

@ServletComponentScan(basePackages='com.yourtion.trace.filter')@SpringBootApplicationpublicclassMyApplication{publicstaticvoidmain(String[]args){SpringApplication.run(MyApplication.class,args);}}在 Feign 上添加 TraceId因为@FeignClient的代理类是执行时，您将使用使用Spring上下文的RequestInterceptor，因此您自定义自己的拦截器，然后将其注入到Spring上下文中，这样您就可以在请求上下文中添加自定义请求头。

导入feign.requestInterceptor;导入feign.requestTemplate； Importorg.s PlementsRequestInterceptor {@OverridePublicvoidApply(RequestTemplateTemplate){template.header(traceidutils.trace_id,traceidutils.get Traceid());}}在 RestTemplate 上添加 TraceId和部分请求是通过RestTemplate 发起的。之前我们自己实现了RestTemplateConfig的配置类。这次我们在相关配置中添加了以下内容：

RestTemplaterestTemplate=builder.additionalInterceptors((request,body,execution)-{request.getHeaders().add(TraceIdUtils.TRACE_ID,TraceIdUtils.getTraceId());returnexecution.execute(request,body);}).build();至此，链接上TraceId的添加已经完成，剩下的就是在日志中打印出来了。

修改Log4j2的布局格式

修改日志的布局格式，打印出MDC中的traceId：

--原始格式--'%5p%c:%L-%m%throwable{separator(--)}%n'/--增加traceId的格式--'%5ptraceId:%X{traceId}%c:%L - %m%throwable{separator(--)}%n'/至此，修改完成。

好了，本文到此结束，如果可以帮助到大家，还望关注本站哦！