docs: document custom attribute log options for the local driver - #25827
Open
santhiprakash wants to merge 1 commit into
Open
docs: document custom attribute log options for the local driver#25827santhiprakash wants to merge 1 commit into
santhiprakash wants to merge 1 commit into
Conversation
The local logging driver gained support for custom attributes in Docker Engine 29.5.0 (moby/moby#52348), bringing feature-parity with the json-file driver for labels, labels-regex, env, env-regex, and tag log options. These options were missing from the local driver reference page, which only listed max-size, max-file, and compress.
✅ 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.
Summary
Documents the custom attribute log options (
labels,labels-regex,env,env-regex,tag) that were added to thelocallogging driver in Docker Engine 29.5.0.Problem
The
localfile logging driver reference page only listedmax-size,max-file, andcompressin its Options table. Docker Engine 29.5.0 (moby/moby#52348) added support for custom attributes to thelocaldriver, bringing feature-parity with thejson-filedriver for thelabels,labels-regex,env,env-regex, andtaglog options. These options were missing from the reference page, so users had no way to discover that thelocaldriver now accepts them.Fix
Added
labels,labels-regex,env,env-regex, andtagrows to the Options table incontent/manuals/engine/logging/drivers/local.md, matching the wording and style used by thejson-filedriver reference (json-file.md). Each option links to the existinglog_tags.mdpage for the advanced tag templating details.The option names, descriptions, and example values were verified against:
LogOptKeysmap inmoby/mobydaemon/logger/local/local.go(which registerslabels,labels-regex,env,env-regex,tagvia the sharedlogger.Attr*constants).content/manuals/engine/release-notes/29.md(29.5.0: "Thelocallogging driver now has support for custom attributes...").Verification
git diffconfirms a minimal, single-file change (10 insertions, 5 deletions).log_tags.mdrelative link resolves to the existing file in the same directory.--log-opt labels=..., not the singularlabel=...).