Logbook项目：如何仅记录错误请求日志

在微服务架构中，日志记录是系统监控和问题排查的重要工具。Zalando的Logbook项目作为一个HTTP请求和响应日志记录库，为Java应用提供了强大的日志功能。本文将深入探讨如何配置Logbook仅记录错误请求（如5xx状态码或异常情况）的日志，而不是记录所有HTTP流量。

核心需求分析

在实际生产环境中，记录所有HTTP请求和响应会产生大量日志数据，这不仅占用存储空间，还可能影响系统性能。更合理的做法是仅记录错误请求，包括：

1. 服务器错误响应（5xx状态码）
2. 客户端错误响应（4xx状态码，可选）
3. 请求处理过程中抛出的异常
4. JSON映射失败等序列化/反序列化问题

Logbook策略机制

Logbook提供了灵活的Strategy接口来控制日志记录行为。要实现仅记录错误日志，我们可以自定义策略实现：

public class ErrorOnlyStrategy implements Strategy {

    @Override
    public HttpRequest process(HttpRequest request) {
        // 不记录请求
        return request.withoutBody();
    }

    @Override
    public HttpResponse process(HttpRequest request, HttpResponse response) {
        if (response.getStatus() >= 500) {
            // 仅记录5xx错误的响应
            return response;
        }
        return response.withoutBody();
    }
}

配置实现方式

1. 通过Spring Boot配置

在Spring Boot应用中，可以通过定义Strategy bean来覆盖默认策略：

@Configuration
public class LogbookConfig {
    
    @Bean
    public Strategy logbookStrategy() {
        return new ErrorOnlyStrategy();
    }
}

2. 组合现有策略

Logbook已经提供了一些内置策略，可以组合使用：

@Bean
public Strategy logbookStrategy() {
    return new StatusCodeStrategy(
        new DefaultHttpLogWriter(),
        500 // 仅记录500及以上状态码
    );
}

3. 异常处理增强

为了捕获序列化异常等未体现在HTTP状态码中的错误，可以扩展策略：

public class EnhancedErrorStrategy implements Strategy {
    
    private final Strategy delegate;
    
    public EnhancedErrorStrategy(Strategy delegate) {
        this.delegate = delegate;
    }
    
    @Override
    public HttpResponse process(HttpRequest request, HttpResponse response) {
        try {
            HttpResponse processed = delegate.process(request, response);
            if (response.getStatus() >= 400) {
                return processed;
            }
            return processed.withoutBody();
        } catch (Exception e) {
            // 记录异常情况
            return response;
        }
    }
}

性能考虑

仅记录错误日志可以显著减少：

1. 日志存储需求
2. 日志收集系统的负载
3. 磁盘I/O压力

但在调试阶段，可能需要临时启用完整日志记录。建议通过环境变量动态控制策略：

@Bean
public Strategy logbookStrategy(
    @Value("${logbook.strategy:error-only}") String strategyType) {
    
    if ("full".equals(strategyType)) {
        return new DefaultStrategy();
    }
    return new ErrorOnlyStrategy();
}

最佳实践建议

1. 在生产环境使用错误专用策略
2. 在测试/开发环境可考虑记录更多日志
3. 结合MDC(Mapped Diagnostic Context)添加请求追踪ID
4. 对敏感信息配置适当的遮蔽规则
5. 监控错误日志率，设置告警阈值

通过合理配置Logbook的日志记录策略，可以在保证可观测性的同时，有效控制日志量，实现运维效率与系统性能的最佳平衡。