PYTHON-5846 Consolidate CMAP, heartbeat, and SDAM telemetry into _telemetry.py by blink1073 · Pull Request #15 · blink1073/mongo-python-driver

blink1073 · 2026-06-30T13:36:20Z

Changes in this PR

Building on PYTHON-5745, adds _CmapTelemetry, _HeartbeatTelemetry, and _SdamTelemetry classes to pymongo/_telemetry.py to consolidate the remaining APM event publishing and structured logging across pool.py, monitor.py, topology.py, and server.py.

Test Plan

just typing-mypy passes.
Pre-commit hooks pass.
Existing CMAP, SDAM, and heartbeat monitoring tests cover the consolidated code paths.

Checklist

Checklist for Author

Did you update the changelog (if necessary)?
Is there test coverage?
Is any followup work tracked in a JIRA ticket? If so, add link(s).

…emetry.py Add _CmapTelemetry, _HeartbeatTelemetry, and _SdamTelemetry classes to eliminate the repetitive if-enabled_for_cmap / if-logger.isEnabledFor boilerplate spread across pool.py, monitor.py, topology.py, and server.py.

mongodb#2900)

- Rename _CmapTelemetry._log -> _emit_log for consistency with _CommandTelemetry - Rename _HeartbeatTelemetry.apm_started -> started to match started/succeeded/failed lifecycle - Rename _HeartbeatTelemetry.log_started -> emit_started_log to signal it is the deferred log-only half - Replace is_sdam flag with separate publish/log bool parameters on _CmapTelemetry

mongodb#2905)

_CmapTelemetry now owns connection-creation and checkout durations: connection_created() starts the clock, connection_ready() computes it; checkout_started() starts the clock, checkout_succeeded/failed() compute it. _HeartbeatTelemetry.started() starts the clock; failed() computes its own duration instead of receiving it as a parameter. Removes checkout_started_time from Pool._get_conn, _raise_if_not_ready, and _raise_wait_queue_timeout, and removes AsyncConnection.creation_time.

Use response.awaitable (ground truth from wire) rather than self._awaited (pre-computed before response) for ServerHeartbeatSucceededEvent.awaited. Also fix stale method references in _HeartbeatTelemetry docstring.

…emetry

…seconds)

_CmapTelemetry, _HeartbeatTelemetry, and _SdamTelemetry now compute _should_publish and _should_log as properties that check listener state and logger level at call time rather than caching derived booleans in the constructor.

…listeners

…to _telemetry.py

…y classes; document why long-lived classes use properties

…ion computation in _CmapTelemetry and _HeartbeatTelemetry

mongodb#2906)

…g in _CmapTelemetry

…ng is enabled

Co-authored-by: Noah Stapp <noah@noahstapp.com>

mongodb#2908)

- Fix race condition in _CmapTelemetry: remove shared _conn_created_start and _checkout_start slots; connection_ready now takes creation_time from AsyncConnection.creation_time, checkout_started returns the start time and checkout_succeeded/failed accept it as a parameter - Move SRV monitor failure log into _telemetry.py as log_srv_monitor_failure - Add _log_retry helper to _ClientConnectionRetryable to deduplicate log_command_retry call sites - Fix _ServerSelectionTelemetry.failed to accept live topology_description at failure time instead of using the stale snapshot from construction

- Restore original _raise_if_not_ready and _get_conn parameter names/order - Add docstrings to all public methods on _CmapTelemetry and _SdamTelemetry - Remove redundant _publish/_listener/_events attrs from Server.__init__ - Avoid creating two _ServerSelectionTelemetry per select_server call by threading ss through select_servers and _select_server - Make _ServerSelectionTelemetry.failed topology_description a required arg - Move SRV monitor failure log to telemetry.py (log_srv_monitor_failure)

…t_servers/_select_server

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

)

…ongodb#2920)

…ongodb#2801) Co-authored-by: Steven Silvester <steve.silvester@mongodb.com>

…into PYTHON-5846

…tion

blink1073 and others added 30 commits June 30, 2026 08:27

PYTHON-5900 - Clarify Cursor and CommandCursor docstrings to indicate… (

bb7a81f

mongodb#2900)

PYTHON-5911 - Mark test.test_server_selection_in_window.TestProse.tes… (

bde775e

mongodb#2905)

PYTHON-5846 Fix awaited value in heartbeat succeeded APM event

a30d380

Use response.awaitable (ground truth from wire) rather than self._awaited (pre-computed before response) for ServerHeartbeatSucceededEvent.awaited. Also fix stale method references in _HeartbeatTelemetry docstring.

PYTHON-5846 Add _emit_log helpers to _HeartbeatTelemetry and _SdamTel…

577b594

…emetry

PYTHON-5846 Fix durationMS unit in CMAP log entries (seconds -> milli…

fc143ff

…seconds)

PYTHON-5846 Drop publish param from _HeartbeatTelemetry, derive from …

553dc31

…listeners

PYTHON-5846 Decompose Hello response in _HeartbeatTelemetry.succeeded

0f33a1c

PYTHON-5846 Fix typing: use Hello type in _HeartbeatTelemetry.succeeded

3eefcf7

PYTHON-5846 Consolidate server selection logging and retry logging in…

d844557

…to _telemetry.py

PYTHON-5846 Move _should_log check to call site in all telemetry classes

57f4e50

PYTHON-5846 Cache _should_log/_should_publish in short-lived telemetr…

d51f38b

…y classes; document why long-lived classes use properties

PYTHON-5846 Cache _should_log/_should_publish locally and guard durat…

de14677

…ion computation in _CmapTelemetry and _HeartbeatTelemetry

PYTHON-5875 - Call setParameter on each mongos for test_connection_po… (

1ccf555

mongodb#2906)

PYTHON-5846 Add comments explaining unconditional start time recordin…

488c750

…g in _CmapTelemetry

PYTHON-5889 - Clean up AGENTS.md instructions (mongodb#2909)

ef09fdd

PYTHON-5846 Only record heartbeat start time when logging or publishi…

58e966b

…ng is enabled

PYTHON-5912 - Skip substringPreview on server 9.0+ (mongodb#2910)

f7611d1

Update pymongo/asynchronous/mongo_client.py

2746386

Co-authored-by: Noah Stapp <noah@noahstapp.com>

PYTHON-5913 - Remove synchro converted_tests and associated CONTRIBUT… (

ed81f02

mongodb#2908)

PYTHON-5846 Fix test callers to unpack (servers, ss) tuple from selec…

9fab1db

…t_servers/_select_server

PYTHON-5846 Pass live topology description to ss.succeeded()

a9cb8b2

PYTHON-5781 Coverage increase for network_layer.py (mongodb#2774)

ed6991a

Fix docstring

45ebb6b

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Bump the actions group across 1 directory with 2 updates (mongodb#2914)

4eb4d6d

Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

dependabot Bot and others added 19 commits July 6, 2026 07:37

Bump ruff from 0.15.18 to 0.15.20 (mongodb#2912)

339ab4c

Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump pyright from 1.1.410 to 1.1.411 (mongodb#2913)

a09a6bb

Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

PYTHON-5846 Initialize _HeartbeatTelemetry._start in __init__

cb8a2e8

PYTHON-5846 Update async topology docstring to match sync

bad740d

PYTHON-5799 Skip TestExplicitTextEncryptionProse tests (mongodb#2915)

c224067

Merge branch 'master' into PYTHON-5846

ef5ec33

PYTHON-5917 Fix document_class generic alias check on PyPy (mongodb#2917

a167a86

)

PYTHON-5915 - Bump cryptography version to 47.0.0 (mongodb#2911)

f8e8cff

PYTHON-5920 - Use mock instead of patching for test_network_layer.py (m…

c9b2331

…ongodb#2920)

PYTHON-5921 Validate OIDC allowed hosts before authenticator reuse (m…

7ba7481

…ongodb#2801) Co-authored-by: Steven Silvester <steve.silvester@mongodb.com>

PYTHON-5846 Replace Any with proper types in _telemetry.py

c19f936

Merge branch 'PYTHON-5846' of github.com:blink1073/mongo-python-driver …

6868db4

…into PYTHON-5846

PYTHON-5856 Move cursor execution logic into cursor class (mongodb#2894)

f9c029e

PYTHON-5327 Add test for SRV hostname validation (mongodb#2863)

64e24c9

Merge upstream/master into PYTHON-5846

25f718c

PYTHON-5846 Compute awaited at emit time in _HeartbeatTelemetry

d414fd6

PYTHON-5846 Reuse _monotonic_duration helper in _telemetry.py

e4a340a

PYTHON-5846 Remove unused _topology_id attribute from Server

55a2c16

PYTHON-5846 Make server selection succeeded logging a standalone func…

cd702c4

…tion

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PYTHON-5846 Consolidate CMAP, heartbeat, and SDAM telemetry into _telemetry.py#15

PYTHON-5846 Consolidate CMAP, heartbeat, and SDAM telemetry into _telemetry.py#15
blink1073 wants to merge 49 commits into
masterfrom
PYTHON-5846

blink1073 commented Jun 30, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

blink1073 commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes in this PR

Test Plan

Checklist

Checklist for Author

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

blink1073 commented Jun 30, 2026 •

edited

Loading