MDC is a thread binding context map provided by SLF4J to add custom information to the log for improved traceability. 1. Use MDC.put(key, value) to add context data, such as user ID and request ID; 2. Output these fields (such as Logback, Log4j2) through %X{key} in the log configuration; 3. Automatically inject MDC information through interceptors or filters in a web application, and call MDC.clear() after the request is completed; 4. Manually pass the MDC context in multithreaded or asynchronous tasks, which can be implemented by encapsulating Executor or using third-party libraries; 5. Configure the log framework (such as Logback, Log4j2) to ensure the correct output of MDC information. JSON format logs must support MDC field serialization. Rational use of MDC can significantly improve log troubleshooting efficiency.
In Java applications, especially in enterprise-level or distributed systems, if log information is mixed indiscriminately, it will be very difficult to troubleshoot problems. MDC (Mapped Diagnostic Context) is used to solve this problem. It allows you to add custom context information (such as user ID, request ID, IP, etc.) to the log context, so that the log is more readable and traceable.

Here are some practical suggestions on how to use MDC in Java for advanced log configuration.
What is MDC?
MDC is a thread-bound context map provided by SLF4J, which allows you to add some context information to the logging of the current thread. This information is attached to each log output, which is ideal for logs that distinguish different requests, users, or sessions.

For example, if you are processing an HTTP request, you can put the request ID or user ID into the MDC, so that each log will have this ID, so that all logs of a request can be quickly located when troubleshooting problems.
How to use MDC in code?
Using MDC is very simple, you just need to call MDC.put(key, value)
method in your code:

MDC.put("userId", "12345"); MDC.put("requestId", "req-789");
These fields are then output in the log by configuring the format. For example, the pattern of Logback can be written like this:
%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %X{userId} %X{requestId} - %msg%n
Note: MDC is thread-based, so special attention should be paid to context passing issues when used in asynchronous or thread pools.
Automatically inject MDC information into web applications
In order not to manually set up MDCs for each business code, we usually choose to automatically inject context information when requests enter the system. For example, you can use an interceptor or a filter in Spring:
Example: Setting up MDC in Spring Interceptor
@Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String userId = request.getHeader("X-User-ID"); String requestId = UUID.randomUUID().toString(); MDC.put("userId", userId); MDC.put("requestId", requestId); return true; } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { MDC.clear(); }
Important: Remember to call
MDC.clear()
orMDC.remove(key)
after each request is over to avoid context pollution caused by thread reuse.
MDC delivery issues in multithreaded and asynchronous tasks
Since MDC is implemented based on thread-local variables (ThreadLocal), when you switch threads in asynchronous tasks, the contents of MDC are not automatically passed.
Solution:
- Use
ThreadLocal
tool class to manually pass the context (such as getting the current MDC content before submitting the task and resetting it in a new thread) - Use
MDCInsertingServletFilter
(provided by Spring) or third-party libraries such aslogbook
,spring-cloud-sleuth
, etc. to automatically handle it - When using
CompletableFuture
, you can encapsulate a customExecutor
to pass MDC
ExecutorService executor = Executors.newFixedThreadPool(10, r -> { Map<String, String> contextMap = MDC.getCopyOfContextMap(); return new Thread(() -> { if (contextMap != null) { MDC.setContextMap(contextMap); } try { r.run(); } finally { MDC.clear(); } }); });
Log framework configuration suggestions
Different log frameworks support MDC slightly differently, but the basic usage is consistent. The following are the configuration tips for several mainstream frameworks:
- Logback : Use
%X{key}
to output MDC value - Log4j2 : Use
%X{key}
or%d{...} [%t] %-5p %c - %X{userId} %m%n
- Log4j : Supports
%x
(NDC) and%X{key}
(MDC)
If you are using JSON format log output (for example for ELK), make sure your log formatter supports serialization of MDC fields.
Basically that's it. MDC is not complicated, but if used properly, it can significantly improve the readability and troubleshooting efficiency of logs. The key is to set up and clean the context at the right time, especially in asynchronous or multi-threaded environments to pay more attention to context delivery.
The above is the detailed content of Advanced Java Logging Configuration with MDC. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Java supports asynchronous programming including the use of CompletableFuture, responsive streams (such as ProjectReactor), and virtual threads in Java19. 1.CompletableFuture improves code readability and maintenance through chain calls, and supports task orchestration and exception handling; 2. ProjectReactor provides Mono and Flux types to implement responsive programming, with backpressure mechanism and rich operators; 3. Virtual threads reduce concurrency costs, are suitable for I/O-intensive tasks, and are lighter and easier to expand than traditional platform threads. Each method has applicable scenarios, and appropriate tools should be selected according to your needs and mixed models should be avoided to maintain simplicity

In Java, enums are suitable for representing fixed constant sets. Best practices include: 1. Use enum to represent fixed state or options to improve type safety and readability; 2. Add properties and methods to enums to enhance flexibility, such as defining fields, constructors, helper methods, etc.; 3. Use EnumMap and EnumSet to improve performance and type safety because they are more efficient based on arrays; 4. Avoid abuse of enums, such as dynamic values, frequent changes or complex logic scenarios, which should be replaced by other methods. Correct use of enum can improve code quality and reduce errors, but you need to pay attention to its applicable boundaries.

JavaNIO is a new IOAPI introduced by Java 1.4. 1) is aimed at buffers and channels, 2) contains Buffer, Channel and Selector core components, 3) supports non-blocking mode, and 4) handles concurrent connections more efficiently than traditional IO. Its advantages are reflected in: 1) Non-blocking IO reduces thread overhead, 2) Buffer improves data transmission efficiency, 3) Selector realizes multiplexing, and 4) Memory mapping speeds up file reading and writing. Note when using: 1) The flip/clear operation of the Buffer is easy to be confused, 2) Incomplete data needs to be processed manually without blocking, 3) Selector registration must be canceled in time, 4) NIO is not suitable for all scenarios.

Java's class loading mechanism is implemented through ClassLoader, and its core workflow is divided into three stages: loading, linking and initialization. During the loading phase, ClassLoader dynamically reads the bytecode of the class and creates Class objects; links include verifying the correctness of the class, allocating memory to static variables, and parsing symbol references; initialization performs static code blocks and static variable assignments. Class loading adopts the parent delegation model, and prioritizes the parent class loader to find classes, and try Bootstrap, Extension, and ApplicationClassLoader in turn to ensure that the core class library is safe and avoids duplicate loading. Developers can customize ClassLoader, such as URLClassL

HashMap implements key-value pair storage through hash tables in Java, and its core lies in quickly positioning data locations. 1. First use the hashCode() method of the key to generate a hash value and convert it into an array index through bit operations; 2. Different objects may generate the same hash value, resulting in conflicts. At this time, the node is mounted in the form of a linked list. After JDK8, the linked list is too long (default length 8) and it will be converted to a red and black tree to improve efficiency; 3. When using a custom class as a key, the equals() and hashCode() methods must be rewritten; 4. HashMap dynamically expands capacity. When the number of elements exceeds the capacity and multiplies by the load factor (default 0.75), expand and rehash; 5. HashMap is not thread-safe, and Concu should be used in multithreaded

Java enumerations not only represent constants, but can also encapsulate behavior, carry data, and implement interfaces. 1. Enumeration is a class used to define fixed instances, such as week and state, which is safer than strings or integers; 2. It can carry data and methods, such as passing values ??through constructors and providing access methods; 3. It can use switch to handle different logics, with clear structure; 4. It can implement interfaces or abstract methods to make differentiated behaviors of different enumeration values; 5. Pay attention to avoid abuse, hard-code comparison, dependence on ordinal values, and reasonably naming and serialization.

The key to handling exceptions in Java is to catch them, handle them clearly, and not cover up problems. First, we must catch specific exception types as needed, avoid general catches, and prioritize checkedexceptions. Runtime exceptions should be judged in advance; second, we must use the log framework to record exceptions, and retry, rollback or throw based on the type; third, we must use the finally block to release resources, and recommend try-with-resources; fourth, we must reasonably define custom exceptions, inherit RuntimeException or Exception, and carry context information for easy debugging.

Singleton design pattern in Java ensures that a class has only one instance and provides a global access point through private constructors and static methods, which is suitable for controlling access to shared resources. Implementation methods include: 1. Lazy loading, that is, the instance is created only when the first request is requested, which is suitable for situations where resource consumption is high and not necessarily required; 2. Thread-safe processing, ensuring that only one instance is created in a multi-threaded environment through synchronization methods or double check locking, and reducing performance impact; 3. Hungry loading, which directly initializes the instance during class loading, is suitable for lightweight objects or scenarios that can be initialized in advance; 4. Enumeration implementation, using Java enumeration to naturally support serialization, thread safety and prevent reflective attacks, is a recommended concise and reliable method. Different implementation methods can be selected according to specific needs
