Document LoggedQuery::setRedactor()#8291
Draft
dereuromark wants to merge 1 commit into5.nextfrom
Draft
Conversation
Adds a "Redacting Sensitive Values from Query Logs" subsection under the existing Query Logging section in `orm/database-basics.md` and a matching entry in the 5.4 migration guide's Database changes. Covers what the hook is for (any secret bound as a parameter ends up in every surface that consumes a LoggedQuery), how to register one, which exit points it covers (`interpolate()`, `getContext()`, `jsonSerialize()`), and the silent-fallback behaviour for redactors that throw or return a malformed value.
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.
Documents
Cake\Database\Log\LoggedQuery::setRedactor()introduced in cakephp/cakephp#19419.Where the docs live
docs/en/orm/database-basics.md. Covers:LoggedQuery::__toString/getContext/jsonSerialize).docs/en/appendices/5-4-migration-guide.mdunder the existing Database new-features list, linking back to the new subsection.Pairs with
5.next).Filed as draft until the implementation PR merges and a target release is tagged. Will flip to "Ready for review" then.