feat: integration with dd-trace-api #12057

emmettbutler · 2025-01-23T21:06:25Z

This change adds an integration for the dd-trace-api-py package. That package is still in pre-release development, so the code this change adds will not be exercised except in CI.

The basic integration added here instruments the interface exposed by the dd-trace-api package, proxying its calls to real Tracer and Span objects. The basic functionality of tracing is implemented, including start_span, trace, finish, and current_span. More operations, like setting links or tags on spans, will be implemented in a future pull request. Other parts of the public API like Pin and data_streams will also be included in future pull requests.

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-01-23T21:07:03Z

CODEOWNERS have been resolved as:

.riot/requirements/10e65d1.txt                                          @DataDog/apm-python
.riot/requirements/1261872.txt                                          @DataDog/apm-python
.riot/requirements/14d1688.txt                                          @DataDog/apm-python
.riot/requirements/668f2f5.txt                                          @DataDog/apm-python
.riot/requirements/d5f777e.txt                                          @DataDog/apm-python
.riot/requirements/e49670c.txt                                          @DataDog/apm-python
ddtrace/contrib/internal/dd_trace_api/__init__.py                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/dd_trace_api/patch.py                          @DataDog/apm-core-python @DataDog/apm-idm-python
releasenotes/notes/dd-trace-api-integration-0fa7ea051a4d6ce1.yaml       @DataDog/apm-python
tests/contrib/dd_trace_api/__init__.py                                  @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/dd_trace_api/test_dd_trace_api_patch.py                   @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/dd_trace_api/test_integration.py                          @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/_monkey.py                                                      @DataDog/apm-core-python
lib-injection/sources/min_compatible_versions.csv                       @DataDog/apm-core-python
min_compatible_versions.csv                                             @DataDog/apm-core-python
riotfile.py                                                             @DataDog/apm-python
tests/contrib/suitespec.yml                                             @DataDog/apm-core-python @DataDog/apm-idm-python

pr-commenter · 2025-01-23T22:30:02Z

Benchmarks

Benchmark execution time: 2025-02-05 17:30:28

Comparing candidate commit 0e679f8 in PR branch emmett.butler/dd-trace-api-integration with baseline commit af9098c in branch main.

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

datadog-dd-trace-py-rkomorn · 2025-01-24T17:57:59Z

Datadog Report

Branch report: emmett.butler/dd-trace-api-integration
Commit report: db87343
Test service: dd-trace-py

✅ 0 Failed, 130 Passed, 1468 Skipped, 4m 38.63s Total duration (35m 46.84s time saved)

tests/contrib/dd_trace_api/test_integration.py

datadog-datadog-prod-us1 · 2025-01-28T21:02:48Z

tests/contrib/dd_trace_api/test_integration.py

+    def test_set_exc_info(self):
+        with dd_trace_api.tracer.trace("web.request") as span:
+            try:
+                raise Exception


⚪ Code Quality Violation

Exception is too generic (...read more)

Do not raise Exception and BaseException. These are too generic. Having generic exceptions makes it difficult to differentiate errors in a program. Use a specific exception, for example, ValueError, or create your own instead of using generic ones.

Learn More

Stop using raise Exception

datadog-datadog-prod-us1 · 2025-01-29T14:32:34Z

tests/contrib/dd_trace_api/test_integration.py

+    def test_set_traceback(self):
+        with dd_trace_api.tracer.trace("web.request") as span:
+            try:
+                raise Exception


⚪ Code Quality Violation

Exception is too generic (...read more)

Do not raise Exception and BaseException. These are too generic. Having generic exceptions makes it difficult to differentiate errors in a program. Use a specific exception, for example, ValueError, or create your own instead of using generic ones.

Learn More

Stop using raise Exception

… value of tracer.wrap

ddtrace/contrib/dd_trace_api/__init__.py

brettlangdon · 2025-02-04T19:21:26Z

ddtrace/contrib/internal/dd_trace_api/patch.py

+    return getattr(dd_trace_api, "__version__", "")
+
+
+def patch(tracer=None):


I am not sure the integration patch/unpatch approach makes sense here, should we always register an audit hook that listens for these events?

are there ever any cases when we wouldn't want to listen to the events? it would probably be better to have dd_trace_api not emit events if you want to "disable" vs having that handled here.

patch, unpatch and get_version are here just to make this code work with the existing contrib structure. The contrib is enabled by default, and it can be disabled by the same method as any other default-on contrib. As far as I can tell, this code makes sense as a contrib because that provides lazy loading.

yeah, the lazy loading makes sense, but I am not sure we should provide all the same functionality, like DD_DD_TRACE_API_ENABLED=false or DD_PATCH_MODULES=dd_trace_api:false or patch_all(dd_trace_api=False), etc (or w/e all those options are).

lazy loading, reporting usage and the version to telemetry both definitely make sense.

ddtrace/contrib/internal/dd_trace_api/patch.py

brettlangdon · 2025-02-05T15:37:08Z

ddtrace/contrib/internal/dd_trace_api/patch.py

+    return getattr(dd_trace_api, "__version__", "")
+
+
+def patch(tracer=None):


yeah, the lazy loading makes sense, but I am not sure we should provide all the same functionality, like DD_DD_TRACE_API_ENABLED=false or DD_PATCH_MODULES=dd_trace_api:false or patch_all(dd_trace_api=False), etc (or w/e all those options are).

lazy loading, reporting usage and the version to telemetry both definitely make sense.

ddtrace/contrib/internal/dd_trace_api/patch.py

stub integration with dd-trace-api

eb66781

emmettbutler requested review from a team as code owners January 23, 2025 21:06

emmettbutler requested review from sanchda, christophe-papazian, erikayasuda and wconti27 January 23, 2025 21:06

emmettbutler marked this pull request as draft January 23, 2025 21:06

a basic but valid failing test

198aaa9

emmettbutler added 6 commits January 24, 2025 08:17

fleshing out the test setup

d60b73c

working on the dummy tracer...

4e1004d

store tracer globally

dae3efd

pull from github

3e40d48

add dd_trace_api integration to CI

181b1c1

linting

ffc79e5

emmettbutler added 5 commits January 24, 2025 10:00

enable snapshots

89e04a1

doesnt work on 3.7

9bc3423

stub verification

60ca763

stub verification

4ffec90

only hook once

b1db4dc

datadog-datadog-prod-us1 bot reviewed Jan 24, 2025

View reviewed changes

tests/contrib/dd_trace_api/test_integration.py Show resolved Hide resolved

more generic code

d1a7353

emmettbutler changed the title ~~stub integration with dd-trace-api~~ feat: integration with dd-trace-api Jan 27, 2025

emmettbutler added 3 commits January 27, 2025 07:48

methods on real spans to avoid bookkeeping

1b3cec2

current_span APIs

d3a6196

use singleton tracer

026c06d

emmettbutler added 5 commits January 27, 2025 10:01

convert stubs to real spans when passed to API functions

e1f1a68

slight refactors

36cdb43

remove some duplication from handlers list

9bba449

remove some duplication from handlers list

2448b3e

reno

35d8a49

emmettbutler marked this pull request as ready for review January 27, 2025 19:54

emmettbutler requested a review from brettlangdon January 27, 2025 19:55

emmettbutler and others added 5 commits January 27, 2025 12:51

Merge branch 'main' into emmett.butler/dd-trace-api-integration

66bdb34

simplify

b787857

simplify

86d69dd

unused import

bae4cac

some more tests

ee4492c

datadog-datadog-prod-us1 bot reviewed Jan 28, 2025

View reviewed changes

Merge branch 'main' into emmett.butler/dd-trace-api-integration

50ce3bd

datadog-datadog-prod-us1 bot reviewed Jan 29, 2025

View reviewed changes

emmettbutler and others added 4 commits January 31, 2025 09:49

Merge branch 'main' into emmett.butler/dd-trace-api-integration

abca08f

add patching for tracer.wrap, which requires API accessing the return…

17552de

… value of tracer.wrap

remove tests for removed functionality

d147067

remove tests

db87343

brettlangdon reviewed Feb 4, 2025

View reviewed changes

code organization

e043f22

emmettbutler requested a review from brettlangdon February 4, 2025 20:12

brettlangdon reviewed Feb 5, 2025

View reviewed changes

emmettbutler added 3 commits February 5, 2025 07:45

no shared state

5540bd1

update requirements

acac914

one hook name

0e679f8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: integration with dd-trace-api #12057

feat: integration with dd-trace-api #12057

emmettbutler commented Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

pr-commenter bot commented Jan 23, 2025 •

edited

Loading

datadog-dd-trace-py-rkomorn bot commented Jan 24, 2025 •

edited

Loading

datadog-datadog-prod-us1 bot Jan 28, 2025

datadog-datadog-prod-us1 bot Jan 29, 2025

brettlangdon Feb 4, 2025

emmettbutler Feb 4, 2025

brettlangdon Feb 5, 2025

brettlangdon Feb 5, 2025

		return getattr(dd_trace_api, "__version__", "")


		def patch(tracer=None):

feat: integration with dd-trace-api #12057

Are you sure you want to change the base?

feat: integration with dd-trace-api #12057

Conversation

emmettbutler commented Jan 23, 2025 • edited Loading

Checklist

Reviewer Checklist

github-actions bot commented Jan 23, 2025 • edited Loading

pr-commenter bot commented Jan 23, 2025 • edited Loading

Benchmarks

datadog-dd-trace-py-rkomorn bot commented Jan 24, 2025 • edited Loading

Datadog Report

datadog-datadog-prod-us1 bot Jan 28, 2025

Choose a reason for hiding this comment

⚪ Code Quality Violation

Learn More

datadog-datadog-prod-us1 bot Jan 29, 2025

Choose a reason for hiding this comment

⚪ Code Quality Violation

Learn More

brettlangdon Feb 4, 2025

Choose a reason for hiding this comment

emmettbutler Feb 4, 2025

Choose a reason for hiding this comment

brettlangdon Feb 5, 2025

Choose a reason for hiding this comment

brettlangdon Feb 5, 2025

Choose a reason for hiding this comment

emmettbutler commented Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

pr-commenter bot commented Jan 23, 2025 •

edited

Loading

datadog-dd-trace-py-rkomorn bot commented Jan 24, 2025 •

edited

Loading