Support all configurations with Declarative Config #6694

mtoffl01 · 2025-10-17T19:20:35Z

What does this PR do?

Previously, only product-enablement configs were supported for Declarative Config (application_monitoring.yaml files). This PR adds support for all env-var configs. Now, all 3 sources -- local file, env vars, and fleet file -- go through the same core logic in new function _applyConfigValues.

The following [smaller] changes were also made as a result of necessary refactoring:

Moves processing logic for Otel & DD propagators out of Config constructor and into _applyConfigValues
Moves processing logic for DD_API_KEY, DD_APP_KEY, DD_INSTRUMENTATION_INSTALL_* and DD_TRACE_CLOUD_* settings out of constructor and into _applyConfigValues (See test should support legacy direct-set fields through all stableconfig and env var sources)
Moves logic for determining defaults based on environment (e.g, serverless) into Config constructor

Motivation

RFC
Declarative Config allows APM configuration to be managed at the host level through a YAML-formatted file. This approach is used in the fleet automation workflow, where users can apply configurations to their SDKs via the Fleet UI, or manage them directly through YAML files. Expanding support to all environment-variable-based settings bolsters feature parity and allows greater flexibility for users who prefer or rely on declarative configuration.

Plugin Checklist

Additional Notes

…ashtracking, etc)

packages/dd-trace/src/config.js

mtoffl01 · 2025-10-20T19:37:52Z

packages/dd-trace/src/config-helper.js

+  // This method, and callers of this method, need to be updated to check for declarative config sources as well.
  getEnvironmentVariable (name) {


getEnvironmentVariable is called 150+ times across the codebase. I'm thinking the changes described on line 81 should be done in a separate PR.

pr-commenter · 2025-10-21T15:32:12Z

Benchmarks

Benchmark execution time: 2025-10-28 19:47:22

Comparing candidate commit 095fffd in PR branch mtoff/dcfg-extended-configs with baseline commit 90b7c96 in branch master.

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

github-actions · 2025-10-21T15:38:56Z

Overall package size

Self size: 13.15 MB
Deduped: 115.94 MB
No deduping: 118.15 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/native-iast-taint-tracking | 4.0.0 | 11.72 MB | 11.73 MB | | @datadog/pprof | 5.11.1 | 9.96 MB | 10.34 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.5.4 | 2.95 MB | 5.82 MB | | @datadog/wasm-js-rewriter | 4.0.1 | 2.85 MB | 3.58 MB | | @opentelemetry/resources | 1.9.1 | 306.54 kB | 1.74 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api-logs | 0.207.0 | 201.39 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.1.0-preview.12 | 95.11 kB | 401.68 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 | | 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 | | 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-10-21T16:00:13Z

Codecov Report

❌ Patch coverage is 96.00000% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.04%. Comparing base (90b7c96) to head (095fffd).
⚠️ Report is 14 commits behind head on master.

Files with missing lines	Patch %	Lines
packages/dd-trace/src/config.js	96.00%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6694      +/-   ##
==========================================
- Coverage   84.06%   84.04%   -0.02%     
==========================================
  Files         506      506              
  Lines       21212    21241      +29     
==========================================
+ Hits        17831    17852      +21     
- Misses       3381     3389       +8

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

BridgeAR

This is great work, fixing multiple issues with the sources!

I left a few comments, mostly as question.

packages/dd-trace/src/config_defaults.js

BridgeAR · 2025-10-24T10:27:55Z

packages/dd-trace/src/config.js

-    this.#setBoolean(env, 'reportHostname', DD_TRACE_REPORT_HOSTNAME)
+    this.#setString(target, 'protocolVersion', DD_TRACE_AGENT_PROTOCOL_VERSION)
+    this.#setString(target, 'queryStringObfuscation', DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP)
+    this.#setBoolean(target, 'remoteConfig.enabled', DD_REMOTE_CONFIGURATION_ENABLED)


This change makes sense as such, that we expect a user never to define this value if in a serverless environment. If they do however use a single configuration for serverless and non-serverless and they have this set to enabled, it would cause a regression, if I am not mistaken.

BridgeAR · 2025-10-24T10:32:30Z

packages/dd-trace/src/config.js

+    this.#setBoolean(target, 'startupLogs', DD_TRACE_STARTUP_LOGS)
+    this.#setTags(target, 'tags', tags)
+    target.tagsHeaderMaxLength = DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH
+    this.#setBoolean(target, 'telemetry.enabled', DD_INSTRUMENTATION_TELEMETRY_ENABLED)


Same as with remote config enabled:

This change makes sense as such, that we expect a user never to define this value if in a serverless environment or when using jest. If they do however use a single configuration for serverless and non-serverless and they have this set to enabled, it would cause a regression, if I am not mistaken.

I wonder if we just want to ignore the value if we are in serverless or when using jest. That way it would indeed fall back to the default value, which we can also define as such. In addition, we could use a unprocessed object for it, so that we still know the user defined it.

It is just an interesting edge case for how to handle it correct.

packages/dd-trace/src/config.js

packages/dd-trace/test/config.spec.js

BridgeAR · 2025-10-24T10:52:50Z

packages/dd-trace/src/config.js

-    this.#setBoolean(obj, 'runtimeMetrics.enabled', DD_RUNTIME_METRICS_ENABLED)
-    this.#setString(obj, 'service', DD_SERVICE)
-    this.#setString(obj, 'version', DD_VERSION)
+    this.#applyConfigValues(config, obj, {})


The third argument means we will fill that object but never use it, as far as I can tell. Should we potentially just not set the unprocessed values, if we do not pass through a third argument?

I actually do not understand what the "unprocessedTarget" does. I just used {} to maintain existing patterns.

I guess the question is: Does StableConfig need an "unprocessedTarget"? If not, then yes, we could:

Not pass a third argument

Modify the logic in applyConfigValues to only set entries on unprocessedTarget if it exists

WDYT?

Unprocessed exists because we used to override some values with calculated ones. To still send out the original user defined value, we tracked both cases. That is definitely not ideal and it would be better not to change anything in the first place. That way unprocessed would not be necessary at all.
I believe your changes pretty much resolve most of this already, I just did not check if all cases.

…D defaults to happen in applyDefaults, instead of applyCalculated

…USH_INTERVAL

…n checking DD_TRACE_FLUSH_INTERVAL

BridgeAR · 2025-10-27T20:47:45Z

packages/dd-trace/src/config.js

+      if (DD_TRACE_CLOUD_RESPONSE_PAYLOAD_TAGGING) {
+        this.#setBoolean(target, 'cloudPayloadTagging.responsesEnabled', true)
+      }
+      target['cloudPayloadTagging.rules'] = appendRules(


Suggested change

target['cloudPayloadTagging.rules'] = appendRules(

target.cloudPayloadTagging.rules = appendRules(

And the object might have to be initialized up front as well as empty object.

BridgeAR · 2025-10-27T20:47:58Z

packages/dd-trace/src/config.js

+      )
+    }
+    if (DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH) {
+      target['cloudPayloadTagging.maxDepth'] = maybeInt(DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH)


Suggested change

target['cloudPayloadTagging.maxDepth'] = maybeInt(DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH)

target.cloudPayloadTagging.maxDepth = maybeInt(DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH)

BridgeAR · 2025-10-27T20:49:08Z

packages/dd-trace/src/config.js

+    if (options.cloudPayloadTagging) {
+      this.#setBoolean(opts, 'cloudPayloadTagging.requestsEnabled', options.cloudPayloadTagging.requestsEnabled)
+      this.#setBoolean(opts, 'cloudPayloadTagging.responsesEnabled', options.cloudPayloadTagging.responsesEnabled)
+      opts['cloudPayloadTagging.maxDepth'] = maybeInt(options.cloudPayloadTagging.maxDepth)


Suggested change

opts['cloudPayloadTagging.maxDepth'] = maybeInt(options.cloudPayloadTagging.maxDepth)

opts.cloudPayloadTagging.maxDepth = maybeInt(options.cloudPayloadTagging.maxDepth)

BridgeAR · 2025-10-27T20:49:26Z

packages/dd-trace/src/config.js

+      this.#setBoolean(opts, 'cloudPayloadTagging.responsesEnabled', options.cloudPayloadTagging.responsesEnabled)
+      opts['cloudPayloadTagging.maxDepth'] = maybeInt(options.cloudPayloadTagging.maxDepth)
+      if (options.cloudPayloadTagging.request || options.cloudPayloadTagging.response) {
+        opts['cloudPayloadTagging.rules'] = appendRules(


Suggested change

opts['cloudPayloadTagging.rules'] = appendRules(

opts.cloudPayloadTagging.rules = appendRules(

…al logic to its previous state

BridgeAR

Great work!

LGTM

* Sync declarative config and env var support; add tests * Move runtime specific evaluations to defaults (e.g. remote config, crashtracking, etc) * Handle cloudPayloadTagging and installSignature

mtoffl01 added 4 commits October 14, 2025 16:09

Sync declarative config and env var support; add tests

443ff6a

Move runtime specific evaluations to defaults (e.g. remote config, cr…

5f0c5fa

…ashtracking, etc)

Fix extended configs test (temporarily)

bf248eb

Fix existing tests

b9b5e91

mtoffl01 requested review from a team as code owners October 17, 2025 19:20

mtoffl01 requested review from BridgeAR and removed request for a team October 17, 2025 19:20

mtoffl01 marked this pull request as draft October 17, 2025 19:20

mtoffl01 added 4 commits October 20, 2025 12:50

Handle cloudPayloadTagging and installSignature

cc34971

fix tracingPropagationStyle

bdd455d

nits: cleanup

2a69eac

Fix logic for OTEL_PROPAGATORS

b5080e5

mtoffl01 commented Oct 20, 2025

View reviewed changes

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

mtoffl01 commented Oct 20, 2025

View reviewed changes

BridgeAR added the semver-patch label Oct 21, 2025

merge master

4102a5d

This comment has been minimized.

Sign in to view

mtoffl01 added 5 commits October 21, 2025 13:30

Fix OTEL_LOGS_EXPORTER evaluation in config.js

930c8bf

restore files with unintended changes to master

4c62d5f

Fix instrumentationSource logic in config.js

90cb4a0

Handle all merge conflicts

5c9176d

Restore node-24.10.0-junit.xml to master

f00b4c2

mtoffl01 marked this pull request as ready for review October 22, 2025 18:36

BridgeAR reviewed Oct 24, 2025

View reviewed changes

mtoffl01 added 2 commits October 24, 2025 11:09

put defaults in sorted order, and change serverless and JEST_WORKER_I…

14bf8b5

…D defaults to happen in applyDefaults, instead of applyCalculated

github review feedback

b20097b

mtoffl01 added 3 commits October 24, 2025 11:39

cleanup applyDefaults

55e8f16

fix merge conflicts: flush interval is also determined by DD_TRACE_FL…

b08cab6

…USH_INTERVAL

Try to fix failing aws tests by changing 'else if' to just 'else' whe…

fcc9cba

…n checking DD_TRACE_FLUSH_INTERVAL

BridgeAR reviewed Oct 27, 2025

View reviewed changes

mtoffl01 added 2 commits October 28, 2025 14:51

Modify cloudPayloadTagging logic in applyOptions; restore flushInterv…

245d7e2

…al logic to its previous state

nits remove unnecessary comments

095fffd

BridgeAR approved these changes Oct 28, 2025

View reviewed changes

BridgeAR merged commit af5885e into master Oct 28, 2025
762 checks passed

BridgeAR deleted the mtoff/dcfg-extended-configs branch October 28, 2025 20:07

This was referenced Oct 29, 2025

v5.74.1 proposal #6765

Closed

v5.75.0 proposal #6792

Merged

mtoffl01 mentioned this pull request Oct 30, 2025

Enable Declarative Config test, test_extended_configs, for Nodejs DataDog/system-tests#5596

Merged

6 tasks

		// This method, and callers of this method, need to be updated to check for declarative config sources as well.
		getEnvironmentVariable (name) {

	target['cloudPayloadTagging.rules'] = appendRules(
	target.cloudPayloadTagging.rules = appendRules(

	target['cloudPayloadTagging.maxDepth'] = maybeInt(DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH)
	target.cloudPayloadTagging.maxDepth = maybeInt(DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH)

	opts['cloudPayloadTagging.maxDepth'] = maybeInt(options.cloudPayloadTagging.maxDepth)
	opts.cloudPayloadTagging.maxDepth = maybeInt(options.cloudPayloadTagging.maxDepth)

	opts['cloudPayloadTagging.rules'] = appendRules(
	opts.cloudPayloadTagging.rules = appendRules(

Support all configurations with Declarative Config #6694

Support all configurations with Declarative Config #6694

Uh oh!

Conversation

mtoffl01 commented Oct 17, 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Benchmarks

Uh oh!

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

Uh oh!

Overall package size

Uh oh!

This comment has been minimized.

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

Uh oh!

Codecov Report

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mtoffl01 commented Oct 17, 2025 •

edited

Loading

pr-commenter bot commented Oct 21, 2025 •

edited

Loading

github-actions bot commented Oct 21, 2025 •

edited

Loading

codecov bot commented Oct 21, 2025 •

edited

Loading