PYTHON-5745 Consolidate command logging and monitoring logic#2822
Draft
blink1073 wants to merge 22 commits into
Draft
PYTHON-5745 Consolidate command logging and monitoring logic#2822blink1073 wants to merge 22 commits into
blink1073 wants to merge 22 commits into
Conversation
blink1073
changed the title
blink1073
commented
May 28, 2026
| try: | ||
| result = await bwc.conn.unack_write(msg, max_doc_size) # type: ignore[func-returns-value, misc, override] | ||
| duration = datetime.datetime.now() - bwc.start_time | ||
| if result is not None: |
Member
Author
There was a problem hiding this comment.
A note about this block and the equivalent in client_bulk.py: unack_write always returns None so there will never be a result. The spec says that we always need to emit a log, so this logic was incorrect before.
…n _CommandTelemetry
…etwork.command signature - _CommandTelemetry now accepts a conn object and reads topology_id, address, connection IDs, service_id, and listeners directly from it - network.command() no longer accepts is_mongos, address, max_bson_size, compression_ctx, use_op_msg, or unacknowledged — all read from conn - _CommandTelemetry lifecycle moved into AsyncConnection.write_command and AsyncConnection.unack_write; bulk.py and client_bulk.py simplified accordingly - Sync files regenerated via synchro.sh; all files formatted with ruff 0.1.3
- Revert files that had only ruff formatting whitespace changes (not part of this PR's scope) - Remove AsyncMongoClient._topology_id (no longer needed since _CommandTelemetry reads topology_id directly from the connection's pool reference) - Update _CommandTelemetry docstring to reflect new conn-based API
…e files Restore gridfs/grid_file_shared.py, pymongo/message.py, change_stream.py, client_session.py, monitor.py, and all test files to master state — these were modified by earlier branch commits that are not part of this PR's scope.
…sses These were lost when pymongo/message.py was reverted to master. prepare_command extracts the field-setting logic that _CommandTelemetry needs to see the complete command spec before publishing started events.
…sing cases unasync raises import-not-found when absent (CI) and import-untyped when present but untyped (local). Suppress both codes and add a mypy override for the synchro module to allow whichever is unused in each environment.
…command logging Restore original behavior where network.command() only emits debug log messages when a client is present. Internal pool commands (hello/ismaster handshake) pass client=None and should not appear in command logs.
…te contexts These methods published command events directly; they are now superseded by _CommandTelemetry and are no longer called anywhere.
Ruff introduced blank lines between module docstrings and `from __future__ import annotations` in bulk.py, client_bulk.py, network.py, and server.py. Remove them to match master's style.
Assign is_mongos, use_op_msg, max_bson_size from conn at the top of the function so the rest of the body uses the same local names as before, keeping the diff minimal.
Add AsyncConnection.run_operation() that owns the _CommandTelemetry context, send/receive, unpack, and error checking for find/getMore operations. handle_succeeded() now returns the elapsed duration so callers don't need a separate datetime.now() call. Server.run_operation() is simplified to delegate to the new method and handle decryption and Response construction.
…_operation
- Replace write_command and unack_write with a single bulk_write_command
that takes acknowledged=True keyword parameter; when False, sends
without waiting for a reply and returns synthetic {"ok": 1}
- Rename run_operation to cursor_operation
- Update all call sites in bulk.py, client_bulk.py, and server.py
…Telemetry bulk_write_command and cursor_operation become free functions in network.py (alongside the existing command function), consolidating all _CommandTelemetry usage in one module. _CURSOR_DOC_FIELDS moves there too. AsyncConnection loses those methods and the imports they required (_CommandTelemetry, timedelta, Callable, _GetMore, _Query, _DocumentOut).
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
2 participants
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.
[PYTHON-5745]
Changes in this PR
Introduces
pymongo/_telemetry.pywith a_CommandTelemetrycontext manager that unifies debug logging and APM event publishing into a single call site, eliminating duplicated telemetry blocks at each command call site. This is a prerequisite for PYTHON-5052 (OpenTelemetry support).Based on the spike in #2720.
Test Plan
just typingpassesjust lintpassesChecklist
Checklist for Author
Checklist for Reviewer