Support error log handler for Http server #3700

raccoonback · 2025-03-28T06:18:21Z

Description

This PR introduces an error logging mechanism similar to Apache HTTPD's errorLog, addressing #3257.
Currently, Reactor Netty does not log errors when exceptions are fired, so this update ensures that such errors are captured separately from access logs.

Key Changes

Add DefaultErrorLogHandler handler to log error when exceptions are fired.
The log format can be customized just like AccessLog using ErrorLogFactory.
Log format customization, similar to AccessLog, is available using ErrorLogFactory.
Filtering can also be done using ErrorLogFactory.
Filtering information includes RemoteAddress, HttpServerInfos, and Throwable.

Related Issue

Netty does not provide errorLog just accesLog #3257

Additional Context

For reference, this implementation follows the Apache HTTPD error log format:
🔗 Apache HTTPD Error Log Documentation

- Introduce a new ChannelDuplexHandler to log errors similar to Apache HTTPD errorLog - Ensure that error logs are recorded separately from access logs Signed-off-by: raccoonback <[email protected]>

Signed-off-by: raccoonback <[email protected]>

reactor-netty-http/src/main/java/reactor/netty/http/server/Http3Codec.java

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java

...-http/src/main/java/reactor/netty/http/server/logging/error/AbstractErrorLogArgProvider.java

...or-netty-http/src/main/java/reactor/netty/http/server/logging/error/BaseErrorLogHandler.java

...or-netty-http/src/main/java/reactor/netty/http/server/logging/error/ErrorLogArgProvider.java

reactor-netty-http/src/main/java/reactor/netty/http/server/logging/error/ErrorLogFactory.java

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java

violetagg

@raccoonback Thanks for the PR!

I have some minor comments and questions. Please check them.

reactor-netty-core/src/main/java/reactor/netty/NettyPipeline.java

reactor-netty-http/src/main/java/reactor/netty/http/server/Http3Codec.java

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java

...netty-http/src/main/java/reactor/netty/http/server/logging/error/DefaultErrorLogHandler.java

reactor-netty-http/src/main/java/reactor/netty/http/server/logging/error/ErrorLog.java

...or-netty-http/src/main/java/reactor/netty/http/server/logging/error/ErrorLogArgProvider.java

reactor-netty-http/src/main/java/reactor/netty/http/server/logging/error/ErrorLogFactory.java

reactor-netty-http/src/test/java/reactor/netty/http/server/logging/error/ErrorLogTest.java

...or-netty-http/src/main/java/reactor/netty/http/server/logging/error/BaseErrorLogHandler.java

reactor-netty-http/src/test/java/reactor/netty/http/server/logging/error/ErrorLogTest.java

Signed-off-by: raccoonback <[email protected]>

…part of the initialization target Signed-off-by: raccoonback <[email protected]>

Signed-off-by: raccoonback <[email protected]>

ref. reactor#3700 (comment) Signed-off-by: raccoonback <[email protected]>

Signed-off-by: raccoonback <[email protected]>

…exceptions Signed-off-by: raccoonback <[email protected]>

Signed-off-by: raccoonback <[email protected]>

raccoonback · 2025-04-17T04:08:42Z

@violetagg
Thank you for the review!
I've reflected all of your comments!

… HTTP server Signed-off-by: raccoonback <[email protected]>

...netty-http/src/main/java/reactor/netty/http/server/logging/error/DefaultErrorLogHandler.java

Signed-off-by: raccoonback <[email protected]>

raccoonback · 2025-04-25T01:07:21Z

@violetagg
I’ve applied the review feedback!

violetagg

Thanks for the PR!

Signed-off-by: Violeta Georgieva <[email protected]>

… HttpServerInfos HttpServerInfos#connectionRemoteAddress() gives the correct connection remote address for all HTTP versions. This is important for the HTTP/3 use case. Add tests for HTTP/3 use case. Related to #3700 Signed-off-by: Violeta Georgieva <[email protected]>

… HttpServerInfos (#3750) HttpServerInfos#connectionRemoteAddress() gives the correct connection remote address for all HTTP versions. This is important for the HTTP/3 use case. Add tests for HTTP/3 use case. Related to #3700 Signed-off-by: Violeta Georgieva <[email protected]>

raccoonback added 4 commits March 28, 2025 13:25

Support error log handler for Http server

a37f196

- Introduce a new ChannelDuplexHandler to log errors similar to Apache HTTPD errorLog - Ensure that error logs are recorded separately from access logs Signed-off-by: raccoonback <[email protected]>

Write documentation for Error Log

20ebc39

Signed-off-by: raccoonback <[email protected]>

Remove unnecessary import

94b96fa

Signed-off-by: raccoonback <[email protected]>

Fix broken test

152f7e0

Signed-off-by: raccoonback <[email protected]>

raccoonback commented Mar 29, 2025

View reviewed changes

violetagg requested changes Apr 10, 2025

View reviewed changes

violetagg reviewed Apr 10, 2025

View reviewed changes

...or-netty-http/src/main/java/reactor/netty/http/server/logging/error/BaseErrorLogHandler.java Outdated Show resolved Hide resolved

violetagg reviewed Apr 10, 2025

View reviewed changes

reactor-netty-http/src/test/java/reactor/netty/http/server/logging/error/ErrorLogTest.java Outdated Show resolved Hide resolved

violetagg linked an issue Apr 10, 2025 that may be closed by this pull request

Netty does not provide errorLog just accesLog #3257

Closed

violetagg added the type/enhancement A general enhancement label Apr 11, 2025

violetagg added this to the 1.2.6 milestone Apr 11, 2025

raccoonback added 9 commits April 12, 2025 08:41

Fix Formatting

a3d1ceb

Signed-off-by: raccoonback <[email protected]>

Include the error occurrence time and HTTP connection information as …

d77fc36

…part of the initialization target Signed-off-by: raccoonback <[email protected]>

Mark nullable as remoteAddress

ae31bb3

Signed-off-by: raccoonback <[email protected]>

Modify the default error log format

86eb1b6

ref. reactor#3700 (comment) Signed-off-by: raccoonback <[email protected]>

Extend tests to cover HTTP/1.1, HTTP/2, and HTTP/3 protocols

b225446

Signed-off-by: raccoonback <[email protected]>

Update Javadocs for default error log format

0a97054

Signed-off-by: raccoonback <[email protected]>

Replace ErrorLog class with interface to support extension

e231fd5

Signed-off-by: raccoonback <[email protected]>

Add support for logging errors from reactive pipelines and unhandled …

70f9369

…exceptions Signed-off-by: raccoonback <[email protected]>

Apply concurrency control for simultaneous error logging

3042ce0

Signed-off-by: raccoonback <[email protected]>

raccoonback requested a review from violetagg April 16, 2025 23:10

Add test case for error logging on exception during route handling in…

12c03f4

… HTTP server Signed-off-by: raccoonback <[email protected]>

raccoonback force-pushed the issue-3257 branch from 5a966bc to 12c03f4 Compare April 17, 2025 11:54

violetagg reviewed Apr 22, 2025

View reviewed changes

...netty-http/src/main/java/reactor/netty/http/server/logging/error/DefaultErrorLogHandler.java Show resolved Hide resolved

raccoonback requested a review from violetagg April 22, 2025 23:17

Remove unnecessary synchronization in error logging

0d096e1

Signed-off-by: raccoonback <[email protected]>

violetagg approved these changes Apr 29, 2025

View reviewed changes

violetagg merged commit 2d585b6 into reactor:1.2.x Apr 29, 2025
14 checks passed

violetagg added a commit that referenced this pull request Apr 30, 2025

Merge #3700 into 1.3.0-M3

85af3b8

Signed-off-by: Violeta Georgieva <[email protected]>

violetagg added a commit that referenced this pull request Apr 30, 2025

Merge #3700 into 2.0.0-M4

a6d15c3

Signed-off-by: Violeta Georgieva <[email protected]>

violetagg mentioned this pull request May 5, 2025

Http error log: when possible take the connection remote address from HttpServerInfos #3750

Merged

Support error log handler for Http server #3700

Support error log handler for Http server #3700

Uh oh!

Conversation

raccoonback commented Mar 28, 2025

Description

Key Changes

Related Issue

Additional Context

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

violetagg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

raccoonback commented Apr 17, 2025

Uh oh!

Uh oh!

raccoonback commented Apr 25, 2025

Uh oh!

violetagg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants