Spring Boot 之 MDC 实现全链路调用日志跟踪
通过本文将了解到什么是MDC、MDC应用中存在的问题、如何解决存在的问题
MDC介绍
简介:
MDC(Mapped Diagnostic Context,映射调试上下文)是 log4j 、logback及log4j2 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时,只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说,通常是在请求被处理的最开始保存这些数据
API说明:
clear() => 移除所有MDC
get (String key) => 获取当前线程MDC中指定key的值
getContext() => 获取当前线程MDC的MDC
put(String key, Object o) => 往当前线程的MDC中存入指定的键值对
remove(String key) => 删除当前线程MDC中指定的键值对
优点:
代码简洁,日志风格统一,不需要在log打印中手动拼写traceId,即LOGGER.info("traceId:{} ", traceId)
暂时只能想到这一点
MDC使用
添加拦截器
public class LogInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {//如果有上层调用就用上层的IDString traceId = request.getHeader(Constants.TRACE_ID);if (traceId == null) {traceId = TraceIdUtil.getTraceId();}MDC.put(Constants.TRACE_ID, traceId);return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception {}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception {//调用结束后删除MDC.remove(Constants.TRACE_ID);}
}
修改日志格式
<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>
重点是%X{traceId},traceId和MDC中的键名称一致
简单使用就这么容易,但是在有些情况下traceId将获取不到
MDC 存在的问题
子线程中打印日志丢失traceId
HTTP调用丢失traceId
丢失traceId的情况,来一个再解决一个,绝不提前优化
解决MDC存在的问题
子线程日志打印丢失traceId
子线程在打印日志的过程中traceId将丢失,解决方式为重写线程池,对于直接new创建线程的情况不考虑【实际应用中应该避免这种用法】,重写线程池无非是对任务进行一次封装
线程池封装类:ThreadPoolExecutorMdcWrapper.java
public class ThreadPoolExecutorMdcWrapper extends ThreadPoolExecutor {public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,BlockingQueue<Runnable> workQueue) {super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue);}public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory) {super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory);}public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,BlockingQueue<Runnable> workQueue, RejectedExecutionHandler handler) {super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, handler);}public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory,RejectedExecutionHandler handler) {super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory, handler);}@Overridepublic void execute(Runnable task) {super.execute(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));}@Overridepublic <T> Future<T> submit(Runnable task, T result) {return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()), result);}@Overridepublic <T> Future<T> submit(Callable<T> task) {return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));}@Overridepublic Future<?> submit(Runnable task) {return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));}
}
说明:
继承ThreadPoolExecutor类,重新执行任务的方法
通过ThreadMdcUtil对任务进行一次包装
线程traceId封装工具类:ThreadMdcUtil.java
public class ThreadMdcUtil {public static void setTraceIdIfAbsent() {if (MDC.get(Constants.TRACE_ID) == null) {MDC.put(Constants.TRACE_ID, TraceIdUtil.getTraceId());}}public static <T> Callable<T> wrap(final Callable<T> callable, final Map<String, String> context) {return () -> {if (context == null) {MDC.clear();} else {MDC.setContextMap(context);}setTraceIdIfAbsent();try {return callable.call();} finally {MDC.clear();}};}public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {return () -> {if (context == null) {MDC.clear();} else {MDC.setContextMap(context);}setTraceIdIfAbsent();try {runnable.run();} finally {MDC.clear();}};}
}
说明【以封装Runnable为例】:
判断当前线程对应MDC的Map是否存在,存在则设置
设置MDC中的traceId值,不存在则新生成,针对不是子线程的情况,如果是子线程,MDC中traceId不为null
执行run方法
代码等同于以下写法,会更直观
public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {return new Runnable() {@Overridepublic void run() {if (context == null) {MDC.clear();} else {MDC.setContextMap(context);}setTraceIdIfAbsent();try {runnable.run();} finally {MDC.clear();}}};}
重新返回的是包装后的Runnable,在该任务执行之前【runnable.run()】先将主线程的Map设置到当前线程中【 即MDC.setContextMap(context)】,这样子线程和主线程MDC对应的Map就是一样的了
HTTP调用丢失traceId
在使用HTTP调用第三方服务接口时traceId将丢失,需要对HTTP调用工具进行改造,在发送时在request header中添加traceId,在下层被调用方添加拦截器获取header中的traceId添加到MDC中
HTTP调用有多种方式,比较常见的有HttpClient、OKHttp、RestTemplate,所以只给出这几种HTTP调用的解决方式
HttpClient:
实现HttpClient拦截器
public class HttpClientTraceIdInterceptor implements HttpRequestInterceptor {@Overridepublic void process(HttpRequest httpRequest, HttpContext httpContext) throws HttpException, IOException {String traceId = MDC.get(Constants.TRACE_ID);//当前线程调用中有traceId,则将该traceId进行透传if (traceId != null) {//添加请求体httpRequest.addHeader(Constants.TRACE_ID, traceId);}}
}
实现HttpRequestInterceptor接口并重写process方法
如果调用线程中含有traceId,则需要将获取到的traceId通过request中的header向下透传下去
为HttpClient添加拦截器
private static CloseableHttpClient httpClient = HttpClientBuilder.create().addInterceptorFirst(new HttpClientTraceIdInterceptor())
通过addInterceptorFirst方法为HttpClient添加拦截器
OKHttp:
实现OKHttp拦截器
public class OkHttpTraceIdInterceptor implements Interceptor {@Overridepublic Response intercept(Chain chain) throws IOException {String traceId = MDC.get(Constants.TRACE_ID);Request request = null;if (traceId != null) {//添加请求体request = chain.request().newBuilder().addHeader(Constants.TRACE_ID, traceId).build();}Response originResponse = chain.proceed(request);return originResponse;}
}
实现Interceptor拦截器,重写interceptor方法,实现逻辑和HttpClient差不多,如果能够获取到当前线程的traceId则向下透传
为OkHttp添加拦截器
private static OkHttpClient client = new OkHttpClient.Builder().addNetworkInterceptor(new OkHttpTraceIdInterceptor()).build();
调用addNetworkInterceptor方法添加拦截器
RestTemplate:
实现RestTemplate拦截器
public class RestTemplateTraceIdInterceptor implements ClientHttpRequestInterceptor {@Overridepublic ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {String traceId = MDC.get(Constants.TRACE_ID);if (traceId != null) {httpRequest.getHeaders().add(Constants.TRACE_ID, traceId);}return clientHttpRequestExecution.execute(httpRequest, bytes);}
}
实现ClientHttpRequestInterceptor接口,并重写intercept方法,其余逻辑都是一样的不重复说明
为RestTemplate添加拦截器
restTemplate.setInterceptors(Arrays.asList(new RestTemplateTraceIdInterceptor()));
调用setInterceptors方法添加拦截器
第三方服务拦截器:
HTTP调用第三方服务接口全流程traceId需要第三方服务配合,第三方服务需要添加拦截器拿到request header中的traceId并添加到MDC中
public class LogInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {//如果有上层调用就用上层的IDString traceId = request.getHeader(Constants.TRACE_ID);if (traceId == null) {traceId = TraceIdUtils.getTraceId();}MDC.put("traceId", traceId);return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception {}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception {MDC.remove(Constants.TRACE_ID);}
}
说明:
先从request header中获取traceId
从request header中获取不到traceId则说明不是第三方调用,直接生成一个新的traceId
将生成的traceId存入MDC中
除了需要添加拦截器之外,还需要在日志格式中添加traceId的打印,如下:
<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>
需要添加%X{traceId}
记得点「赞」和「在看」↓
爱你们
Spring Boot 之 MDC 实现全链路调用日志跟踪相关推荐
- Spring Boot + MDC 实现全链路调用日志跟踪
写在前面 通过本文将了解到什么是MDC.MDC应用中存在的问题.如何解决存在的问题 MDC介绍 简介: MDC(Mapped Diagnostic Context,映射调试上下文)是 log4j .l ...
- Spring Boot + MDC 实现全链路调用日志跟踪,这才叫优雅!
欢迎关注方志朋的博客,回复"666"获面试宝典 1.简介: MDC(Mapped Diagnostic Context,映射调试上下文)是 log4j .logback及log4j ...
- SpringBoot+MDC实现全链路调用日志跟踪,这才叫优雅!
[文章来源]https://sourl.cn/WbZ9W8 之前有一篇文章简单的介绍过MDC,这次结合具体的案例.生产中的具体问题深入了解一下MDC. MDC 介绍 1.简介: MDC(Mapped ...
- SpringBoot中如何实现全链路调用日志跟踪?这方法才优雅!
点击关注公众号,实用技术文章及时了解 来源:juejin.cn/post/6844904101483020295 写在前面 通过本文将了解到什么是MDC.MDC应用中存在的问题.如何解决存在的问题 M ...
- 基于Spring Aop及log4j2的MDC实现全链路调用跟踪(traceid)
环境: Springboot:2.2.3.RELEASE Spring-boot-starter-log4j2: 2.2.2.RELEASE jdk:1.8 目标: 实现Springboot框架下的全 ...
- 解决spring boot logging在两个目录生成日志文件且max-history不生效
解决spring boot logging在两个目录生成日志文件且max-history不生效 文章目录 解决spring boot logging在两个目录生成日志文件且max-history不生效 ...
- Spring Boot 中使用@Async实现异步调用,加速任务执行!
欢迎关注方志朋的博客,回复"666"获面试宝典 什么是"异步调用"?"异步调用"对应的是"同步调用",同步调用指程序按照 ...
- 13、Nepxion Discovery 之 全链路调用链监控
在进行微服务调用的时候,为了系统的高可用性,不仅需要进行灰度发布验证服务的可用性.同时对于服务健康的监控也是很重要的一环.Nepxion Discovery 在这方面也有监控方面的集成,包含以下几个方 ...
- Spring Cloud 微服务架构全链路实践
阅读目录: 1. 网关请求流程 2. Eureka 服务治理 3. Config 配置中心 4. Hystrix 监控 5. 服务调用链路 6. ELK 日志链路 7. 统一格式返回 Java 微服务 ...
最新文章
- 服务应该去版本化,不管是微服务还是SOA
- NLP≠NLU,机器学习无法理解人类语言
- 情人节微信红包数据公布,你离海王与海后有多远...
- 牛顿法求根号数(Python)
- Oracle spatial 周边查询SQL
- centos7下tomcat7 或tomcat8启动超慢原因
- 直播实录 | AlphaGo Zero是如何实现无师自通的?
- 人民币贬值会让八类人损失惨重!有你吗?
- 神经网络-损失函数:
- Video视频背景设计企业模板
- 香港mtmit真皮休闲商务双用时尚浮点手拿包1018 烟灰色-大号 均码【图片 价格 品牌 报价】-京东商城...
- angularjs的三种注入方式
- html5-table布局
- java执行脚本命令 学习笔记
- java分布式开发流程,面试建议
- 第四周作业-多线程编程
- Rhcsa第二次课堂练习
- 安卓如何调出软键盘_系统软键盘Android在外接物理键盘时,如何强制调用系统软键盘?...
- 基于LORA SX1278的温度监控控制系统开发设计-软件方案基于时分复用TDMA
- 数学基础 - 第十七章 勾股定理
热门文章
- composer 报错解决:[InvalidArgumentException] Could not find package
- html文档以标签开始,HTML从零开始——文本标签
- Hadoop基础教程-第12章 Hive:进阶(12.3 HiveServer2)(草稿)
- 揭开色彩营销中隐藏在品牌运营下的“变脸”戏法!
- springcloudAlibaba设置allow-bean-definition-overriding=true不生效问题解决
- 《时代》2022年全球最具影响力100家公司榜单公布,防弹少年团、亚马逊新CEO登上封面 | 美通社头条...
- 如何在Mac上刻录DVD以获取可播放的视频?解答来了
- 【VB】机房收费系统(结账)
- [Java]Error:No enclosing instance of type E is accessible. Must qualify the allocation with an enclo
- 青龙-腾讯自选股双端[简单稳定]