[英]Spring Boot ErrorController logging with Logback MDC
(更新:我的問題似乎和這個一樣,但它沒有有效的答案。)
我正在嘗試登錄 Spring Boot ErrorController
,但它的日志沒有 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
,但我不知道該怎么做。
一切都按預期工作。
這是記錄的行:
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 為空。
刪除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 Security Filter
拋出的異常。 (嘗試answer/exceptionhandler-with-springsecurity
分支代碼。)
第二種方法將 UUID 放在攔截器上,因此在MyController
和MyErrorController
之間記錄了不同的 requestId。 這不是“請求”ID。 (嘗試answer/interceptor
分支代碼。)
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.