lazy load public api + profiling + crashtracking + span stats (#5256)

Author: rochdev

packages/dd-trace/src/config.js

@@ -754,7 +754,10 @@ class Config {
     this._setValue(env, 'baggageMaxItems', DD_TRACE_BAGGAGE_MAX_ITEMS)
     this._setBoolean(env, 'clientIpEnabled', DD_TRACE_CLIENT_IP_ENABLED)
     this._setString(env, 'clientIpHeader', DD_TRACE_CLIENT_IP_HEADER)
-    this._setBoolean(env, 'crashtracking.enabled', DD_CRASHTRACKING_ENABLED)
+    this._setBoolean(env, 'crashtracking.enabled', coalesce(
+      DD_CRASHTRACKING_ENABLED,
+      !this._isInServerlessEnvironment()
+    ))
     this._setBoolean(env, 'codeOriginForSpans.enabled', DD_CODE_ORIGIN_FOR_SPANS_ENABLED)
     this._setString(env, 'dbmPropagationMode', DD_DBM_PROPAGATION_MODE)
     this._setString(env, 'dogstatsd.hostname', DD_DOGSTATSD_HOST || DD_DOGSTATSD_HOSTNAME)
@@ -824,7 +827,11 @@ class Config {
       this._envUnprocessed.peerServiceMapping = DD_TRACE_PEER_SERVICE_MAPPING
     }
     this._setString(env, 'port', DD_TRACE_AGENT_PORT)
-    const profilingEnabledEnv = coalesce(DD_EXPERIMENTAL_PROFILING_ENABLED, DD_PROFILING_ENABLED)
+    const profilingEnabledEnv = coalesce(
+      DD_EXPERIMENTAL_PROFILING_ENABLED,
+      DD_PROFILING_ENABLED,
+      this._isInServerlessEnvironment() ? 'false' : undefined
+    )
     const profilingEnabled = isTrue(profilingEnabledEnv)
       ? 'true'
       : isFalse(profilingEnabledEnv)

packages/dd-trace/src/proxy.js

@@ -9,13 +9,7 @@ const DynamicInstrumentation = require('./debugger')
 const telemetry = require('./telemetry')
 const nomenclature = require('./service-naming')
 const PluginManager = require('./plugin_manager')
-const remoteConfig = require('./remote_config')
-const AppsecSdk = require('./appsec/sdk')
-const dogstatsd = require('./dogstatsd')
 const NoopDogStatsDClient = require('./noop/dogstatsd')
-const { SSIHeuristics } = require('./profiling/ssi-heuristics')
-const appsecStandalone = require('./appsec/standalone')
-const LLMObsSDK = require('./llmobs/sdk')
 
 class LazyModule {
   constructor (provider) {
@@ -32,6 +26,35 @@ class LazyModule {
   }
 }
 
+function lazyProxy (obj, property, config, getClass, ...args) {
+  if (config?._isInServerlessEnvironment?.() === false) {
+    defineEagerly(obj, property, getClass, ...args)
+  } else {
+    defineLazily(obj, property, getClass, ...args)
+  }
+}
+
+function defineEagerly (obj, property, getClass, ...args) {
+  const RealClass = getClass()
+
+  obj[property] = new RealClass(...args)
+}
+
+function defineLazily (obj, property, getClass, ...args) {
+  Reflect.defineProperty(obj, property, {
+    get () {
+      const RealClass = getClass()
+      const value = new RealClass(...args)
+
+      Reflect.defineProperty(obj, property, { value, configurable: true, enumerable: true })
+
+      return value
+    },
+    configurable: true,
+    enumerable: true
+  })
+}
+
 class Tracer extends NoopProxy {
   constructor () {
     super()
@@ -66,7 +89,8 @@ class Tracer extends NoopProxy {
       telemetry.start(config, this._pluginManager)
 
       if (config.dogstatsd) {
-        this.dogstatsd = new dogstatsd.CustomMetrics(config)
+        // Custom Metrics
+        lazyProxy(this, 'dogstatsd', config, () => require('./dogstatsd').CustomMetrics, config)
       }
 
       if (config.spanLeakDebug > 0) {
@@ -80,7 +104,7 @@ class Tracer extends NoopProxy {
       }
 
       if (config.remoteConfig.enabled && !config.isCiVisibility) {
-        const rc = remoteConfig.enable(config, this._modules.appsec)
+        const rc = require('./remote_config').enable(config, this._modules.appsec)
 
         rc.setProductHandler('APM_TRACING', (action, conf) => {
           if (action === 'unapply') {
@@ -120,6 +144,7 @@ class Tracer extends NoopProxy {
       }
 
       if (config.profiling.enabled !== 'false') {
+        const { SSIHeuristics } = require('./profiling/ssi-heuristics')
         const ssiHeuristics = new SSIHeuristics(config)
         ssiHeuristics.start()
         let mockProfiler = null
@@ -210,11 +235,11 @@ class Tracer extends NoopProxy {
         this._modules.llmobs.enable(config)
       }
       if (!this._tracingInitialized) {
-        const prioritySampler = appsecStandalone.configure(config)
+        const prioritySampler = config.appsec.standalone?.enabled && require('./appsec/standalone').configure(config)
         this._tracer = new DatadogTracer(config, prioritySampler)
         this.dataStreamsCheckpointer = this._tracer.dataStreamsCheckpointer
-        this.appsec = new AppsecSdk(this._tracer, config)
-        this.llmobs = new LLMObsSDK(this._tracer, this._modules.llmobs, config)
+        lazyProxy(this, 'appsec', config, () => require('./appsec/sdk'), this._tracer, config)
+        lazyProxy(this, 'llmobs', config, () => require('./llmobs/sdk'), this._tracer, this._modules.llmobs, config)
         this._tracingInitialized = true
       }
       if (config.iast.enabled) {

packages/dd-trace/src/span_processor.js

@@ -5,8 +5,6 @@ const format = require('./format')
 const SpanSampler = require('./span_sampler')
 const GitMetadataTagger = require('./git_metadata_tagger')
 
-const { SpanStatsProcessor } = require('./span_stats')
-
 const startedSpans = new WeakSet()
 const finishedSpans = new WeakSet()
 
@@ -20,7 +18,12 @@ class SpanProcessor {
     this._config = config
     this._killAll = false
 
-    this._stats = new SpanStatsProcessor(config)
+    // TODO: This should already have been calculated in `config.js`.
+    if (config.stats?.enabled && !config.appsec?.standalone?.enabled) {
+      const { SpanStatsProcessor } = require('./span_stats')
+      this._stats = new SpanStatsProcessor(config)
+    }
+
     this._spanSampler = new SpanSampler(config.sampler)
     this._gitMetadataTagger = new GitMetadataTagger(config)
   }
@@ -46,7 +49,7 @@ class SpanProcessor {
       for (const span of started) {
         if (span._duration !== undefined) {
           const formattedSpan = format(span)
-          this._stats.onSpanFinished(formattedSpan)
+          this._stats?.onSpanFinished(formattedSpan)
           formatted.push(formattedSpan)
 
           spanProcessCh.publish({ span })

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

@@ -127,7 +127,11 @@ describe('TracerProxy', () => {
       logger: 'logger',
       debug: true,
       profiling: {},
-      appsec: {},
+      appsec: {
+        standalone: {
+          enabled: true
+        }
+      },
       iast: {},
       crashtracking: {},
       dynamicInstrumentation: {},
@@ -329,6 +333,7 @@ describe('TracerProxy', () => {
 
         const remoteConfigProxy = new RemoteConfigProxy()
         remoteConfigProxy.init()
+        remoteConfigProxy.appsec // Eagerly trigger lazy loading.
         expect(DatadogTracer).to.have.been.calledOnce
         expect(AppsecSdk).to.have.been.calledOnce
         expect(appsec.enable).to.not.have.been.called
@@ -415,11 +420,11 @@ describe('TracerProxy', () => {
         }
 
         proxy.init()
-
-        expect(dogStatsD._config().dogstatsd.hostname).to.equal('localhost')
-
         proxy.dogstatsd.increment('foo', 10, { alpha: 'bravo' })
+
         const incs = dogStatsD._increments()
+
+        expect(dogStatsD._config().dogstatsd.hostname).to.equal('localhost')
         expect(incs.length).to.equal(1)
         expect(incs[0][0]).to.equal('foo')
         expect(incs[0][1]).to.equal(10)
@@ -530,6 +535,7 @@ describe('TracerProxy', () => {
 
         const proxy = new DatadogProxy()
         proxy.init(options)
+        proxy.appsec // Eagerly trigger lazy loading.
 
         const config = AppsecSdk.firstCall.args[1]
         expect(standalone.configure).to.have.been.calledOnceWithExactly(config)