[Code Origin for Spans] Allow code origin to be disabled (#5635)

Due to a bug in how the tracer configuration was parsed, older versions of the
tracer would always have Code Origin for entry spans enabled, no matter if it
was disabled in config (which it was supposed to be by default). This bug only
applied to Code Origin for entry spans on Fastify, whereas Code Origin for exit
spans correctly adhered to the config.

This bug has been precent in the tracer since Code Origin for Spans was added
in v5.24.0 on October 17th 2024 and there has not been any reports of issues
related to this. Based on that, Code Origin for Spans will now be enabled by
default. The main functional difference with this commit, is that the feature
can now actually be turned off using the config.

Code Origin for exit spans are still experimental:

Since Code Origin for exit spans was never affected by this bug, we have
decided to leave this feature as opt-in, which means it's going to be off by
default. A new experimental config option has been introduced to allow users to
enable/disable Code Origin for exit spans independently, either via an
environment variable:

    DD_CODE_ORIGIN_FOR_SPANS_EXPERIMENTAL_EXIT_SPANS_ENABLED=true

Or via inline config:

    tracer.init({
      codeOriginForSpans: {
        experimental: {
          exit_spans: { enabled: true }
        }
      }
    })

Author: watson

index.d.ts

@@ -717,7 +717,18 @@ declare namespace tracer {
          */
         maxDepth?: number,
       }
-    };
+    }
+
+    /**
+     * Configuration for Code Origin for Spans.
+     */
+    codeOriginForSpans?: {
+      /**
+       * Whether to enable Code Origin for Spans.
+       * @default true
+       */
+      enabled?: boolean
+    }
 
     /**
      * Configuration of the IAST. Can be a boolean as an alias to `iast.enabled`.

packages/datadog-plugin-fastify/test/code_origin.spec.js

@@ -13,7 +13,11 @@ describe('Plugin', () => {
       })
 
       beforeEach(async () => {
-        return agent.load('http', { server: false }, { codeOriginForSpans: { enabled: true } })
+        return agent.load(
+          'http',
+          { server: false },
+          { codeOriginForSpans: { experimental: { exit_spans: { enabled: true } } } }
+        )
       })
 
       afterEach(() => {

packages/datadog-plugin-http/test/code_origin.spec.js

@@ -481,7 +481,8 @@ class Config {
     this._setValue(defaults, 'clientIpEnabled', false)
     this._setValue(defaults, 'clientIpHeader', null)
     this._setValue(defaults, 'crashtracking.enabled', true)
-    this._setValue(defaults, 'codeOriginForSpans.enabled', false)
+    this._setValue(defaults, 'codeOriginForSpans.enabled', true)
+    this._setValue(defaults, 'codeOriginForSpans.experimental.exit_spans.enabled', false)
     this._setValue(defaults, 'dbmPropagationMode', 'disabled')
     this._setValue(defaults, 'dogstatsd.hostname', '127.0.0.1')
     this._setValue(defaults, 'dogstatsd.port', '8125')
@@ -660,6 +661,7 @@ class Config {
       DD_APPSEC_WAF_TIMEOUT,
       DD_CRASHTRACKING_ENABLED,
       DD_CODE_ORIGIN_FOR_SPANS_ENABLED,
+      DD_CODE_ORIGIN_FOR_SPANS_EXPERIMENTAL_EXIT_SPANS_ENABLED,
       DD_DATA_STREAMS_ENABLED,
       DD_DBM_PROPAGATION_MODE,
       DD_DOGSTATSD_HOSTNAME,
@@ -825,6 +827,11 @@ class Config {
       !this._isInServerlessEnvironment()
     ))
     this._setBoolean(env, 'codeOriginForSpans.enabled', DD_CODE_ORIGIN_FOR_SPANS_ENABLED)
+    this._setBoolean(
+      env,
+      'codeOriginForSpans.experimental.exit_spans.enabled',
+      DD_CODE_ORIGIN_FOR_SPANS_EXPERIMENTAL_EXIT_SPANS_ENABLED
+    )
     this._setString(env, 'dbmPropagationMode', DD_DBM_PROPAGATION_MODE)
     this._setString(env, 'dogstatsd.hostname', DD_DOGSTATSD_HOST || DD_DOGSTATSD_HOSTNAME)
     this._setString(env, 'dogstatsd.port', DD_DOGSTATSD_PORT)
@@ -1029,6 +1036,11 @@ class Config {
     this._setValue(opts, 'baggageMaxBytes', options.baggageMaxBytes)
     this._setValue(opts, 'baggageMaxItems', options.baggageMaxItems)
     this._setBoolean(opts, 'codeOriginForSpans.enabled', options.codeOriginForSpans?.enabled)
+    this._setBoolean(
+      opts,
+      'codeOriginForSpans.experimental.exit_spans.enabled',
+      options.codeOriginForSpans?.experimental?.exit_spans?.enabled
+    )
     this._setString(opts, 'dbmPropagationMode', options.dbmPropagationMode)
     if (options.dogstatsd) {
       this._setString(opts, 'dogstatsd.hostname', options.dogstatsd.hostname)

packages/dd-trace/src/config.js

@@ -130,6 +130,7 @@ module.exports = class PluginManager {
       site,
       url,
       headerTags,
+      codeOriginForSpans,
       dbmPropagationMode,
       dsmEnabled,
       clientIpEnabled,
@@ -143,6 +144,7 @@ module.exports = class PluginManager {
     } = this._tracerConfig
 
     const sharedConfig = {
+      codeOriginForSpans,
       dbmPropagationMode,
       dsmEnabled,
       memcachedCommandEnabled,

packages/dd-trace/src/plugin_manager.js

@@ -28,7 +28,10 @@ class OutboundPlugin extends TracingPlugin {
 
   startSpan (...args) {
     const span = super.startSpan(...args)
-    if (this._tracerConfig.codeOriginForSpans.enabled) {
+    if (
+      this._tracerConfig.codeOriginForSpans.enabled &&
+      this._tracerConfig.codeOriginForSpans.experimental.exit_spans.enabled
+    ) {
       span.addTags(exitTags(this.startSpan))
     }
     return span

packages/dd-trace/src/plugins/outbound.js

@@ -223,7 +223,8 @@ describe('Config', () => {
     expect(config).to.have.property('reportHostname', false)
     expect(config).to.have.property('scope', undefined)
     expect(config).to.have.property('logLevel', 'debug')
-    expect(config).to.have.nested.property('codeOriginForSpans.enabled', false)
+    expect(config).to.have.nested.property('codeOriginForSpans.enabled', true)
+    expect(config).to.have.nested.property('codeOriginForSpans.experimental.exit_spans.enabled', false)
     expect(config).to.have.nested.property('dynamicInstrumentation.enabled', false)
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactedIdentifiers', [])
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactionExcludedIdentifiers', [])
@@ -305,7 +306,8 @@ describe('Config', () => {
       { name: 'appsec.wafTimeout', value: 5e3, origin: 'default' },
       { name: 'clientIpEnabled', value: false, origin: 'default' },
       { name: 'clientIpHeader', value: null, origin: 'default' },
-      { name: 'codeOriginForSpans.enabled', value: false, origin: 'default' },
+      { name: 'codeOriginForSpans.enabled', value: true, origin: 'default' },
+      { name: 'codeOriginForSpans.experimental.exit_spans.enabled', value: false, origin: 'default' },
       { name: 'dbmPropagationMode', value: 'disabled', origin: 'default' },
       { name: 'dogstatsd.hostname', value: '127.0.0.1', origin: 'calculated' },
       { name: 'dogstatsd.port', value: '8125', origin: 'default' },
@@ -440,7 +442,8 @@ describe('Config', () => {
   })
 
   it('should initialize from environment variables', () => {
-    process.env.DD_CODE_ORIGIN_FOR_SPANS_ENABLED = 'true'
+    process.env.DD_CODE_ORIGIN_FOR_SPANS_ENABLED = 'false'
+    process.env.DD_CODE_ORIGIN_FOR_SPANS_EXPERIMENTAL_EXIT_SPANS_ENABLED = 'true'
     process.env.DD_TRACE_AGENT_HOSTNAME = 'agent'
     process.env.DD_TRACE_AGENT_PORT = '6218'
     process.env.DD_DOGSTATSD_HOSTNAME = 'dsd-agent'
@@ -561,7 +564,8 @@ describe('Config', () => {
     expect(config).to.have.property('middlewareTracingEnabled', false)
     expect(config).to.have.property('runtimeMetrics', true)
     expect(config).to.have.property('reportHostname', true)
-    expect(config).to.have.nested.property('codeOriginForSpans.enabled', true)
+    expect(config).to.have.nested.property('codeOriginForSpans.enabled', false)
+    expect(config).to.have.nested.property('codeOriginForSpans.experimental.exit_spans.enabled', true)
     expect(config).to.have.nested.property('dynamicInstrumentation.enabled', true)
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactedIdentifiers', ['foo', 'bar'])
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactionExcludedIdentifiers', ['a', 'b', 'c'])
@@ -668,7 +672,8 @@ describe('Config', () => {
       { name: 'clientIpEnabled', value: true, origin: 'env_var' },
       { name: 'clientIpHeader', value: 'x-true-client-ip', origin: 'env_var' },
       { name: 'crashtracking.enabled', value: false, origin: 'env_var' },
-      { name: 'codeOriginForSpans.enabled', value: true, origin: 'env_var' },
+      { name: 'codeOriginForSpans.enabled', value: false, origin: 'env_var' },
+      { name: 'codeOriginForSpans.experimental.exit_spans.enabled', value: true, origin: 'env_var' },
       { name: 'dogstatsd.hostname', value: 'dsd-agent', origin: 'env_var' },
       { name: 'dogstatsd.port', value: '5218', origin: 'env_var' },
       { name: 'dynamicInstrumentation.enabled', value: true, origin: 'env_var' },
@@ -886,7 +891,12 @@ describe('Config', () => {
       clientIpEnabled: true,
       clientIpHeader: 'x-true-client-ip',
       codeOriginForSpans: {
-        enabled: false
+        enabled: false,
+        experimental: {
+          exit_spans: {
+            enabled: true
+          }
+        }
       },
       sampleRate: 0.5,
       rateLimit: 1000,
@@ -989,6 +999,7 @@ describe('Config', () => {
     expect(config).to.have.property('plugins', false)
     expect(config).to.have.property('logLevel', logLevel)
     expect(config).to.have.nested.property('codeOriginForSpans.enabled', false)
+    expect(config).to.have.nested.property('codeOriginForSpans.experimental.exit_spans.enabled', true)
     expect(config).to.have.property('traceId128BitGenerationEnabled', true)
     expect(config).to.have.property('traceId128BitLoggingEnabled', true)
     expect(config).to.have.property('spanRemoveIntegrationFromService', true)
@@ -1048,6 +1059,7 @@ describe('Config', () => {
       { name: 'clientIpEnabled', value: true, origin: 'code' },
       { name: 'clientIpHeader', value: 'x-true-client-ip', origin: 'code' },
       { name: 'codeOriginForSpans.enabled', value: false, origin: 'code' },
+      { name: 'codeOriginForSpans.experimental.exit_spans.enabled', value: true, origin: 'code' },
       { name: 'dogstatsd.hostname', value: 'agent-dsd', origin: 'code' },
       { name: 'dogstatsd.port', value: '5218', origin: 'code' },
       { name: 'dynamicInstrumentation.enabled', value: true, origin: 'code' },
@@ -1259,6 +1271,8 @@ describe('Config', () => {
     process.env.DD_RUNTIME_METRICS_ENABLED = 'true'
     process.env.DD_TRACE_REPORT_HOSTNAME = 'true'
     process.env.DD_ENV = 'test'
+    process.env.DD_CODE_ORIGIN_FOR_SPANS_ENABLED = 'false'
+    process.env.DD_CODE_ORIGIN_FOR_SPANS_EXPERIMENTAL_EXIT_SPANS_ENABLED = 'true'
     process.env.DD_DYNAMIC_INSTRUMENTATION_ENABLED = 'true'
     process.env.DD_DYNAMIC_INSTRUMENTATION_REDACTED_IDENTIFIERS = 'foo,bar'
     process.env.DD_DYNAMIC_INSTRUMENTATION_REDACTION_EXCLUDED_IDENTIFIERS = 'a,b,c'
@@ -1394,7 +1408,12 @@ describe('Config', () => {
         pollInterval: 42
       },
       codeOriginForSpans: {
-        enabled: false
+        enabled: true,
+        experimental: {
+          exit_spans: {
+            enabled: false
+          }
+        }
       },
       traceId128BitGenerationEnabled: false,
       traceId128BitLoggingEnabled: false,
@@ -1417,7 +1436,8 @@ describe('Config', () => {
     expect(config).to.have.property('flushMinSpans', 500)
     expect(config).to.have.property('service', 'test')
     expect(config).to.have.property('version', '1.0.0')
-    expect(config).to.have.nested.property('codeOriginForSpans.enabled', false)
+    expect(config).to.have.nested.property('codeOriginForSpans.enabled', true)
+    expect(config).to.have.nested.property('codeOriginForSpans.experimental.exit_spans.enabled', false)
     expect(config).to.have.nested.property('dynamicInstrumentation.enabled', false)
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactedIdentifiers', ['foo2', 'bar2'])
     expect(config).to.have.nested.deep.property('dynamicInstrumentation.redactionExcludedIdentifiers', ['a2', 'b2'])

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

@@ -174,35 +174,49 @@ describe('OuboundPlugin', () => {
       instance = new OutboundPlugin(tracerStub)
     })
 
-    it('should not add exit tags to span if codeOriginForSpans.enabled is false', () => {
-      sinon.stub(instance, '_tracerConfig').value({ codeOriginForSpans: { enabled: false } })
-      const span = instance.startSpan('test')
-      expect(span.addTags).to.not.have.been.called
+    describe('disabled', () => {
+      const configs = [
+        { codeOriginForSpans: { enabled: false, experimental: { exit_spans: { enabled: false } } } },
+        { codeOriginForSpans: { enabled: false, experimental: { exit_spans: { enabled: true } } } },
+        { codeOriginForSpans: { enabled: true, experimental: { exit_spans: { enabled: false } } } }
+      ]
+
+      for (const config of configs) {
+        it(`should not add exit tags to span if ${JSON.stringify(config)}`, () => {
+          sinon.stub(instance, '_tracerConfig').value(config)
+          const span = instance.startSpan('test')
+          expect(span.addTags).to.not.have.been.called
+        })
+      }
     })
 
-    it('should add exit tags to span if codeOriginForSpans.enabled is true', () => {
-      sinon.stub(instance, '_tracerConfig').value({ codeOriginForSpans: { enabled: true } })
+    describe('enabled', () => {
+      const config = { codeOriginForSpans: { enabled: true, experimental: { exit_spans: { enabled: true } } } }
 
-      const lineNumber = String(getNextLineNumber())
-      const span = instance.startSpan('test')
+      it(`should add exit tags to span if ${JSON.stringify(config)}`, () => {
+        sinon.stub(instance, '_tracerConfig').value(config)
 
-      expect(span.addTags).to.have.been.calledOnce
-      const args = span.addTags.args[0]
-      expect(args).to.have.property('length', 1)
-      const tags = parseTags(args[0])
+        const lineNumber = String(getNextLineNumber())
+        const span = instance.startSpan('test')
 
-      expect(tags).to.nested.include({ '_dd.code_origin.type': 'exit' })
-      expect(tags._dd.code_origin).to.have.property('frames').to.be.an('array').with.length.above(0)
+        expect(span.addTags).to.have.been.calledOnce
+        const args = span.addTags.args[0]
+        expect(args).to.have.property('length', 1)
+        const tags = parseTags(args[0])
 
-      for (const frame of tags._dd.code_origin.frames) {
-        expect(frame).to.have.property('file', __filename)
-        expect(frame).to.have.property('line').to.match(/^\d+$/)
-        expect(frame).to.have.property('column').to.match(/^\d+$/)
-        expect(frame).to.have.property('type').to.a('string')
-      }
+        expect(tags).to.nested.include({ '_dd.code_origin.type': 'exit' })
+        expect(tags._dd.code_origin).to.have.property('frames').to.be.an('array').with.length.above(0)
 
-      const topFrame = tags._dd.code_origin.frames[0]
-      expect(topFrame).to.have.property('line', lineNumber)
+        for (const frame of tags._dd.code_origin.frames) {
+          expect(frame).to.have.property('file', __filename)
+          expect(frame).to.have.property('line').to.match(/^\d+$/)
+          expect(frame).to.have.property('column').to.match(/^\d+$/)
+          expect(frame).to.have.property('type').to.a('string')
+        }
+
+        const topFrame = tags._dd.code_origin.frames[0]
+        expect(topFrame).to.have.property('line', lineNumber)
+      })
     })
   })
 })