SpringBoo利用 MDC 机制过滤出单次请求相关的日志

2024-04-13 17:52

本文主要是介绍SpringBoo利用 MDC 机制过滤出单次请求相关的日志,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

 

🏷️个人主页:牵着猫散步的鼠鼠 

🏷️系列专栏:Java全栈-专栏

🏷️个人学习笔记,若有缺误,欢迎评论区指正

目录

1.前言

2.MDC 是什么

3.代码实战

4.总结


1.前言

在服务出现故障时,我们经常需要获取一次请求流程里的所有日志进行定位 。如果请求只在一个线程里处理,则我们可以通过线程ID来过滤日志 ,但如果请求包含异步线程的处理,那么光靠线程ID就显得捉襟见肘了。

比如华为IoT平台,提供了接收设备上报数据的能力, 当数据到达平台后,平台会进行一些复杂的业务逻辑处理,如数据存储,规则引擎,数据推送,命令下发等等。由于这个逻辑之间没有强耦合的关系,所以通常是异步处理。

如何将一次数据上报请求中包含的所有业务日志快速过滤出来,就是本文要介绍的。

2.MDC 是什么

SLF4J MDC(Mapped Diagnostic Context)是一个用于日志记录的实用工具,它提供了线程级别的日志上下文信息管理功能。SLF4J(Simple Logging Facade for Java)本身是一个抽象层,允许我们在使用不同的日志框架(如log4j, logback等),而MDC是SLF4J的一部分,主要在logback和log4j中使用。

MDC允许我们在一个线程的执行上下文中设置和获取键值对。这些键值对在日志输出中可以以占位符的形式被引用,从而在日志信息中输出这些上下文信息。这特别有用,例如,在Web应用中跟踪用户请求,或者在分布式系统中跟踪跨服务的事务。

在设置和清除MDC数据时,通常使用put和remove方法,如:

MDC.put("requestId", "12345");
// ... logging statements ...
MDC.remove("requestId");

这样,日志框架在记录日志时,就可以在日志格式中包含这个requestId的值。

3.代码实战

通过上门的介绍你可能还是有点难理解,我们可以先实战一把。

public class Main {private static final String KEY = "requestId";private static final Logger logger = LoggerFactory.getLogger(Main.class);public static void main(String[] args) {// 入口传入请求IDMDC.put(KEY, UUID.randomUUID().toString());// 打印日志logger.debug("log in main thread 1");logger.debug("log in main thread 2");logger.debug("log in main thread 3");// 出口移除请求IDMDC.remove(KEY);}}

我们在main函数的入口调用MDC.put()方法传入请求ID,在出口调用MDC.remove()方法移除请求ID。配置好log4j2.xml 文件后,运行main函数,可以在控制台看到以下日志输出:

2018-02-17 13:19:52.606 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 1
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 2
2018-02-17 13:19:52.609 {requestId=f97ea0fb-2a43-40f4-a3e8-711f776857d0} [main] DEBUG cn.wudashan.Main - log in main thread 3

从日志中可以明显地看到花括号中包含了 (映射的) 请求ID(requestId),这其实就是我们定位 (诊断) 问题的关键字 (上下文) 。

有了MDC工具,只要在接口或切面植入put()和remove()代码,在为服务定位问题时,我们就可以通过grep requestId=xxx *.log快速的过滤出某次请求的所有日志。

然而,MDC工具真的有我们所想的这么方便吗?

回到我们开头,一次请求可能涉及多线程异步处理,那么在多线程异步的场景下,它是否还能正常运作呢?

public class Main {private static final String KEY = "requestId";private static final Logger logger = LoggerFactory.getLogger(Main.class);public static void main(String[] args) {// 入口传入请求IDMDC.put(KEY, UUID.randomUUID().toString());// 主线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>logger.debug("log in main thread");// 异步线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>new Thread(new Runnable() {@Overridepublic void run() {logger.debug("log in other thread");}}).start();// 出口移除请求IDMDC.remove(KEY);}}

代码里我们新起了一个异步线程,并在匿名对象Runnable的run()方法打印日志。运行main函数,可以在控制台看到以下日志输出:

2018-02-17 14:05:43.487 {requestId=e6099c85-72be-4986-8a28-de6bb2e52b01} [main] DEBUG cn.wudashan.Main - log in main thread
2018-02-17 14:05:43.490 {} [Thread-1] DEBUG cn.wudashan.Main - log in other thread

不幸的是,请求ID在异步线程里不打印了。

这是怎么回事呢?要解决这个问题,我们就得知道MDC的实现原理。

由于篇幅有限,这里就暂不详细介绍,MDC之所以在异步线程中不生效是因为底层采用ThreadLocal 作为数据结构,我们调用MDC.put()方法传入的请求ID只在当前线程有效。

知道了原理那么解决这个问题就轻而易举了,我们可以使用装饰器模式 ,新写一个MDCRunnable类对Runnable接口进行一层装饰。

在创建MDCRunnable类时保存当前线程的MDC值,在执行run()方法时再将保存的MDC值拷贝到异步线程中去。代码实现如下:

public class MDCRunnable implements Runnable {private final Runnable runnable;private final Map<String, String> map;public MDCRunnable(Runnable runnable) {this.runnable = runnable;// 保存当前线程的MDC值this.map = MDC.getCopyOfContextMap();}@Overridepublic void run() {// 传入已保存的MDC值for (Map.Entry<String, String> entry : map.entrySet()) {MDC.put(entry.getKey(), entry.getValue());}// 装饰器模式,执行run方法runnable.run();// 移除已保存的MDC值for (Map.Entry<String, String> entry : map.entrySet()) {MDC.remove(entry.getKey());}}}

接着,我们需要对main函数里创建的Runnable实现类进行装饰:

public class Main {private static final String KEY = "requestId";private static final Logger logger = LoggerFactory.getLogger(Main.class);private static final ExecutorService EXECUTOR = Executors.newSingleThreadExecutor();public static void main(String[] args) {// 入口传入请求IDMDC.put(KEY, UUID.randomUUID().toString());// 主线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>logger.debug("log in main thread");// 异步线程打印<font style="color: #1e6bb8;word-wrap: break-word;font-weight: bold;border-bottom: 1px solid">日志</font>,用MDCRunnable装饰Runnablenew Thread(new MDCRunnable(new Runnable() {@Overridepublic void run() {logger.debug("log in other thread");}})).start();// 异步线程池打印日志,用MDCRunnable装饰RunnableEXECUTOR.execute(new MDCRunnable(new Runnable() {@Overridepublic void run() {logger.debug("log in other thread pool");}}));EXECUTOR.shutdown();// 出口移除请求IDMDC.remove(KEY);}}

执行main函数,将会输出以下日志 :

2018-03-04 23:44:05.343 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [main] DEBUG cn.wudashan.Main - log in main thread
2018-03-04 23:44:05.346 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [Thread-1] DEBUG cn.wudashan.Main - log in other thread
2018-03-04 23:44:05.347 {requestId=5ee2a117-e090-41d8-977b-cef5dea09d34} [pool-2-thread-1] DEBUG cn.wudashan.Main - log in other thread pool

Congratulations! 经过我们的努力,最终在异步线程和线程池中都有requestId打印了!

4.总结

本文讲述了如何使用MDC工具来快速过滤一次请求的所有日志 ,并通过装饰器模式使得MDC工具在异步线程里也能生效。利用MDC,再配合AOP技术对所有的切面植入requestId,就可以将整个系统的任意流程的日志过滤出来。使用MDC工具,在开发自测阶段,可以极大地节省定位问题的时间,提升开发效率;在运维维护阶段,可以快速地收集相关日志信息,加快分析速度。

这篇关于SpringBoo利用 MDC 机制过滤出单次请求相关的日志的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/900814

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

深入探索协同过滤:从原理到推荐模块案例

文章目录 前言一、协同过滤1. 基于用户的协同过滤(UserCF)2. 基于物品的协同过滤(ItemCF)3. 相似度计算方法 二、相似度计算方法1. 欧氏距离2. 皮尔逊相关系数3. 杰卡德相似系数4. 余弦相似度 三、推荐模块案例1.基于文章的协同过滤推荐功能2.基于用户的协同过滤推荐功能 前言     在信息过载的时代,推荐系统成为连接用户与内容的桥梁。本文聚焦于

sqlite3 相关知识

WAL 模式 VS 回滚模式 特性WAL 模式回滚模式(Rollback Journal)定义使用写前日志来记录变更。使用回滚日志来记录事务的所有修改。特点更高的并发性和性能;支持多读者和单写者。支持安全的事务回滚,但并发性较低。性能写入性能更好,尤其是读多写少的场景。写操作会造成较大的性能开销,尤其是在事务开始时。写入流程数据首先写入 WAL 文件,然后才从 WAL 刷新到主数据库。数据在开始

pandas数据过滤

Pandas 数据过滤方法 Pandas 提供了多种方法来过滤数据,可以根据不同的条件进行筛选。以下是一些常见的 Pandas 数据过滤方法,结合实例进行讲解,希望能帮你快速理解。 1. 基于条件筛选行 可以使用布尔索引来根据条件过滤行。 import pandas as pd# 创建示例数据data = {'Name': ['Alice', 'Bob', 'Charlie', 'Dav

Java ArrayList扩容机制 (源码解读)

结论:初始长度为10,若所需长度小于1.5倍原长度,则按照1.5倍扩容。若不够用则按照所需长度扩容。 一. 明确类内部重要变量含义         1:数组默认长度         2:这是一个共享的空数组实例,用于明确创建长度为0时的ArrayList ,比如通过 new ArrayList<>(0),ArrayList 内部的数组 elementData 会指向这个 EMPTY_EL

【编程底层思考】垃圾收集机制,GC算法,垃圾收集器类型概述

Java的垃圾收集(Garbage Collection,GC)机制是Java语言的一大特色,它负责自动管理内存的回收,释放不再使用的对象所占用的内存。以下是对Java垃圾收集机制的详细介绍: 一、垃圾收集机制概述: 对象存活判断:垃圾收集器定期检查堆内存中的对象,判断哪些对象是“垃圾”,即不再被任何引用链直接或间接引用的对象。内存回收:将判断为垃圾的对象占用的内存进行回收,以便重新使用。

flume系列之:查看flume系统日志、查看统计flume日志类型、查看flume日志

遍历指定目录下多个文件查找指定内容 服务器系统日志会记录flume相关日志 cat /var/log/messages |grep -i oom 查找系统日志中关于flume的指定日志 import osdef search_string_in_files(directory, search_string):count = 0

我在移动打工的日志

客户:给我搞一下录音 我:不会。不在服务范围。 客户:是不想吧 我:笑嘻嘻(气笑) 客户:小姑娘明明会,却欺负老人 我:笑嘻嘻 客户:那我交话费 我:手机号 客户:给我搞录音 我:不会。不懂。没搞过。 客户:那我交话费 我:手机号。这是电信的啊!!我这是中国移动!! 客户:我不管,我要充话费,充话费是你们的 我:可是这是移动!!中国移动!! 客户:我这是手机号 我:那又如何,这是移动!你是电信!!

【Tools】大模型中的自注意力机制

摇来摇去摇碎点点的金黄 伸手牵来一片梦的霞光 南方的小巷推开多情的门窗 年轻和我们歌唱 摇来摇去摇着温柔的阳光 轻轻托起一件梦的衣裳 古老的都市每天都改变模样                      🎵 方芳《摇太阳》 自注意力机制(Self-Attention)是一种在Transformer等大模型中经常使用的注意力机制。该机制通过对输入序列中的每个元素计算与其他元素之间的相似性,

如何通俗理解注意力机制?

1、注意力机制(Attention Mechanism)是机器学习和深度学习中一种模拟人类注意力的方法,用于提高模型在处理大量信息时的效率和效果。通俗地理解,它就像是在一堆信息中找到最重要的部分,把注意力集中在这些关键点上,从而更好地完成任务。以下是几个简单的比喻来帮助理解注意力机制: 2、寻找重点:想象一下,你在阅读一篇文章的时候,有些段落特别重要,你会特别注意这些段落,反复阅读,而对其他部分