refactor(config): generate runtime config from supported metadata (#7916)

Config model:
Build the tracer runtime config from `supported-configurations.json`.
The metadata now defines defaults, aliases, transforms, allowed values,
and internal property mapping. Env vars, stable config, code options,
remote config, and telemetry now go through the same parsing and
normalization path instead of separate logic.

Remote config and fallback:
Normalize remote config into the same local option names before apply.
When a remote value is removed, restore the earlier code value or the
default for that one option, instead of keeping an old remote value.
This also keeps config source tracking correct when remote config
changes over time.

Telemetry:
Report the same normalized config view that the tracer really uses.
Telemetry now keeps the source of each value, sends standard config
names such as `DD_*` and `OTEL_*`, and serializes URLs, arrays,
objects, functions, and rule sets in one consistent format for config
change events and extended heartbeats.

DD and OTEL precedence:
Use one precedence model for Datadog and OpenTelemetry settings.
Datadog config still wins when both are set. Generic
`OTEL_EXPORTER_OTLP_*` endpoint, header, protocol, and timeout values
now fill in logs and metrics config when the specific setting is not
set. `b3` extraction keeps Datadog multi-header behavior when it comes
from `DD_TRACE_PROPAGATION_STYLE`, and keeps single-header behavior
when it comes from `OTEL_PROPAGATORS`.

Config-specific updates:
Parse and validate more individual settings through shared parsers.
This now covers sample rates, propagation styles and behavior,
`OTEL_RESOURCE_ATTRIBUTES`, `DD_TRACE_HEADER_TAGS` spacing,
JSON sampling rules, AppSec blocked template file paths, and
`DD_GRPC_CLIENT_ERROR_STATUSES` / `DD_GRPC_SERVER_ERROR_STATUSES`
range values. Invalid values now warn the same way and fall back more
predictably.
DD_LOG_INJECTION was renamed to DD_LOGS_INJECTION to be consistent
with other platforms. This is an internal only configuration why it
is not a breaking change.

Calculated behavior:
Recalculate derived settings from the remembered source of each value.
This keeps service and tag inference, socket and DogStatsD defaults,
OTEL logs vs log injection, runtime metrics vs
`OTEL_METRICS_EXPORTER=none`, AppSec-driven resource renaming, CI and
serverless toggles, Lambda flush behavior, and agentless tracing
overrides consistent when inputs change.

Runtime consumers:
Move profiling, logging, agent URL selection, session propagation, and
other runtime code to read the resolved config instead of reparsing env
vars. This also keeps proxy startup working when tracing is off but
dynamic instrumentation or AppSec standalone still need runtime hooks,
and makes profiling exporter and profiler settings follow the same
config resolution path.

Author: BridgeAR

benchmark/sirun/exporting-pipeline/index.js

@@ -7,7 +7,7 @@ const SpanProcessor = require('../../../packages/dd-trace/src/span_processor')
 const Exporter = require('../../../packages/dd-trace/src/exporters/agent/index')
 const PrioritySampler = require('../../../packages/dd-trace/src/priority_sampler')
 const id = require('../../../packages/dd-trace/src/id')
-const defaults = require('../../../packages/dd-trace/src/config/defaults')
+const { defaults } = require('../../../packages/dd-trace/src/config/defaults')
 
 const config = {
   url: `http://${defaults.hostname}:${defaults.port}`,

benchmark/sirun/statsd.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const dgram = require('dgram')
-const defaults = require('../../packages/dd-trace/src/config/defaults')
+const { defaults } = require('../../packages/dd-trace/src/config/defaults')
 const port = process.env.SIRUN_STATSD_PORT || defaults['dogstatsd.port']
 
 class StatsD {

integration-tests/init.spec.js

@@ -273,7 +273,9 @@ describe('init.js', () => {
 // or on 18.0.0 in particular.
 if (semver.satisfies(process.versions.node, '>=14.13.1')) {
   describe('initialize.mjs', () => {
-    setShouldKill(false)
+    // Node 20.0.0 can leave short-lived loader-based children alive after they
+    // print the expected output, so terminate them after a short grace period.
+    setShouldKill(process.versions.node === '20.0.0')
     useSandbox()
     stubTracerIfNeeded()
 

integration-tests/opentelemetry.spec.js

@@ -50,10 +50,12 @@ function nearNow (ts, now = Date.now(), range = 1000) {
   return delta < range && delta >= 0
 }
 
-describe('opentelemetry', () => {
-  let agent
+describe('opentelemetry', function () {
+  this.timeout(20000)
+
+  let agent = /** @type {FakeAgent | null} */ (null)
   let proc
-  let cwd
+  let cwd = /** @type {string} */ ('')
   const timeout = 5000
   const dependencies = [
     '@opentelemetry/api@1.8.0',
@@ -75,14 +77,14 @@ describe('opentelemetry', () => {
 
   after(async () => {
     await stopProc(proc)
-    await agent.stop()
+    await agent?.stop()
   })
 
   it("should not capture telemetry DD and OTEL vars don't conflict", async () => {
     proc = fork(join(cwd, 'opentelemetry/basic.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         DD_TELEMETRY_HEARTBEAT_INTERVAL: '1',
         TIMEOUT: '1500',
@@ -114,7 +116,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/basic.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         DD_TELEMETRY_HEARTBEAT_INTERVAL: '1',
         TIMEOUT: '1500',
@@ -147,42 +149,20 @@ describe('opentelemetry', () => {
 
       const otelHiding = metrics.series.filter(({ metric }) => metric === 'otel.env.hiding')
       const otelInvalid = metrics.series.filter(({ metric }) => metric === 'otel.env.invalid')
-      assert.strictEqual(otelHiding.length, 9)
-      assert.strictEqual(otelInvalid.length, 0)
-
-      assert.deepStrictEqual(otelHiding[0].tags, [
-        'config_datadog:dd_trace_log_level', 'config_opentelemetry:otel_log_level',
-      ])
-      assert.deepStrictEqual(otelHiding[1].tags, [
-        'config_datadog:dd_trace_propagation_style', 'config_opentelemetry:otel_propagators',
-      ])
-      assert.deepStrictEqual(otelHiding[2].tags, [
-        'config_datadog:dd_service', 'config_opentelemetry:otel_service_name',
-      ])
-
-      assert.deepStrictEqual(otelHiding[3].tags, [
-        'config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler',
-      ])
-
-      assert.deepStrictEqual(otelHiding[4].tags, [
-        'config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler_arg',
-      ])
-
-      assert.deepStrictEqual(otelHiding[5].tags, [
-        'config_datadog:dd_trace_enabled', 'config_opentelemetry:otel_traces_exporter',
-      ])
-
-      assert.deepStrictEqual(otelHiding[6].tags, [
-        'config_datadog:dd_runtime_metrics_enabled', 'config_opentelemetry:otel_metrics_exporter',
-      ])
 
-      assert.deepStrictEqual(otelHiding[7].tags, [
-        'config_datadog:dd_tags', 'config_opentelemetry:otel_resource_attributes',
-      ])
+      assert.deepStrictEqual(sortMetricTags(otelHiding), sortMetricTags([
+        ['config_datadog:dd_trace_log_level', 'config_opentelemetry:otel_log_level'],
+        ['config_datadog:dd_trace_propagation_style', 'config_opentelemetry:otel_propagators'],
+        ['config_datadog:dd_service', 'config_opentelemetry:otel_service_name'],
+        ['config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler'],
+        ['config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler_arg'],
+        ['config_datadog:dd_trace_enabled', 'config_opentelemetry:otel_traces_exporter'],
+        ['config_datadog:dd_runtime_metrics_enabled', 'config_opentelemetry:otel_metrics_exporter'],
+        ['config_datadog:dd_tags', 'config_opentelemetry:otel_resource_attributes'],
+        ['config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled'],
+      ]))
 
-      assert.deepStrictEqual(otelHiding[8].tags, [
-        'config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled',
-      ])
+      assert.deepStrictEqual(sortMetricTags(otelInvalid), [])
 
       for (const metric of otelHiding) {
         assert.strictEqual(metric.points[0][1], 1)
@@ -194,7 +174,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/basic.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         DD_TELEMETRY_HEARTBEAT_INTERVAL: '1',
         TIMEOUT: '1500',
@@ -221,47 +201,20 @@ describe('opentelemetry', () => {
       const otelHiding = metrics.series.filter(({ metric }) => metric === 'otel.env.hiding')
       const otelInvalid = metrics.series.filter(({ metric }) => metric === 'otel.env.invalid')
 
-      assert.strictEqual(otelHiding.length, 1)
-      assert.strictEqual(otelInvalid.length, 8)
-
-      assert.deepStrictEqual(otelHiding[0].tags, [
-        'config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[0].tags, [
-        'config_datadog:dd_trace_log_level', 'config_opentelemetry:otel_log_level',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[1].tags, [
-        'config_datadog:dd_trace_sample_rate',
-        'config_opentelemetry:otel_traces_sampler',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[2].tags, [
-        'config_datadog:dd_trace_sample_rate',
-        'config_opentelemetry:otel_traces_sampler_arg',
-      ])
-      assert.deepStrictEqual(otelInvalid[3].tags, [
-        'config_datadog:dd_trace_enabled', 'config_opentelemetry:otel_traces_exporter',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[4].tags, [
-        'config_datadog:dd_runtime_metrics_enabled',
-        'config_opentelemetry:otel_metrics_exporter',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[5].tags, [
-        'config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[6].tags, [
-        'config_opentelemetry:otel_logs_exporter',
-      ])
-
-      assert.deepStrictEqual(otelInvalid[7].tags, [
-        'config_datadog:dd_trace_propagation_style',
-        'config_opentelemetry:otel_propagators',
-      ])
+      assert.deepStrictEqual(sortMetricTags(otelHiding), sortMetricTags([
+        ['config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled'],
+      ]))
+
+      assert.deepStrictEqual(sortMetricTags(otelInvalid), sortMetricTags([
+        ['config_datadog:dd_trace_log_level', 'config_opentelemetry:otel_log_level'],
+        ['config_datadog:dd_trace_propagation_style', 'config_opentelemetry:otel_propagators'],
+        ['config_opentelemetry:otel_logs_exporter'],
+        ['config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler'],
+        ['config_datadog:dd_trace_sample_rate', 'config_opentelemetry:otel_traces_sampler_arg'],
+        ['config_datadog:dd_trace_enabled', 'config_opentelemetry:otel_traces_exporter'],
+        ['config_datadog:dd_runtime_metrics_enabled', 'config_opentelemetry:otel_metrics_exporter'],
+        ['config_datadog:dd_trace_otel_enabled', 'config_opentelemetry:otel_sdk_disabled'],
+      ]))
 
       for (const metric of otelInvalid) {
         assert.strictEqual(metric.points[0][1], 1)
@@ -273,7 +226,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/basic.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
       },
     })
     await check(agent, proc, timeout, ({ payload }) => {
@@ -292,7 +245,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/basic.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         DD_TELEMETRY_HEARTBEAT_INTERVAL: '1',
         TIMEOUT: '1500',
@@ -334,7 +287,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/auto-instrumentation.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         SERVER_PORT,
         DD_TRACE_DISABLED_INSTRUMENTATIONS: 'http,dns,express,net',
@@ -378,7 +331,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/server.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
       },
     })
     await check(agent, proc, timeout, ({ payload }) => {
@@ -407,7 +360,7 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/auto-instrumentation.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
         DD_TRACE_OTEL_ENABLED: '1',
         SERVER_PORT,
         DD_TRACE_DISABLED_INSTRUMENTATIONS: 'http,dns,express,net',
@@ -456,18 +409,12 @@ describe('opentelemetry', () => {
     proc = fork(join(cwd, 'opentelemetry/env-var.js'), {
       cwd,
       env: {
-        DD_TRACE_AGENT_PORT: agent.port,
+        DD_TRACE_AGENT_PORT: agent?.port,
       },
     })
     await check(agent, proc, timeout, ({ payload }) => {
-      // Should have a single trace with a single span
-      assert.strictEqual(payload.length, 1)
-      const [trace] = payload
-      assert.strictEqual(trace.length, 1)
-      const [span] = trace
-
-      // Should be the expected otel span
-      assert.strictEqual(span.name, 'otel-sub')
+      const trace = payload.find(trace => trace.length === 1 && trace[0].name === 'otel-sub')
+      assert.ok(trace)
     })
   })
 })
@@ -477,3 +424,9 @@ function isChildOf (childSpan, parentSpan) {
   assert.notStrictEqual(childSpan.span_id.toString(), parentSpan.span_id.toString())
   assert.strictEqual(childSpan.parent_id.toString(), parentSpan.span_id.toString())
 }
+
+function sortMetricTags (metrics) {
+  return metrics
+    .map(metric => Array.isArray(metric) ? metric : metric.tags)
+    .sort((a, b) => a.join(',').localeCompare(b.join(',')))
+}

integration-tests/package-guardrails.spec.js

@@ -13,7 +13,7 @@ const {
 const NODE_OPTIONS = '--require dd-trace/init.js'
 const DD_TRACE_DEBUG = 'true'
 const DD_INJECTION_ENABLED = 'tracing'
-const DD_LOG_LEVEL = 'error'
+const DD_LOG_LEVEL = 'info'
 const NODE_MAJOR = Number(process.versions.node.split('.')[0])
 const FASTIFY_DEP = NODE_MAJOR < 20 ? 'fastify@4' : 'fastify'
 

integration-tests/telemetry.spec.js

@@ -26,7 +26,7 @@ describe('telemetry', () => {
       proc = await spawnProc(startupTestFile, {
         cwd,
         env: {
-          AGENT_PORT: agent.port,
+          AGENT_PORT: String(agent.port),
           DD_LOGS_INJECTION: 'true',
         },
       })
@@ -66,9 +66,9 @@ describe('telemetry', () => {
       await agent.assertTelemetryReceived(msg => {
         const { configuration } = msg.payload.payload
         assertObjectContains(configuration, [
-          { name: 'DD_LOG_INJECTION', value: true, origin: 'default' },
-          { name: 'DD_LOG_INJECTION', value: true, origin: 'env_var' },
-          { name: 'DD_LOG_INJECTION', value: false, origin: 'code' },
+          { name: 'DD_LOGS_INJECTION', value: true, origin: 'default' },
+          { name: 'DD_LOGS_INJECTION', value: true, origin: 'env_var' },
+          { name: 'DD_LOGS_INJECTION', value: false, origin: 'code' },
         ])
       }, 'app-started', 5_000, 1)
     })

package.json

@@ -11,6 +11,8 @@
     "bench": "node benchmark/index.js",
     "bench:e2e:test-optimization": "node benchmark/e2e-test-optimization/benchmark-run.js",
     "dependencies:dedupe": "yarn-deduplicate yarn.lock",
+    "generate:config:types": "node scripts/generate-config-types.js",
+    "verify:config:types": "node scripts/generate-config-types.js --check",
     "type:check": "tsc --noEmit -p tsconfig.dev.json",
     "type:doc:build": "cd docs && yarn && yarn build",
     "type:doc:test": "cd docs && yarn && yarn test",

packages/datadog-plugin-aws-sdk/src/base.js

@@ -23,12 +23,13 @@ class BaseAwsSdkPlugin extends ClientPlugin {
     return id
   }
 
+  /** @type {import('../../dd-trace/src/config/config-types').ConfigProperties['cloudPayloadTagging']} */
   get cloudTaggingConfig () {
     return this._tracerConfig.cloudPayloadTagging
   }
 
   get payloadTaggingRules () {
-    return this.cloudTaggingConfig.rules.aws?.[this.constructor.id]
+    return this.cloudTaggingConfig.rules?.aws?.[this.constructor.id]
   }
 
   constructor (...args) {
@@ -78,7 +79,7 @@ class BaseAwsSdkPlugin extends ClientPlugin {
         this.requestInject(span, request)
       })
 
-      if (this.constructor.isPayloadReporter && this.cloudTaggingConfig.requestsEnabled) {
+      if (this.constructor.isPayloadReporter && this.cloudTaggingConfig.request) {
         const maxDepth = this.cloudTaggingConfig.maxDepth
         const requestTags = tagsFromRequest(this.payloadTaggingRules, request.params, { maxDepth })
         span.addTags(requestTags)
@@ -215,7 +216,7 @@ class BaseAwsSdkPlugin extends ClientPlugin {
 
     span.addTags(tags)
 
-    if (this.constructor.isPayloadReporter && this.cloudTaggingConfig.responsesEnabled) {
+    if (this.constructor.isPayloadReporter && this.cloudTaggingConfig.response) {
       const maxDepth = this.cloudTaggingConfig.maxDepth
       const responseBody = this.extractResponseBody(response)
       const responseTags = tagsFromResponse(this.payloadTaggingRules, responseBody, { maxDepth })

packages/datadog-plugin-grpc/test/client.spec.js

@@ -12,7 +12,7 @@ const loader = require('../../../versions/@grpc/proto-loader').get()
 const { withNamingSchema, withPeerService, withVersions } = require('../../dd-trace/test/setup/mocha')
 const agent = require('../../dd-trace/test/plugins/agent')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
-const defaults = require('../../dd-trace/src/config/defaults')
+const { defaults } = require('../../dd-trace/src/config/defaults')
 const { NODE_MAJOR } = require('../../../version')
 const getService = require('./service')
 

packages/datadog-plugin-grpc/test/server.spec.js

@@ -11,7 +11,7 @@ const { assertObjectContains } = require('../../../integration-tests/helpers')
 const { withNamingSchema, withVersions } = require('../../dd-trace/test/setup/mocha')
 const agent = require('../../dd-trace/test/plugins/agent')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
-const defaults = require('../../dd-trace/src/config/defaults')
+const { defaults } = require('../../dd-trace/src/config/defaults')
 const { NODE_MAJOR } = require('../../../version')
 
 const GRPC_SERVER_ERROR_STATUSES = defaults['grpc.server.error.statuses']