基于Logback配置实现非200 HTTP响应的详细日志记录

基于logback配置实现非200 http响应的详细日志记录

本文将介绍如何配置Logback,使得当控制器返回非200 HTTP响应时,能够将请求方法、路径和响应状态码等信息记录到单独的日志文件中。这种方式可以帮助开发者更有效地诊断和解决问题,而不会影响正常的日志输出。

方案概述

核心思路是利用Logback的过滤器和appender,根据HTTP响应的状态码来判断是否需要记录详细信息。具体来说,我们可以创建一个过滤器,只允许非200响应的日志通过,然后将这些日志输出到特定的appender,该appender负责将信息写入单独的日志文件。

具体步骤

定义一个过滤器 (Filter)

Logback允许我们自定义过滤器,根据特定的条件来决定是否允许日志事件通过。在这里,我们可以创建一个过滤器,检查HTTP响应的状态码是否为200。如果不是200,则允许日志通过;否则,拒绝日志。

虽然直接在logback-spring.xml中创建自定义过滤器可能比较复杂,但我们可以通过在代码中设置MDC(Mapped Diagnostic Context)来实现类似的效果。在处理HTTP请求的拦截器或过滤器中,记录响应状态码到MDC。

import org.slf4j.MDC;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;public class ResponseStatusInterceptor implements HandlerInterceptor {    @Override    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {        MDC.put("responseStatus", String.valueOf(response.getStatus()));    }    @Override    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {        // 在渲染视图之后清除MDC        MDC.remove("responseStatus");    }}

配置Spring MVC拦截器:

独响 独响

一个轻笔记+角色扮演的app

独响 18 查看详情 独响

import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.InterceptorRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configurationpublic class WebMvcConfig implements WebMvcConfigurer {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(new ResponseStatusInterceptor());    }}

配置Logback (logback-spring.xml)

修改logback-spring.xml文件,添加一个appender,专门用于记录非200 HTTP响应的详细信息。这个appender应该配置一个过滤器,只允许MDC中responseStatus值不为200的日志通过。

            error.log                    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n                                            return !MDC.get("responseStatus").equals("200");                statusCheck                        NEUTRAL            ACCEPT                                                    

ERROR_FILE appender: 定义了一个名为ERROR_FILE的appender,用于将错误信息写入error.log文件。EvaluatorFilter: 使用EvaluatorFilter和Groovy表达式来判断MDC中responseStatus的值是否为”200″。如果不是”200″,则允许日志通过。logger: 配置了一个logger,指定了需要记录的包名(your.controller.package),并将日志级别设置为ERROR。additivity=”false” 表示该logger不会将日志传递给root logger。root: 配置了root logger,用于处理其他级别的日志,并将日志输出到控制台和文件。

记录详细信息

在控制器中,当检测到非200响应时,记录包含请求方法、路径和响应状态码的详细信息。

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;@RestControllerpublic class ProductController {    private static final Logger logger = LoggerFactory.getLogger(ProductController.class);    @GetMapping("/product/{id}")    public ResponseEntity getProduct(@PathVariable("id") int id, HttpServletRequest request) {        if (id <= 0) {            String message = String.format("Product with id %d not found", id);            logger.error("method: {}, path: {}, response: {}", request.getMethod(), request.getRequestURI(), HttpStatus.NOT_FOUND.value());            return new ResponseEntity(message, HttpStatus.NOT_FOUND);        }        return new ResponseEntity("Product found", HttpStatus.OK);    }}

注意事项

确保在logback-spring.xml文件中配置了正确的包名,以便Logback能够捕获控制器中的日志。仔细检查Groovy表达式的语法,确保其能够正确判断HTTP响应状态码。MDC需要在每个请求线程中单独设置和清除,以避免线程安全问题。可以根据实际需求调整日志级别和appender的配置。

总结

通过以上步骤,我们可以利用Logback配置,针对非200 HTTP响应进行详细的日志记录。这种方式可以帮助开发者更有效地诊断和解决问题,提高应用程序的稳定性和可维护性。 关键在于使用EvaluatorFilter 结合MDC,可以根据动态的请求上下文信息来过滤日志,实现精细化的日志管理。

以上就是基于Logback配置实现非200 HTTP响应的详细日志记录的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/338411.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年11月5日 17:14:53
下一篇 2025年11月5日 17:19:22

相关推荐

发表回复

登录后才能评论
关注微信