docs(splunk): document splunk-index-acknowledgment logging driver option - #25888
Open
santhiprakash wants to merge 1 commit into
Open
docs(splunk): document splunk-index-acknowledgment logging driver option#25888santhiprakash wants to merge 1 commit into
santhiprakash wants to merge 1 commit into
Conversation
- Problem: the splunk-index-acknowledgment option (accepted since Docker 20.10) is missing from the Splunk logging driver options table; every other splunk-* option is documented. Reported in docker#13688 (stale-closed, never fixed). - Fix: add the table row, matching the position used by the original 2020 documentation commit (after splunk-gzip-level). - Verification: moby daemon/logger/splunk/splunk.go parses it as a bool (default false) and sets the X-Splunk-Request-Channel header per event when enabled, which is required when index acknowledgment is turned on for the index on the HTTP Event Collector.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
splunk-index-acknowledgmentlogging driver option has been accepted byDocker Engine since v20.10, but it is missing from the Splunk logging driver
options table. Every other
splunk-*option is documented.This was first reported in #13688, which was closed by the stale bot in 2022
without a fix. The option is still present in the current Moby source.
Verification
daemon/logger/splunk/splunk.go(
splunkIndexAcknowledgment = "splunk-index-acknowledgment", parsed as abool via
strconv.ParseBool, defaultfalse, accepted byvalidateLogOpt)X-Splunk-Request-Channelheader to aper-request UUID on every event POST, which is the header Splunk's HTTP
Event Collector requires when index acknowledgment is enabled for the
target index
documentation commit for this option (docker/docker.github.io fffa558),
which never landed in this repo
Fix
Add a
splunk-index-acknowledgmentrow to the options table, aftersplunk-gzip-level, following the format of the existing rows.