feat: support dbm full and service mode propagation for pymongo by lu-zhengda · Pull Request #12680 · DataDog/dd-trace-py

lu-zhengda · 2025-03-07T21:22:53Z

Description

This PR adds Database Monitoring (DBM) propagation support for pymongo. It enables linking MongoDB queries to DBM samples by injecting trace and span information as comments into MongoDB commands.
Two propagation modes are supported:

Full mode: Injects both service information and trace context
Service mode: Injects only service information

Version Support

Note: This feature requires PyMongo 3.9 and above. DBM propagation will be automatically disabled for PyMongo versions < 3.9.

Motivation

By linking traces to database queries, users can:

Correlate slow database operations with specific application requests
Identify which services generate problematic queries
Understand the full context of database operations

Configuration

Control with the DD_DBM_PROPAGATION_MODE environment variable:

DD_DBM_PROPAGATION_MODE=full|service|disabled

DD_DBM_PROPAGATION_MODE is disabled by default.

Checklist

PR author has checked that all the criteria below are met
The PR description includes an overview of the change
The PR description articulates the motivation for the change
The change includes tests OR the PR description describes a testing strategy
The PR description notes risks associated with the change, if any
Newly-added code is easy to change
The change follows the library release note guidelines
The change includes or references documentation updates if necessary
Backport labels are set (if applicable)

Reviewer Checklist

Reviewer has checked that all the criteria below are met
Title is accurate
All changes are related to the pull request's stated goal
Avoids breaking API changes
Testing strategy adequately addresses listed risks
Newly-added code is easy to change
Release note makes sense to a user of the library
If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
Backport labels are set in a manner that is consistent with the release branch maintenance policy

github-actions · 2025-03-07T21:23:23Z

CODEOWNERS have been resolved as:

releasenotes/notes/add-mongodb-dbm-propagation-support-3ff0f1423cafda8a.yaml  @DataDog/apm-python
ddtrace/contrib/internal/pymongo/client.py                              @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/pymongo/patch.py                               @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/propagation/_database_monitoring.py                             @DataDog/apm-sdk-api-python
ddtrace/vendor/sqlcommenter/__init__.py                                 @DataDog/apm-core-python
docker-compose.yml                                                      @DataDog/apm-core-python
tests/contrib/pymongo/test.py                                           @DataDog/apm-core-python @DataDog/apm-idm-python

ddtrace/vendor/sqlcommenter/__init__.py

pr-commenter · 2025-03-07T22:07:03Z

Benchmarks

Benchmark execution time: 2025-04-08 17:12:04

Comparing candidate commit c11c773 in PR branch zhengda.lu/mongo-dbm-propagation with baseline commit 46958d6 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 496 metrics, 2 unstable metrics.

docker-compose.yml

ddtrace/vendor/sqlcommenter/__init__.py

wconti27

LGTM

lu-zhengda · 2025-04-08T14:22:17Z

/merge

dd-devflow · 2025-04-08T14:22:24Z

View all feedbacks in Devflow UI.

2025-04-08 14:22:24 UTC ℹ️ Start processing command /merge

2025-04-08 14:22:43 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-04-08 17:14:11 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in main is approximately 0s (p90).

2025-04-08 17:37:04 UTC ℹ️ MergeQueue: This merge request was already merged

This pull request was merged directly.

github-actions · 2025-04-08T15:05:08Z

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 238 ± 5 ms.

The average import time from base is: 245 ± 4 ms.

The import time difference between this PR and base is: -6.9 ± 0.2 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.221 ms (0.93%)

ddtrace.bootstrap.sitecustomize 1.539 ms (0.65%)

ddtrace.bootstrap.preload 1.539 ms (0.65%)

ddtrace.internal.products 1.539 ms (0.65%)

ddtrace.internal.remoteconfig.client 0.722 ms (0.30%)

ddtrace 0.682 ms (0.29%)

lu-zhengda added 11 commits March 7, 2025 15:18

inject trace as comment into mongodb cmd

1374c66

add temporary logging

07fe461

add more logging

9fca7ad

dispatch dbm

6711daf

dbm dispatch for read operations

bfc48ee

instrument read operations

d1960bf

fix set op argument

d01750d

add more logs

c4ad629

instrument query and getmore

758635e

enable dbm full and service mode propagation for mongodb operations

79a7026

add release note

2223210

lu-zhengda requested review from a team as code owners March 7, 2025 21:22

lu-zhengda requested review from emmettbutler, juanjux, rachelyangdog and wconti27 March 7, 2025 21:22

datadog-datadog-prod-us1 bot reviewed Mar 7, 2025

View reviewed changes

ddtrace/vendor/sqlcommenter/__init__.py Outdated Show resolved Hide resolved

remove debug logging

cf61e0c

lu-zhengda changed the title ~~feat: Support DBM full and service mode propagation for pymongo~~ feat: support dbm full and service mode propagation for pymongo Mar 7, 2025

use fstr

68b7a57

lu-zhengda marked this pull request as draft March 7, 2025 21:44

remove log

77c42b5

lu-zhengda added 3 commits March 7, 2025 22:29

skip pymongo version lower than 3.9

0492fe3

import pytest

520b8bb

test on old pymongo versions

11790c3

lu-zhengda marked this pull request as ready for review March 10, 2025 17:17

emmettbutler approved these changes Mar 13, 2025

View reviewed changes

docker-compose.yml Show resolved Hide resolved

ddtrace/vendor/sqlcommenter/__init__.py Show resolved Hide resolved

rachelyangdog approved these changes Apr 7, 2025

View reviewed changes

lu-zhengda enabled auto-merge (squash) April 7, 2025 22:20

wconti27 approved these changes Apr 8, 2025

View reviewed changes

lu-zhengda disabled auto-merge April 8, 2025 14:21

dd-devflow bot added the mergequeue-status: waiting label Apr 8, 2025

lu-zhengda added 2 commits April 8, 2025 10:42

trigger ci

43ede12

Merge branch 'main' into zhengda.lu/mongo-dbm-propagation

c11c773

dd-devflow bot added mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: waiting mergequeue-status: queued labels Apr 8, 2025

lu-zhengda merged commit 32d1e53 into main Apr 8, 2025
689 checks passed

lu-zhengda deleted the zhengda.lu/mongo-dbm-propagation branch April 8, 2025 17:36

dd-devflow bot added mergequeue-status: done and removed mergequeue-status: in_progress labels Apr 8, 2025

Yoone mentioned this pull request Sep 22, 2025

Add support for DBM comment injection with MongoDB DataDog/dd-trace-java#9589

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support dbm full and service mode propagation for pymongo#12680

feat: support dbm full and service mode propagation for pymongo#12680
lu-zhengda merged 19 commits intomainfrom
zhengda.lu/mongo-dbm-propagation

lu-zhengda commented Mar 7, 2025 •

edited by rachelyangdog

Loading

Uh oh!

github-actions bot commented Mar 7, 2025

Uh oh!

Uh oh!

pr-commenter bot commented Mar 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

wconti27 left a comment

Uh oh!

lu-zhengda commented Apr 8, 2025

Uh oh!

dd-devflow bot commented Apr 8, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

lu-zhengda commented Mar 7, 2025 • edited by rachelyangdog Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Version Support

Motivation

Configuration

Checklist

Reviewer Checklist

Uh oh!

github-actions bot commented Mar 7, 2025

Uh oh!

Uh oh!

pr-commenter bot commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Uh oh!

Uh oh!

Uh oh!

wconti27 left a comment

Choose a reason for hiding this comment

Uh oh!

lu-zhengda commented Apr 8, 2025

Uh oh!

dd-devflow bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bootstrap import analysis

Summary

Import time breakdown

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lu-zhengda commented Mar 7, 2025 •

edited by rachelyangdog

Loading

pr-commenter bot commented Mar 7, 2025 •

edited

Loading

dd-devflow bot commented Apr 8, 2025 •

edited

Loading

github-actions bot commented Apr 8, 2025 •

edited

Loading