在开发Web应用程序时，记录服务器响应的状态码对于调试和监控至关重要。特别是当遇到非200 HTTP响应时，我们需要知道请求的详细信息，例如请求方法、路径以及响应状态码，以便快速定位问题。本文介绍一种使用Logback配置，将这些信息记录到独立日志文件中的方法。
使用Logback配置实现特定HTTP响应的日志记录
Logback是一个强大的日志框架，它可以根据不同的条件将日志输出到不同的目的地。我们可以利用Logback的过滤器功能，根据HTTP响应状态码过滤日志，并将其输出到特定的日志文件中。
以下是一个示例的logback-spring.xml配置文件，展示了如何实现这一目标：
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- 定义一个名为CONSOLE的Appender，用于输出到控制台 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 定义一个名为ERROR_FILE的Appender，用于输出错误日志到文件 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.FileAppender"> <file>logs/error.log</file> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <!-- 根据HTTP状态码过滤日志 --> <filter class="ch.qos.logback.core.filter.EvaluatorFilter"> <evaluator> <expression>message.contains("response: 4") || message.contains("response: 5")</expression> </evaluator> <OnMatch>ACCEPT</OnMatch> <OnMismatch>DENY</OnMismatch> </filter> </appender> <!-- Root Logger配置 --> <root level="INFO"> <appender-ref ref="CONSOLE"/> <appender-ref ref="ERROR_FILE"/> </root> </configuration>
配置详解：
-
: 定义了一个名为ERROR_FILE的FileAppender，用于将日志输出到logs/error.log文件中。 -
: 使用EvaluatorFilter来过滤日志。这个过滤器允许我们使用表达式来判断是否接受或拒绝日志事件。 -
message.contains(“response: 4”) || message.contains(“response: 5”) -
ACCEPT : 如果表达式为真，则接受该日志事件。 -
DENY : 如果表达式为假，则拒绝该日志事件。 - : 配置根logger，将所有INFO级别及以上的日志同时输出到控制台和ERROR_FILE。
代码示例：
假设你的Controller中包含以下代码，用于处理产品请求：
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; @RestController public class ProductController { private static final Logger logger = LoggerFactory.getLogger(ProductController.class); @GetMapping("/product/{id}") public ResponseEntity<String> getProduct(@PathVariable("id") Long id) { if (id <= 0) { String errorMessage = "Product not found with id: " + id; logger.warn("method: GET, path: /product/{}, response: 404 NOT_FOUND", id); return new ResponseEntity<>(errorMessage, HttpStatus.NOT_FOUND); } logger.info("Successfully retrieved product with id: {}", id); return new ResponseEntity<>("Product details for id: " + id, HttpStatus.OK); } }
当访问 /product/0 时，由于 id 小于等于 0，会返回一个 404 错误。logger.warn 会记录一条包含 “response: 404” 的日志消息。根据Logback的配置，这条消息会被同时输出到控制台和 error.log 文件中。而正常的200响应日志只会输出到控制台。
注意事项：
- 表达式可以根据实际需要进行调整，例如可以精确匹配特定的状态码。
- 确保logs目录存在，否则日志文件可能无法创建。
- append属性设置为true可以避免每次重启应用时覆盖日志文件。
- 可以根据需要调整日志级别，例如将ERROR_FILE的日志级别设置为WARN。
总结：
通过配置Logback，我们可以灵活地控制日志的输出，将特定类型的日志信息记录到单独的文件中。这对于错误排查和监控非常有帮助，同时可以避免污染正常的业务日志。通过使用EvaluatorFilter，我们可以根据HTTP响应状态码等条件过滤日志，并将其输出到指定的日志文件中。
评论（已关闭）
评论已关闭