Spring Boot ErrorController使用Logback MDC进行日志记录

Question

(更新：我的问题似乎和这个问题一样，但没有有效的答案。(

我正在尝试在Spring BootErrorController上进行日志记录，但它的日志没有MDC值。

@Controller
@RequestMapping("/error")
@RequiredArgsConstructor
@Slf4j
public class MyErrorController implements ErrorController {
private final ErrorAttributes errorAttributes;
@Override
public String getErrorPath() {
return null;
}
@RequestMapping
@ResponseBody
public Map<String, String> error(final HttpServletRequest request) {
final ServletWebRequest webRequest = new ServletWebRequest(request);
final Throwable th = errorAttributes.getError(webRequest);
if (th != null) {
// **Logged without "requestId" value**
log.error("MyErrorController", th);
}
return Map.of("result", "error");
}
}

// http://logback.qos.ch/manual/mdc.html#autoMDC
public class MDCFilter extends OncePerRequestFilter {
@Override
protected void doFilterInternal(final HttpServletRequest request, final HttpServletResponse response,
final FilterChain filterChain)
throws ServletException, IOException {
final String requestId = UUID.randomUUID().toString();
MDC.put("requestId", requestId);
try {
filterChain.doFilter(request, response);
} finally {
MDC.remove("requestId");
}
}
}

@Configuration
public class MyConfig {
@Bean
public FilterRegistrationBean<MDCFilter> mdcFilter() {
final FilterRegistrationBean<MDCFilter> bean = new FilterRegistrationBean<>();
bean.setFilter(new MDCFilter());
bean.addUrlPatterns("/*");
bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
return bean;
}
}

logback-spring.xml:

<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoders are assigned the type
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] requestId:%X{requestId} %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>

结果(requestId值未出现(：

18:15:13.705 [http-nio-8080-exec-1] requestId: ERROR c.e.l.MyErrorController - MyErrorController
java.lang.RuntimeException: Error occured.
...

这是完整的代码。

我认为我需要在DispatcherServlet之前适应MDCFilter，但我不知道如何做到。

Answer 1

删除ServletRequestListener#requestDestroyed()而不是Filter上的MDC数据。

在Tomcat上，StandardHostValve在执行ErrorController之后激发RequestDestroyEvent。

// Look for (and render if found) an application level error page
if (response.isErrorReportRequired()) {
// If an error has occurred that prevents further I/O, don't waste time
// producing an error report that will never be read
AtomicBoolean result = new AtomicBoolean(false);
response.getCoyoteResponse().action(ActionCode.IS_IO_ALLOWED, result);
if (result.get()) {
if (t != null) {
throwable(request, response, t); // *ErrorController is executed*
} else {
status(request, response);
}
}
}
if (!request.isAsync() && !asyncAtStart) {
context.fireRequestDestroyEvent(request.getRequest()); // *RequestDestroyEvent is fired*
}

因此，实现以下内容：

public class MDCClearListener implements ServletRequestListener {
@Override
public void requestDestroyed(final ServletRequestEvent sre) {
MDC.remove("requestId");
}
}

@Bean
public ServletListenerRegistrationBean<MDCClearListener> mdcClearListener() {
final ServletListenerRegistrationBean<MDCClearListener> bean = new ServletListenerRegistrationBean<>();
bean.setListener(new MDCClearListener());
bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
return bean;
}

(solution分行有具体代码。(

---

关于相关问题的答案

这个答案不适合我。因为：

第一种方法不使用ErrorController，而是使用@ExceptionHandler，因此无法捕获Spring SecurityFilter抛出的异常。(尝试answer/exceptionhandler-with-springsecurity分支代码。(

第二种方法将UUID放在拦截器上，因此记录MyController和MyErrorController之间的不同requestId。这不是"；请求"；id。(尝试answer/interceptor分支代码。(

Answer 2

一切如预期。

这是记录的行：

08:19:34.204 [http-nio-8080-exec-2] MY_MDC_VALUE DEBUG o.s.web.servlet.DispatcherServlet - Failed to complete request: java.lang.RuntimeException: Error occured.

您发布的是MyErroController 的日志

08:19:34.209 [http-nio-8080-exec-2]  ERROR c.e.l.MyErrorController - MyErrorController

正如你所说的

MDC.clear();

当执行该日志语句时，MDC为空。