Skip to content

Add documentation for third-party appenders and async HTTP appender specifically #4062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mlangc wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open

Add documentation for third-party appenders and async HTTP appender specifically #4062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/site/antora/modules/ROOT/pages/manual/appenders.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,20 @@ Dynamically choose a different appender for each log event

See xref:manual/appenders/delegating.adoc[] for details.

[#third-party]
== Third-party appenders

[WARNING]
====
These appenders are provided by **third-party** vendors and are not maintained by the link:{logging-services-url}[Apache Logging Services] project.
====

[#more-log4j2-AsyncHttpAppender]
=== Async HTTP appender (`more-log4j2`)

`AsyncHttpAppender` by https://github.com/mlangc/more-log4j2[more-log4j2] batches and optionally compresses log events,
before sending them to backends. This way it is able to deliver high log volumes with little overhead.

[#extending]
== Extending

Expand Down
7 changes: 7 additions & 0 deletions src/site/antora/modules/ROOT/pages/manual/appenders/network.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,13 @@ Additional headers can be configured using the nested
If the appender receives a response with status code different from `2xx`, an exception is thrown.
See also <<HttpAppender-attr-ignoreExceptions,`ignoreExceptions`>> configuration attribute.

[WARNING]
====
Sending logs synchronously, one by one to an HTTP backend is rarely a good idea. Even if the expected log
volumes are extremely low, you should at least consider using xref:manual/async.adoc[asynchronous loggers] if
you use this appender. Otherwise, please have a look at xref:manual/appenders.adoc#third-party[third-party appenders].
====

[NOTE]
====
The implementation uses
Expand Down