如何打开Spring WebFlux的访问日志？

Question

对于运行在Netty上的Spring WebFlux，我希望有像Tomcat那样的访问日志，但我在Spring文档中没有找到任何东西。

有人能帮忙吗？

Answer 1

这已在本问题之后的Netty V0.7.9版本中实现。根据此处发布的说明,您可以启用日志,如下所示：

• 使用-dreactor.netty.http.server.accesslogenabled=true系统属性
运行应用程序

而且

null

在实现该功能之前可用的其他解决方案有：

正如@GreyTearDrop在注释中提到的，您可以将reactor.ipc.netty.channel.contextHandler和reactor.ipc.netty.http.server.httpserver的日志级别设置为debug。这将产生每个消息的多行转储，作为十六进制+ASCII表。不是很适合生产使用，但对调试很有用。

如果您的项目中有Spring执行器，is支持跟踪HTTP请求。跟踪信息被发送到HttpTraceRepositorybean。默认情况下，InMemoryHttpTraceRepository保存最后100个跟踪。

您可以通过实现自己的HttpTraceRepository或添加跟踪日志的修饰器来利用这一点。您需要将其注册为bean--它将替换自动配置的inMemoryHttpTraceRepository。

请注意，HTTP跟踪只有关于请求和响应的有限信息集，例如。您没有访问请求/响应正文或大小的权限。

我最终实现的一个解决方案如下所示：

@Bean
public HttpTraceRepository httpTraceRepository() {
    return new AccessLoggingHttpTraceRepositoryDecorator(
            new InMemoryHttpTraceRepository(),
            LoggerFactory.getLogger("netty.Access"),
            new HttpTraceLogFormatter()
    );
}

public class AccessLoggingHttpTraceRepositoryDecorator implements HttpTraceRepository {

    private HttpTraceRepository delegate;
    private Logger logger;
    private HttpTraceLogFormatter formatter;

    public AccessLoggingHttpTraceRepositoryDecorator(HttpTraceRepository delegate, Logger logger, HttpTraceLogFormatter formatter) {
        this.delegate = delegate;
        this.logger = logger;
        this.formatter = formatter;
    }

    @Override
    public List<HttpTrace> findAll() {
        return delegate.findAll();
    }

    @Override
    public void add(HttpTrace trace) {
        if (logger.isDebugEnabled()) {
            try {
                logger.debug(formatter.format(trace));
            } catch (Exception e) {
                logger.error("Failed to log trace " + trace, e);
            }
        }
        delegate.add(trace);
    }
}

public class HttpTraceLogFormatter {
    public String format(HttpTrace trace) {
        // TODO implement this according to your preference
        return ...;
    }
}

management:
  trace:
    http:
      include: REQUEST_HEADERS, RESPONSE_HEADERS, PRINCIPAL, REMOTE_ADDRESS, TIME_TAKEN

默认情况下，只包含request_headers、RESPONSE_HEADERS、COOKIE_HEADERS、time_take。

Spring Boot执行器在HttpTraceWebFilter的帮助下实现跟踪。如果您不想使用执行器的解决方案，可以从HttpTraceWebFilter的源代码中获得灵感，并实现自己的WebFilter。将其公开为Spring bean，它将自动注册到Netty。