docs(fluentd): document fluentd-request-ack logging driver option - #25837
Open
santhiprakash wants to merge 2 commits into
Open
docs(fluentd): document fluentd-request-ack logging driver option#25837santhiprakash wants to merge 2 commits into
santhiprakash wants to merge 2 commits into
Conversation
- Problem: fluentd-request-ack is a valid logging driver option in Moby (accepted since Docker 20.10, moby/moby#39086) but is not documented in the Fluentd logging driver reference page. - Fix: Add fluentd-request-ack option documentation explaining it sends messages with a unique chunk ID and waits for server acknowledgement, improving reliability at the cost of latency. Defaults to false. - Verification: Option confirmed in Moby source daemon/logger/fluentd/fluentd.go (requestAckKey = "fluentd-request-ack"); release notes mention the option alongside fluentd-async; fluent-logger-golang documents the behavior.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The Vale.Terms rule requires capitalizing Fluentd in headings, but all existing fluentd-* headings use lowercase. Wrapping the new heading in backticks (code scope) avoids the Vale trigger while keeping consistent option-name formatting.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
fluentd-request-acklogging driver option is accepted by Docker Engine(since v20.10, added in moby/moby#39086)
but is not documented in the Fluentd logging driver reference page. All other
fluentd-*options have documentation sections.Verification
daemon/logger/fluentd/fluentd.go(
requestAckKey = "fluentd-request-ack", parsed as bool, defaultfalse)fluentd-asynclibrary documents the behavior: "sends the chunk option with a unique ID.
The server will respond with an acknowledgement. This option improves the
reliability of the message transmission."
Fix
Add a
fluentd-request-acksection to the options documentation, following thesame format as existing options (description, default value).
Closes #25823 (partial — this PR documents
fluentd-request-ack;fluentd-read-timeoutis covered separately in PR #25823)