docs: document the wipe_field_value logging filter#13374
Open
maskit wants to merge 2 commits into
Open
Conversation
Add a dedicated section describing how the wipe_field_value log filter masks query parameter values, including that it matches parameter names rather than values. The worked example is taken from the existing log-filter autest so the shown output matches what Traffic Server actually produces.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the Traffic Server admin logging guide by adding dedicated documentation for the wipe_field_value log filter action, explaining how it rewrites (but never drops) log events by masking matching query parameter values.
Changes:
- Added a new “Wiping Query Parameter Values” section describing
wipe_field_valuebehavior and configuration guidance. - Added an explicit note that matching applies to query parameter names (not values).
- Added a worked example with a filter snippet and request URL → logged value table.
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
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.
Documentation only
The
wipe_field_valuelogging filter was previously mentioned only in passing, with no explanation of how it behaves or how to configure it. This adds a dedicated "Wiping Query Parameter Values" section to thelogging.yamladmin guide.What's covered
accept/rejectnever drops the event.Verification
The example config and its input/output table are taken directly from the existing
log-filterautest (tests/gold_tests/logging/log-filter.replays.yamlandgold/filter-test.gold), so the documented output matches what Traffic Server actually produces rather than being written from memory.No code changes; docs only.