chore(tracing): refactor web server integrations to use the core module #12035

wconti27 · 2025-01-22T20:11:01Z

Motivation

Refactors all web server integrations still using tracer.trace to instead use core.context_with_data. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path.

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-22T20:11:29Z

CODEOWNERS have been resolved as:

ddtrace/_trace/trace_handlers.py                                        @DataDog/apm-sdk-api-python
ddtrace/contrib/internal/aiohttp/middlewares.py                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/bottle/trace.py                                @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/cherrypy/middleware.py                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/falcon/middleware.py                           @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/molten/patch.py                                @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/pyramid/trace.py                               @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/sanic/patch.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
tests/snapshots/tests.contrib.cherrypy.test_middleware.test_child.json  @DataDog/apm-python
tests/snapshots/tests.contrib.cherrypy.test_middleware.test_error.json  @DataDog/apm-python
tests/snapshots/tests.contrib.cherrypy.test_middleware.test_fatal.json  @DataDog/apm-python
tests/snapshots/tests.contrib.cherrypy.test_middleware.test_success.json  @DataDog/apm-python
tests/snapshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http.json  @DataDog/apm-python
tests/snapshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json  @DataDog/apm-python
tests/snapshots/tests.contrib.sanic.test_sanic_server.test_sanic_errors.json  @DataDog/apm-python
tests/snapshots/tests.contrib.sanic.test_sanic_server.test_sanic_errors_pre_21.9.json  @DataDog/apm-python

datadog-dd-trace-py-rkomorn · 2025-01-22T21:18:27Z

Datadog Report

Branch report: conti/standardize-web-frameworks-to-use-core
Commit report: d4eb587
Test service: dd-trace-py

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

pr-commenter · 2025-01-22T21:44:38Z

Benchmarks

Benchmark execution time: 2025-01-27 22:30:10

Comparing candidate commit 7179a3d in PR branch conti/standardize-web-frameworks-to-use-core with baseline commit e3045a1 in branch main.

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

scenario:iast_aspects-ospathjoin_aspect

🟥 execution_time [+449.748ns; +517.137ns] or [+8.688%; +9.989%]

datadog-dd-trace-py-rkomorn · 2025-01-23T14:29:04Z

Datadog Report

Branch report: conti/standardize-web-frameworks-to-use-core
Commit report: 7179a3d
Test service: dd-trace-py

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

...pshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json

ddtrace/_trace/trace_handlers.py

wantsui

👏 👏 👏 👏

ddtrace/_trace/trace_handlers.py

...pshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json

ddtrace/contrib/internal/falcon/middleware.py

wconti27 · 2025-01-27T20:31:52Z

/merge

dd-devflow · 2025-01-27T20:32:10Z

Devflow running: `/merge`

View all feedbacks in Devflow UI.

2025-01-27 20:32:10 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-01-27 22:32:09 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 0s.

2025-01-28 00:32:31 UTC ❌ MergeQueue: The build pipeline has timeout

The merge request has been interrupted because the build took longer than expected. The current limit for the base branch 'main' is 120 minutes.

…le (#12035) ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

…le (#12035) ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) (cherry picked from commit 55767a7)

…le (#12035) ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

…le (#12035) ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) (cherry picked from commit 55767a7)

…le (#12035) ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

…le [forwardport 3.x] (#12164) Forwardporting #12035 ## Motivation Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. ## Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) (cherry picked from commit 55767a7) Co-authored-by: William Conti <[email protected]>

…le (#12035) Refactors all web server integrations still using `tracer.trace` to instead use `core.context_with_data`. This is in preparation for supporting AWS API Gateway to ensure all web servers share the same code path. - [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) - [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) 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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

…ore module (#12035)" This reverts commit fdf7694.

initial refactoring

5b7673e

wconti27 added 2 commits January 22, 2025 15:50

refactor

a189c45

add cherrypy and bottle

7a1fb99

complete refactor

2f56812

wconti27 added 3 commits January 22, 2025 16:48

fix failures

05b064d

fix falcon

d4eb587

fix remaining errors

8f7b6d3

wconti27 changed the title ~~initial refactoring~~ tracing: refactor web server integrations to use the core module Jan 23, 2025

Merge branch 'main' into conti/standardize-web-frameworks-to-use-core

9b6e138

wconti27 self-assigned this Jan 23, 2025

wconti27 added the changelog/no-changelog A changelog entry is not required for this PR. label Jan 23, 2025

wconti27 changed the title ~~tracing: refactor web server integrations to use the core module~~ chore(tracing): refactor web server integrations to use the core module Jan 23, 2025

wconti27 added 2 commits January 23, 2025 09:48

update finish code and setting http tags

9ad3ba2

fix falcon

200f853

wconti27 marked this pull request as ready for review January 23, 2025 15:12

wconti27 requested review from a team as code owners January 23, 2025 15:12

wconti27 requested review from ZStriker19, erikayasuda and quinna-h January 23, 2025 15:12

emmettbutler self-requested a review January 23, 2025 15:30

emmettbutler approved these changes Jan 23, 2025

View reviewed changes

...pshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json Show resolved Hide resolved

ddtrace/_trace/trace_handlers.py Show resolved Hide resolved

wantsui approved these changes Jan 23, 2025

View reviewed changes

ddtrace/_trace/trace_handlers.py Outdated Show resolved Hide resolved

...pshots/tests.contrib.sanic.test_sanic_server.test_multiple_requests_sanic_http_pre_21.9.json Show resolved Hide resolved

wantsui reviewed Jan 23, 2025

View reviewed changes

ddtrace/contrib/internal/falcon/middleware.py Show resolved Hide resolved

dd-devflow bot added the mergequeue-status: waiting label Jan 27, 2025

Merge branch 'main' into conti/standardize-web-frameworks-to-use-core

78b9a5f

dd-devflow bot added mergequeue-status: removed and removed mergequeue-status: waiting labels Jan 27, 2025

dd-devflow bot added mergequeue-status: waiting and removed mergequeue-status: removed labels Jan 27, 2025

Merge branch 'main' into conti/standardize-web-frameworks-to-use-core

7179a3d

dd-devflow bot added mergequeue-status: queued mergequeue-status: in_progress mergequeue-status: rejected and removed mergequeue-status: waiting mergequeue-status: queued mergequeue-status: in_progress labels Jan 27, 2025

wconti27 merged commit 55767a7 into main Jan 28, 2025
654 of 655 checks passed

wconti27 deleted the conti/standardize-web-frameworks-to-use-core branch January 28, 2025 13:44

erikayasuda mentioned this pull request Jan 30, 2025

chore(tracing): refactor web server integrations to use the core module [forwardport 3.x] #12144

Closed

4 tasks

erikayasuda mentioned this pull request Jan 30, 2025

chore(tracing): refactor web server integrations to use the core module [forwardport 3.x] #12164

Merged

2 tasks

avara1986 added a commit that referenced this pull request Feb 4, 2025

Revert "chore(tracing): refactor web server integrations to use the c…

f6a2597

…ore module (#12035)" This reverts commit fdf7694.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(tracing): refactor web server integrations to use the core module #12035

chore(tracing): refactor web server integrations to use the core module #12035

wconti27 commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

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

edited

Loading

pr-commenter bot commented Jan 22, 2025 •

edited

Loading

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

edited

Loading

wantsui left a comment

wconti27 commented Jan 27, 2025

dd-devflow bot commented Jan 27, 2025 •

edited

Loading

chore(tracing): refactor web server integrations to use the core module #12035

chore(tracing): refactor web server integrations to use the core module #12035

Conversation

wconti27 commented Jan 22, 2025 • edited Loading

Motivation

Checklist

Reviewer Checklist

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

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

Datadog Report

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

Benchmarks

scenario:iast_aspects-ospathjoin_aspect

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

Datadog Report

wantsui left a comment

Choose a reason for hiding this comment

wconti27 commented Jan 27, 2025

dd-devflow bot commented Jan 27, 2025 • edited Loading

Devflow running: /merge

wconti27 commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

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

edited

Loading

pr-commenter bot commented Jan 22, 2025 •

edited

Loading

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

edited

Loading

dd-devflow bot commented Jan 27, 2025 •

edited

Loading

Devflow running: `/merge`