Skip to content

Conversation

@crysmags
Copy link
Collaborator

What does this PR do?

When OpenTelemetry TracerProvider was enabled, Next.js routes showed only HTTP method as resource name ("GET") instead of full path ("GET /api/hello").

Motivation

This is related to #1750 and escalation https://datadoghq.atlassian.net/browse/APMS-17880.

Root Cause
The Next.js plugin builds resource names in two stages:
bindStart() - Creates HTTP span with method-only resource name
pageLoad() - Updates with full path
The plugin stored requests in a WeakMap using span objects as keys: this._requests.set(span, req).
When TracerProvider enabled, OTel creates child spans (e.g., "resolve page components") that become active in async context between bindStart and pageLoad. The pageLoad method would then retrieve a different span object (the child) from storage, causing WeakMap lookup to fail since it requires an exact object identity (===).
This is a change from an object-based WeakMap to ID-based Map with parent span fallback in order to handle the case where a child span is created and the context storage has changed. There is a cleanup in finish that will prevent memory leaks since we are now using a Map.

@codecov
Copy link

codecov bot commented Nov 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.34%. Comparing base (31a2890) to head (e7bd3b8).

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #7000       +/-   ##
===========================================
- Coverage   84.80%   60.34%   -24.47%     
===========================================
  Files         514      162      -352     
  Lines       21987     6216    -15771     
===========================================
- Hits        18646     3751    -14895     
+ Misses       3341     2465      -876     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

github-actions bot commented Nov 26, 2025

Overall package size

Self size: 13.63 MB
Deduped: 113.82 MB
No deduping: 128.84 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.7.0 | 35.02 MB | 35.02 MB | | @datadog/native-appsec | 10.3.0 | 20.73 MB | 20.74 MB | | @datadog/pprof | 5.12.0 | 11.19 MB | 11.57 MB | | @datadog/native-iast-taint-tracking | 4.1.0 | 9.01 MB | 9.02 MB | | @opentelemetry/resources | 1.30.1 | 557.67 kB | 7.71 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.5.4 | 2.95 MB | 5.83 MB | | @datadog/wasm-js-rewriter | 5.0.1 | 2.82 MB | 3.53 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api-logs | 0.208.0 | 199.48 kB | 1.42 MB | | @opentelemetry/api | 1.9.0 | 1.22 MB | 1.22 MB | | jsonpath-plus | 10.3.0 | 617.18 kB | 1.08 MB | | import-in-the-middle | 1.15.0 | 127.66 kB | 856.24 kB | | lru-cache | 10.4.3 | 804.3 kB | 804.3 kB | | @datadog/openfeature-node-server | 0.2.0 | 118.51 kB | 437.19 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | source-map | 0.7.6 | 185.63 kB | 185.63 kB | | pprof-format | 2.2.1 | 163.06 kB | 163.06 kB | | @datadog/sketches-js | 2.1.1 | 109.9 kB | 109.9 kB | | @isaacs/ttlcache | 2.1.3 | 90.79 kB | 90.79 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 7.0.5 | 63.38 kB | 63.38 kB | | istanbul-lib-coverage | 3.2.2 | 34.37 kB | 34.37 kB | | rfdc | 1.4.1 | 27.15 kB | 27.15 kB | | dc-polyfill | 0.1.10 | 26.73 kB | 26.73 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | shell-quote | 1.8.3 | 23.74 kB | 23.74 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 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 | | mutexify | 1.4.0 | 5.71 kB | 8.74 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | module-details-from-path | 1.0.4 | 3.96 kB | 3.96 kB | | escape-string-regexp | 5.0.0 | 3.66 kB | 3.66 kB |

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

@crysmags crysmags changed the title Fixing resource name when TracerProvider is enabled with Next.js Fix: Next.js - Preserve resource names when child spans activate between request lifecycle hooks Nov 26, 2025
@crysmags crysmags changed the title Fix: Next.js - Preserve resource names when child spans activate between request lifecycle hooks Fix: Update resource name when child span is active in store for Next.js Nov 26, 2025
@crysmags crysmags marked this pull request as ready for review December 1, 2025 14:46
@crysmags crysmags requested review from a team as code owners December 1, 2025 14:46
@datadog-datadog-prod-us1

This comment has been minimized.

@pr-commenter
Copy link

pr-commenter bot commented Dec 8, 2025

Benchmarks

Benchmark execution time: 2025-12-09 20:40:56

Comparing candidate commit 7e91dc8 in PR branch crysmags/next-otel-fix with baseline commit f10147d in branch master.

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

Copy link
Collaborator

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor improvements :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants