Inject trace info as comment to MongoDB operation when dbm propagation is enabled.

[lu-zhengda]

What does this PR do?

This PR introduces DBM propagation mode support for MongoDB operations, aligning with the existing functionality in relational database such as PostgreSQL and MySQL. DBM propagation enables linking APM traces with DBM samples through trace comment injection, providing enhanced observability into database operations.

Key Features:

• Trace Propagation via Comments:
  The tracer now supports injecting trace metadata into MongoDB commands using the comment field.
• Configurable Propagation Mode:
  Users can configure the behavior via the dbmPropagationMode setting:
  • disabled – No trace metadata is injected.
  • service – Injects only service-level information.
  • full – Injects both service and span-level information.

Example Usage:

Set dbmPropagationMode in tracer config

// Load the dd-trace library for tracing
const tracer = require("dd-trace").init({
  service: "express-mongodb-app", // Your service name
  env: "dev", // Your environment
  ......  // Your other tracer configs
  dbmPropagationMode: "full",
});

With DBM propagation enabled, MongoDB commands will include a trace comment similar to:

Motivation

Improved Traceability:
With trace information attached, MongoDB operation samples in DBM can now be linked to APM traces, allowing users to analyze query performance in the context of distributed tracing.
https://datadoghq.atlassian.net/browse/DBMON-4990

Plugin Checklist

• Unit tests.
• TypeScript definitions.
• TypeScript tests.
• API documentation.
• CircleCI jobs/workflows.
• Plugin is exported.

Additional Notes

[github-actions]

Overall package size

Self size: 8.69 MB
Deduped: 94.89 MB
No deduping: 95.41 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.4.0 | 29.44 MB | 29.44 MB | | @datadog/native-appsec | 8.4.0 | 19.25 MB | 19.26 MB | | @datadog/native-iast-taint-tracking | 3.3.0 | 13.77 MB | 13.78 MB | | @datadog/pprof | 5.5.1 | 9.79 MB | 10.17 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.8.0 | 2.6 MB | 2.74 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 3.1.0 | 1.06 MB | 1.46 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.11.2 | 112.74 kB | 835.4 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | semifies | 1.0.0 | 15.84 kB | 15.84 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | ttl-set | 1.0.0 | 4.61 kB | 9.69 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

_{🤖 This report was automatically generated by heaviest-objects-in-the-universe}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.25%. Comparing base (b8c03bd) to head (5f8d92d).
Report is 13 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5230      +/-   ##
==========================================
+ Coverage   81.09%   81.25%   +0.15%     
==========================================
  Files         480      487       +7     
  Lines       21438    21715     +277     
==========================================
+ Hits        17386    17645     +259     
- Misses       4052     4070      +18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[datadog-datadog-prod-us1]

Datadog Report

Branch report: zhengda.lu/mongo-dbm-trace
Commit report: dafd69c
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 625 Passed, 0 Skipped, 12m 29.29s Total Time

[pr-commenter]

Benchmarks

Benchmark execution time: 2025-02-14 17:10:26

Comparing candidate commit 5f8d92d in PR branch zhengda.lu/mongo-dbm-trace with baseline commit b8c03bd in branch master.

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

[wconti27]

The tests and plugin change looks good to me. But we should put the injection functionality within the same function as the existing DBM propagation.

[tlhunter]

Left some comments requesting changes

[lu-zhengda]

bump mongo image to 4.4 because prior to 4.4 only str comments are allowed. newer mongo version allows us to test array comments.

[wconti27]

LGTM, thanks for making those changes!

changes addressed