logging: add replace filter for static value replacement #4029
Conversation
This file contains 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
This filter is intended to be useful in scenarios where you may want to redact a value with a static string, giving you information that the field did previously exist and was present, but not revealing the value itself in the logs. This was inspired by work on adding more complete support for removing sensitive values from logs [1]. An example use case would be the Authorization header in request log output, for which the value should usually not be logged, but it may be quite useful for debugging to confirm that the header was present in the request. [1] caddyserver#3958
|
@francislavoie @mholt let me know if there are any thoughts on this PR I can address, I had originally paired it with #4028 |
francislavoie
approved these changes
Mar 12, 2021
kujenga
added a commit
to kujenga/caddy-website
that referenced
this pull request
Mar 19, 2021
This commit corresponds with the functionality added in this PR: caddyserver/caddy#4029
mholt
pushed a commit
to caddyserver/website
that referenced
this pull request
Apr 8, 2021
* caddyfile/directives/log: add docs for new replace directive This commit corresponds with the functionality added in this PR: caddyserver/caddy#4029 * caddyfile: add documentation for new global log option This corresponds with the changes in this PR: caddyserver/caddy#4028
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.
This filter is intended to be useful in scenarios where you may want to
redact a value with a static string, giving you information that the
field did previously exist and was present, but not revealing the value
itself in the logs.
This was inspired by work on adding more complete support for removing
sensitive values from logs [1]. An example use case would be the
Authorization header in request log output, for which the value should
usually not be logged, but it may be quite useful for debugging to
confirm that the header was present in the request.
This PR was split out from #4028
[1] #3958