Repository navigation
fix(pymongo): don't record failure document values by default - #495
Merged
Merged
Conversation
XrayCommandListener.failed() recorded the whole failure document even when record_full_documents=False. Server failures can echo stored document values (errInfo.consideredValue on schema validation errors, errmsg and keyValue on duplicate key errors), so by default only keep ok, code, codeName, errorLabels and errtype. The full document is still recorded with record_full_documents=True. Also add unit tests and a tox env for the pymongo patch, and document the option in docs/thirdparty.rst.
srprash
approved these changes
Oct 14, 2026
vastin
added a commit
that referenced
this pull request
Oct 20, 2026
… exception messages (#496) 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.
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:
XrayCommandListener.failed()recorded the whole pymongo failure document even withrecord_full_documents=False. Server failures can echo stored document values (errInfo.consideredValueon schema validation errors,errmsg/keyValueon duplicate key errors), which the option is meant to keep out of traces.Heads-up: by default, failure metadata now keeps only
ok,code,codeName,errorLabelsanderrtype.errmsgis no longer recorded unlessrecord_full_documents=True.Changes:
ext/pymongo/patch.py: filter failure documents unlessrecord_full_documents=True; handle non-mapping failurestests/ext/pymongoand aext-pymongotox env (no pymongo tests existed)docs/thirdparty.rst; CHANGELOG entryTesting:
tox -e py312-ext-pymongo: 12 passedFollow-up: release needed after merge.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.