feat: add injection metadata fields to telemetry forwarder #6203

sydney-tung · 2025-07-30T19:14:36Z

What does this PR do?

This change adds additional fields to the telemetry forwarder used during injection. These fields will be used to add additional context that will be surfaced to the end user in the following Figma:

See Injection Metadata for more details.

Motivation

Adding addition information for telemetry forwarder during injection.

Plugin Checklist

Additional Notes

github-actions · 2025-07-30T19:15:04Z

Overall package size

Self size: 11.15 MB
Deduped: 110.8 MB
No deduping: 111.18 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.7.0 | 35.02 MB | 35.02 MB | | @datadog/native-appsec | 10.1.0 | 20.37 MB | 20.37 MB | | @datadog/native-iast-taint-tracking | 4.0.0 | 11.72 MB | 11.73 MB | | @datadog/pprof | 5.9.0 | 9.77 MB | 10.14 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.5.3 | 2.95 MB | 5.6 MB | | @datadog/wasm-js-rewriter | 4.0.1 | 2.85 MB | 3.58 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | jsonpath-plus | 10.3.0 | 617.18 kB | 1.08 MB | | import-in-the-middle | 1.14.2 | 122.36 kB | 850.93 kB | | lru-cache | 10.4.3 | 804.3 kB | 804.3 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.1 | 109.9 kB | 109.9 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 | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 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 | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.4 | 3.96 kB | 3.96 kB |

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

codecov · 2025-07-30T19:15:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.23%. Comparing base (fa783b4) to head (01780e8).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6203      +/-   ##
==========================================
- Coverage   83.28%   83.23%   -0.06%     
==========================================
  Files         478      476       -2     
  Lines       19802    19802              
==========================================
- Hits        16493    16483      -10     
- Misses       3309     3319      +10

☔ 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.

datadog-datadog-prod-us1 · 2025-07-30T19:17:59Z

✅ Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

_{This comment will be updated automatically if new data arrives.

🔗 Commit SHA: 01780e8 | Docs | Was this helpful? Give us feedback!}

pr-commenter · 2025-07-30T20:06:27Z

Benchmarks

Benchmark execution time: 2025-08-07 19:38:48

Comparing candidate commit 01780e8 in PR branch sydney/feat with baseline commit fa783b4 in branch master.

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

integration-tests/helpers/index.js

packages/dd-trace/src/guardrails/telemetry.js

tlhunter · 2025-08-06T19:29:42Z

packages/dd-trace/test/guardrails/telemetry.spec.js

@@ -16,7 +18,7 @@ describe('sendTelemetry', () => {

  beforeEach(() => {
    cleanup = telemetryForwarder()
-    sendTelemetry = proxyquire('../src/guardrails/telemetry', {})


This is pretty weird. It looks like the old proxyquire call here was wrong as that file doesn't exist relative to this file, and that you fixed it. And it's not like the location of this test file moved.

Did you find that running this test file would throw errors and that when you fixed the path it started working? If so we might have a bug in our test suite where we're not properly executing this test file...

oh wait yeah it only worked after I changed the path...

Alright I'm super confused then.

Here are the CI results for a random PR that I found that doesn't contain your changes and I can see that the guardrails tests are running:
https://github.com/DataDog/dd-trace-js/actions/runs/16787347785/job/47541117623?pr=6237

> dd-trace@6.0.0-pre test:trace:guardrails > mocha -r "packages/dd-trace/test/setup/mocha.js" "packages/dd-trace/test/guardrails/**/*.spec.js" sendTelemetry ✔ should send telemetry (114ms) no duplicates ✔ should not send `abort` more than once in the same call (105ms) ✔ should not send `abort` more than once in a different call (105ms) ✔ should not send `abort.integration` more than once if tags are the same in the same call (104ms) ✔ should not send `abort.integration` more than once if tags are the same in a different call (105ms) 5 passing (844ms) --------------|---------|----------|---------|---------|------------------- File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s --------------|---------|----------|---------|---------|------------------- All files | 87.03 | 65 | 35.71 | 88.23 | log.js | 100 | 35.71 | 0 | 100 | 20-29 telemetry.js | 84.09 | 79.16 | 44.44 | 85.36 | 11,16,53,66,70,74 util.js | 100 | 100 | 100 | 100 | --------------|---------|----------|---------|---------|------------------- Done in 1.66s.

And here are is the test results for your PR:
https://github.com/DataDog/dd-trace-js/actions/runs/16756190382/job/47439327513?pr=6203

> dd-trace@6.0.0-pre test:trace:guardrails > mocha -r "packages/dd-trace/test/setup/mocha.js" "packages/dd-trace/test/guardrails/**/*.spec.js" sendTelemetry ✔ should send telemetry (108ms) no duplicates ✔ should not send `abort` more than once in the same call (105ms) ✔ should not send `abort` more than once in a different call (105ms) ✔ should not send `abort.integration` more than once if tags are the same in the same call (104ms) ✔ should not send `abort.integration` more than once if tags are the same in a different call (104ms) Error scenarios and metadata ✔ should set error metadata when telemetry forwarder fails to spawn ✔ should set error metadata when telemetry forwarder exits with non-zero code ✔ should set error metadata when writing to telemetry forwarder fails ✔ should set success metadata when telemetry forwarder exits successfully 9 passing (852ms) --------------|---------|----------|---------|---------|------------------- File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s --------------|---------|----------|---------|---------|------------------- All files | 93.93 | 67.5 | 57.14 | 95.23 | log.js | 100 | 35.71 | 25 | 100 | 20-29 telemetry.js | 92.85 | 83.33 | 66.66 | 94.33 | 11,16,56 util.js | 100 | 100 | 100 | 100 | --------------|---------|----------|---------|---------|------------------- Done in 1.64s.

Based on the location of the files I believe your change is correct:

dd-trace-js/packages/dd-trace/test/guardrails/ $ node Welcome to Node.js v22.18.0. Type ".help" for more information. > let proxyquire = require('proxyquire') undefined > proxyquire('../src/guardrails/telemetry', {}) Uncaught Error: Cannot find module '../src/guardrails/telemetry' Require stack: - <repl> at Function._resolveFilename (node:internal/modules/cjs/loader:1365:15) at Proxyquire._disableModuleCache (/Users/thomas.hunter/Projects/dd-trace-js/node_modules/proxyquire/lib/proxyquire.js:248:19) at Proxyquire._disableCache (/Users/thomas.hunter/Projects/dd-trace-js/node_modules/proxyquire/lib/proxyquire.js:216:15) at Proxyquire._withoutCache (/Users/thomas.hunter/Projects/dd-trace-js/node_modules/proxyquire/lib/proxyquire.js:172:27) at Proxyquire.load (/Users/thomas.hunter/Projects/dd-trace-js/node_modules/proxyquire/lib/proxyquire.js:136:15) { code: 'MODULE_NOT_FOUND', requireStack: [ '<repl>' ] } > proxyquire('../../src/guardrails/telemetry', {}) [Function: noop]

I see that @watson introduced this test file in commit f97d2cd so I'd like him to take a look. There might be some shenanigans in CI that allow the old code to work?

Changes were made

first draft

1b9c8c7

fix

f673ee2

fixed

cc51b73

sydney-tung added the semver-minor label Jul 30, 2025

sydney-tung added 6 commits August 1, 2025 10:26

add tests

714880e

fix tests

0850b27

fix format

91d7085

added tests

491bf5a

Merge branch 'master' into sydney/feat

c0f2c72

fix format

8f9556a

sydney-tung marked this pull request as ready for review August 1, 2025 16:40

sydney-tung requested a review from a team as a code owner August 1, 2025 16:40

sydney-tung added 9 commits August 4, 2025 09:23

edit

38736e2

clean

20a89e1

checks

a666cf8

debug

516376a

fix

17651a9

fix

d72b0cf

fix format

87597c8

Merge branch 'master' into sydney/feat

d9fde90

fix

e15417b

tlhunter reviewed Aug 4, 2025

View reviewed changes

integration-tests/helpers/index.js Outdated Show resolved Hide resolved

tlhunter previously requested changes Aug 4, 2025

View reviewed changes

packages/dd-trace/src/guardrails/telemetry.js Outdated Show resolved Hide resolved

sydney-tung added 2 commits August 5, 2025 12:51

fix

d8fcb22

format

e4327d5

sydney-tung requested a review from tlhunter August 5, 2025 17:09

tlhunter reviewed Aug 6, 2025

View reviewed changes

tlhunter assigned watson Aug 6, 2025

Merge branch 'master' into sydney/feat

01780e8

tlhunter approved these changes Aug 11, 2025

View reviewed changes

sydney-tung merged commit 5873c88 into master Aug 11, 2025
686 checks passed

sydney-tung deleted the sydney/feat branch August 11, 2025 17:24

dd-octo-sts bot pushed a commit that referenced this pull request Aug 12, 2025

feat: add injection metadata fields to telemetry forwarder (#6203)

b900f4a

dd-octo-sts bot mentioned this pull request Aug 12, 2025

v5.63.0 proposal #6240

Merged

szegedi pushed a commit that referenced this pull request Aug 18, 2025

feat: add injection metadata fields to telemetry forwarder (#6203)

269fd11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add injection metadata fields to telemetry forwarder #6203

feat: add injection metadata fields to telemetry forwarder #6203

sydney-tung commented Jul 30, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

datadog-datadog-prod-us1 bot commented Jul 30, 2025 •

edited by datadog-official bot

Loading

Uh oh!

pr-commenter bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

tlhunter Aug 6, 2025

Uh oh!

sydney-tung Aug 6, 2025

Uh oh!

tlhunter Aug 6, 2025

Uh oh!

Uh oh!

Uh oh!

feat: add injection metadata fields to telemetry forwarder #6203

feat: add injection metadata fields to telemetry forwarder #6203

Conversation

sydney-tung commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Plugin Checklist

Additional Notes

Uh oh!

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

Uh oh!

Overall package size

Uh oh!

codecov bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

datadog-datadog-prod-us1 bot commented Jul 30, 2025 • edited by datadog-official bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Benchmarks

Uh oh!

Uh oh!

Uh oh!

tlhunter Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

sydney-tung Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

tlhunter Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sydney-tung commented Jul 30, 2025 •

edited

Loading

github-actions bot commented Jul 30, 2025 •

edited

Loading

codecov bot commented Jul 30, 2025 •

edited

Loading

datadog-datadog-prod-us1 bot commented Jul 30, 2025 •

edited by datadog-official bot

Loading

pr-commenter bot commented Jul 30, 2025 •

edited

Loading