Repository navigation
fix: redact sensitive url query values and pymongo document values in exception messages - #496
Merged
Conversation
… exception messages requests exception messages include the url of the request with its query string, e.g. the signature and session token of a presigned S3 url, while the url recorded by the requests patch has the query string removed. pymongo exception messages include the server error document, with the value that failed document validation (consideredValue), which can be a value already stored in the document, duplicate key values and failed operations (op), which the failure metadata no longer records since #495. Both were recorded as is whenever the exception went through a traced function or framework middleware. Redact exception messages when they are recorded with a list of rules, which record redacted values as REDACTED: - pymongo errors: like the failure metadata, keep only the ok, code, codeName, errorLabels and errtype values of the error document, also of the error that caused the exception, and the position of write errors in a bulk write, and redact the other values, and the duplicate key values in the server message, which is otherwise kept. A pymongo listener that records full documents (record_full_documents=True) stops this in the whole process. - all errors: the values of a list of sensitive url query parameters, e.g. of presigned urls, keeping the keys, e.g. "Max retries exceeded with url: /object.txt?X-Amz-Signature=REDACTED" Messages are not recorded if a rule fails.
mxiamxia
approved these changes
Oct 20, 2026
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.
Issue #, if available: n/a
Description of changes:
Follow-up to #495. Recorded exception messages still included sensitive values:
http.urldrops the query.consideredValue,keyValue,op) anddup keyvalues, which fix(pymongo): don't record failure document values by default #495 removed from the failure metadata.insert_one/update_onefailures never reachfailed().Heads-up: these values are now recorded as
REDACTED, with keys kept, e.g.?X-Amz-Signature=REDACTEDorfull error: {'ok': 0.0, 'errmsg': 'REDACTED', 'code': 121, 'codeName': 'DocumentValidationFailure', 'errInfo': 'REDACTED'}. A pymongo listener withrecord_full_documents=Trueturns off the pymongo part for the whole process.Changes:
core/utils/redaction.py: an extensible list of sensitive query parameters (SigV2/SigV4 presigned urls,token), masked in every recorded messagecore/models/throwable.py: redaction rules run when an exception is recorded; pymongo documents keep the fields of fix(pymongo): don't record failure document values by default #495; the message is dropped if a rule failsTesting:
Follow-up: release needed after merge, together with #495.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.