Skip to content
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

Jump to bottom

Revamp the Appenders page #2528

Closed
vy opened this issue Apr 26, 2024 · 1 comment · Fixed by #2797
Closed

Revamp the Appenders page #2528

vy opened this issue Apr 26, 2024 · 1 comment · Fixed by #2797
Labels
documentation Pull requests or issues that affect documentation

Comments

@vy
Copy link
Member

vy commented Apr 26, 2024 •
edited
Loading

As agreed in the site structure document, revamp the Appenders page such that
@vy vy added the documentation Pull requests or issues that affect documentation label Apr 26, 2024
@vy vy mentioned this issue Apr 29, 2024
Closed
@vy vy mentioned this issue May 13, 2024
Merged
@ppkarwasz
Copy link
Contributor

While restructuring the "Appenders" page we should explain the meaning of the immediateFlush option.
Looking at #2023, #2025 and other discussions, users often think that immediateFlush forces the OS to write the data to the underlying storage device.

That is not true, immediateFlush only flushes the Java buffers to the OS and due to the atomicity of the UNIX read()/write() calls this is usually enough for the users: if the appender logs to a pipe, the receiver should get messages up to PIPE_BUF atomically. For files and symbolic links there is no limit and operations should always be atomic.

ppkarwasz added a commit that referenced this issue Jul 26, 2024
@ppkarwasz
Revamp file and delegating appenders
990bf4c 
This PR splits the documentation of file appenders and the `Async`, `Failover`, `Rewrite` and `Routing` appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,
* remove examples to provide smaller ones that make the same point.

Part of #2528.
@ppkarwasz ppkarwasz mentioned this issue Jul 26, 2024
Merged
ppkarwasz added a commit that referenced this issue Jul 26, 2024
@ppkarwasz
Revamp file and delegating appenders
c4e5318 
This PR splits the documentation of file appenders and the `Async`, `Failover`, `Rewrite` and `Routing` appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,
* remove examples to provide smaller ones that make the same point.

Part of #2528.
ppkarwasz added a commit that referenced this issue Jul 26, 2024
@ppkarwasz
Revamp file and delegating appenders
698ac36 
This PR splits the documentation of file appenders and the `Async`, `Failover`, `Rewrite` and `Routing` appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,
* remove examples to provide smaller ones that make the same point.

Part of #2528.
ppkarwasz added a commit that referenced this issue Aug 1, 2024
@ppkarwasz
Revamp database appenders
b63146a 
This PR splits the documentation of database appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,

Unlike other PRs, since these appenders are rarely used, we don't revamp their configuration examples.

Part of #2528.
@ppkarwasz ppkarwasz mentioned this issue Aug 1, 2024
Merged
ppkarwasz added a commit that referenced this issue Aug 1, 2024
@ppkarwasz
Revamp file and delegating appenders
eaae9e3 
This PR splits the documentation of file appenders and the `Async`, `Failover`, `Rewrite` and `Routing` appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,
* remove examples to provide smaller ones that make the same point.

Part of #2528.
ppkarwasz added a commit that referenced this issue Aug 1, 2024
@ppkarwasz
Revamp database appenders
70355f8 
This PR splits the documentation of database appenders into their own files.

As in the previous PRs we:

* check and reformat the configuration options,
* add links to the Plugin Reference,
* improve the readability of the description by shortening it and reformatting it,

Unlike other PRs, since these appenders are rarely used, we don't revamp their configuration examples.

Part of #2528.
ppkarwasz added a commit that referenced this issue Aug 5, 2024
@ppkarwasz
Revamp network appender documentation
0a6bdcb 
We split off the documentation of the UDP, TCP, HTTP and SMTP appenders to a new page and apply the improvements from the previous PRs.

Part of #2528.
@ppkarwasz ppkarwasz mentioned this issue Aug 5, 2024
Merged
ppkarwasz added a commit that referenced this issue Aug 6, 2024
@ppkarwasz
Revamp message-queue appender documentation
7502316 
This PR revamps the documentation of the remaining appenders, i.e. those logging to message-queue servers and the `Console` appender.

Closes #2528.
ppkarwasz added a commit that referenced this issue Aug 6, 2024
@ppkarwasz
Revamp message-queue appender documentation
6218476 
This PR revamps the documentation of the remaining appenders, i.e. those logging to message-queue servers and the `Console` appender.

Closes #2528.
@ppkarwasz ppkarwasz mentioned this issue Aug 6, 2024
Merged
ppkarwasz added a commit that referenced this issue Aug 6, 2024
@ppkarwasz
Revamp message-queue appender documentation
3e36126 
This PR revamps the documentation of the remaining appenders, i.e. those logging to message-queue servers and the `Console` appender.

Closes #2528.
ppkarwasz added a commit that referenced this issue Aug 6, 2024
@ppkarwasz @vy
Revamp network appender documentation (#2796)
6afc438 
Revamp network appender documentation (+review)

We split off the documentation of the UDP, TCP, HTTP and SMTP appenders to a new page and apply the improvements from the previous PRs.

Part of #2528.

Co-authored-by: Volkan Yazıcı <[email protected]>
ppkarwasz added a commit that referenced this issue Aug 7, 2024
@ppkarwasz
Port appenders documentation to main
ab9c3a5 
Related to #2528.
@ppkarwasz ppkarwasz mentioned this issue Aug 7, 2024
Merged
ppkarwasz added a commit that referenced this issue Aug 12, 2024
@ppkarwasz
Port appenders documentation to main (#2805)
054fbc9 
Related to #2528.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Pull requests or issues that affect documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Revamp message-queue appender documentation apache/logging-log4j2
2 participants
@vy @ppkarwasz