dd-trace 5.97.0 → 5.98.0

package/packages/dd-trace/src/plugins/util/web.js

@@ -7,8 +7,9 @@ const log = require('../../log')
 const tags = require('../../../../../ext/tags')
 const types = require('../../../../../ext/types')
 const kinds = require('../../../../../ext/kinds')
-const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../constants')
+const { ERROR_MESSAGE } = require('../../constants')
 const TracingPlugin = require('../tracing')
+const { storage } = require('../../../../datadog-core')
 const urlFilter = require('./urlfilter')
 const { createInferredProxySpan, finishInferredProxySpan } = require('./inferred_proxy')
 const { extractURL, obfuscateQs, calculateHttpEndpoint } = require('./url')
@@ -125,33 +126,13 @@ const web = {
     context.tracer = tracer
     context.span = span
     context.res = res
+    context.store = storage('legacy').getStore()
 
     this.setConfig(req, config)
     addRequestTags(context, this.TYPE)
 
     return span
   },
-  wrap (req) {
-    const context = contexts.get(req)
-    if (!context.instrumented) {
-      this.wrapEnd(context)
-      context.instrumented = true
-    }
-  },
-  // Start a span and activate a scope for a request.
-  instrument (tracer, config, req, res, name, callback) {
-    const span = this.startSpan(tracer, config, req, res, name)
-
-    this.wrap(req)
-
-    return callback && tracer.scope().activate(span, () => callback(span))
-  },
-
-  // Reactivate the request scope in case it was changed by a middleware.
-  reactivate (req, fn) {
-    return reactivate(req, fn)
-  },
-
   // Add a route segment that will be used for the resource name.
   enterRoute (req, path) {
     if (typeof path === 'string') {
@@ -172,61 +153,6 @@ const web = {
     contexts.get(req).paths.pop()
   },
 
-  // Start a new middleware span and activate a new scope with the span.
-  wrapMiddleware (req, middleware, name, fn) {
-    if (!this.active(req)) return fn()
-
-    const context = contexts.get(req)
-    const tracer = context.tracer
-    const childOf = this.active(req)
-    const config = context.config
-    const traceCtx = context.traceCtx
-
-    if (config.middleware === false) return this.bindAndWrapMiddlewareErrors(fn, req, tracer, childOf)
-
-    const span = startSpanHelper(tracer, name, { childOf }, traceCtx, config)
-
-    analyticsSampler.sample(span, config.measured)
-
-    span.addTags({
-      [RESOURCE_NAME]: middleware._name || middleware.name || '<anonymous>',
-    })
-
-    context.middleware.push(span)
-
-    return tracer.scope().activate(span, fn)
-  },
-
-  // catch errors and apply to active span
-  bindAndWrapMiddlewareErrors (fn, req, tracer, activeSpan) {
-    try {
-      return tracer.scope().bind(fn, activeSpan).apply(this, arguments)
-    } catch (e) {
-      web.addError(req, e) // TODO: remove when error formatting is moved to Span
-      throw e
-    }
-  },
-
-  // Finish the active middleware span.
-  finish (req, error) {
-    if (!this.active(req)) return
-
-    const context = contexts.get(req)
-    const span = context.middleware.pop()
-
-    if (span) {
-      if (error) {
-        span.addTags({
-          [ERROR_TYPE]: error.name,
-          [ERROR_MESSAGE]: error.message,
-          [ERROR_STACK]: error.stack,
-        })
-      }
-
-      span.finish()
-    }
-  },
-
   // Register a callback to run before res.end() is called.
   beforeEnd (req, callback) {
     contexts.get(req).beforeEnd.push(callback)
@@ -278,7 +204,6 @@ const web = {
   startServerlessSpanWithInferredProxy (tracer, config, name, req, traceCtx) {
     const headers = req.headers
     const reqCtx = contexts.get(req)
-    const { storage } = require('../../../../datadog-core')
     const store = storage('legacy').getStore()
     const pubsubSpan = store?.span?._name === 'pubsub.push.receive' ? store.span : null
 
@@ -391,7 +316,6 @@ const web = {
     }
   },
   wrapEnd (context) {
-    const scope = context.tracer.scope()
     const req = context.req
     const res = context.res
     const end = res.end
@@ -406,7 +330,9 @@ const web = {
         return ends.get(this)
       },
       set (value) {
-        ends.set(this, scope.bind(value, context.span))
+        ends.set(this, function () {
+          return storage('legacy').run(context.store, value, ...arguments)
+        })
       },
     })
   },
@@ -453,14 +379,6 @@ function splitHeader (str) {
   return typeof str === 'string' ? str.split(/\s*,\s*/) : []
 }
 
-function reactivate (req, fn) {
-  const context = contexts.get(req)
-
-  return context
-    ? context.tracer.scope().activate(context.span, fn)
-    : fn()
-}
-
 function addRequestTags (context, spanType) {
   const { req, span, inferredProxySpan, config } = context
   const url = extractURL(req)

package/packages/dd-trace/src/profiling/profiler.js

@@ -12,12 +12,6 @@ const { isWebServerSpan, endpointNameFromTags, getStartedSpans } = require('./we
 const profileSubmittedChannel = dc.channel('datadog:profiling:profile-submitted')
 const spanFinishedChannel = dc.channel('dd-trace:span:finish')
 
-function logError (logger, ...args) {
-  if (logger) {
-    logger.error(...args)
-  }
-}
-
 function findWebSpan (startedSpans, spanId) {
   for (let i = startedSpans.length; --i >= 0;) {
     const ispan = startedSpans[i]
@@ -71,33 +65,6 @@ class Profiler extends EventEmitter {
     return this.#config?.flushInterval
   }
 
-  /**
-   * @param {import('../config/config-base')} config - Tracer configuration
-   */
-  start (config) {
-    // TODO: Unify with main logger and rewrite template strings to use printf formatting.
-    const logger = {
-      debug: log.debug.bind(log),
-      info: log.info.bind(log),
-      warn: log.warn.bind(log),
-      error: log.error.bind(log),
-    }
-
-    // TODO: Rewrite this to not need to copy the config.
-    const options = {
-      ...config,
-      logger,
-    }
-
-    try {
-      return this._start(options)
-    } catch (err) {
-      logError(logger, 'Error starting profiler. For troubleshooting tips, see ' +
-        '<https://dtdg.co/nodejs-profiler-troubleshooting>', err)
-      return false
-    }
-  }
-
   get enabled () {
     return this.#enabled
   }
@@ -141,10 +108,6 @@ class Profiler extends EventEmitter {
     return fn()
   }
 
-  #logError (err) {
-    logError(this.#logger, err)
-  }
-
   #getCompressionFn () {
     if (!this.#compressionFnInitialized) {
       this.#compressionFnInitialized = true
@@ -181,8 +144,8 @@ class Profiler extends EventEmitter {
             }
             break
         }
-      } catch (err) {
-        this.#logError(err)
+      } catch (error) {
+        log.error(error)
       }
     }
     return this.#compressionFn
@@ -191,41 +154,36 @@ class Profiler extends EventEmitter {
   /**
    * @param {import('../config/config-base')} options - Tracer configuration
    */
-  _start (options) {
+  start (options) {
     if (this.enabled) return true
+    this.#enabled = true
 
     const config = this.#config = new Config(options)
-
     this.#logger = config.logger
-    this.#enabled = true
-    this._setInterval()
 
+    this._setInterval()
     // Log errors if the source map finder fails, but don't prevent the rest
     // of the profiler from running without source maps.
     let mapper
-    try {
-      const { setLogger, SourceMapper } = require('@datadog/pprof')
-      setLogger(config.logger)
-
-      if (config.sourceMap) {
-        mapper = new SourceMapper(config.debugSourceMaps)
-        mapper.loadDirectory(process.cwd())
-          .then(() => {
-            if (config.debugSourceMaps) {
-              const count = mapper.infoMap.size
-              this.#logger.debug(() => {
-                return count === 0
-                  ? 'Found no source maps'
-                  : `Found source maps for following files: [${[...mapper.infoMap.keys()].join(', ')}]`
-              })
-            }
-          })
-          .catch((err) => {
-            this.#logError(err)
-          })
-      }
-    } catch (err) {
-      this.#logError(err)
+    const { setLogger, SourceMapper } = require('@datadog/pprof')
+    setLogger(config.logger)
+
+    if (config.sourceMap) {
+      mapper = new SourceMapper(config.debugSourceMaps)
+      mapper.loadDirectory(process.cwd())
+        .then(() => {
+          if (config.debugSourceMaps) {
+            const count = mapper.infoMap.size
+            this.#logger.debug(() => {
+              return count === 0
+                ? 'Found no source maps'
+                : `Found source maps for following files: [${[...mapper.infoMap.keys()].join(', ')}]`
+            })
+          }
+        })
+        .catch((error) => {
+          log.error(error)
+        })
     }
 
     try {
@@ -246,12 +204,13 @@ class Profiler extends EventEmitter {
       }
 
       this._capture(this._timeoutInterval, start)
-      return true
-    } catch (e) {
-      this.#logError(e)
+    } catch (error) {
+      log.error(error)
       this.#stop()
       return false
     }
+
+    return true
   }
 
   #nearOOMExport (profileType, encodedProfile, info) {
@@ -389,10 +348,10 @@ class Profiler extends EventEmitter {
             return `Collected ${profiler.type} profile: ` + profileJson
           })
           hasEncoded = true
-        } catch (err) {
+        } catch (error) {
           // If encoding one of the profile types fails, we should still try to
           // encode and submit the other profile types.
-          this.#logError(err)
+          log.error(error)
         }
       }))
 
@@ -401,8 +360,8 @@ class Profiler extends EventEmitter {
         profileSubmittedChannel.publish()
         this.#logger.debug('Submitted profiles')
       }
-    } catch (err) {
-      this.#logError(err)
+    } catch (error) {
+      log.error(error)
       this.#stop()
     }
   }
@@ -424,10 +383,8 @@ class Profiler extends EventEmitter {
       : undefined
     const exportSpec = { profiles, infos, start, end, tags, endpointCounts, customAttributes }
     const tasks = this.#config.exporters.map(exporter =>
-      exporter.export(exportSpec).catch(err => {
-        if (this.#logger) {
-          this.#logger.warn(err)
-        }
+      exporter.export(exportSpec).catch(error => {
+        log.warn(error)
       })
     )
 

package/packages/dd-trace/src/proxy.js

@@ -255,10 +255,10 @@ class Tracer extends NoopProxy {
     // do not stop tracer initialization if the profiler fails to be imported
     try {
       return require('./profiler').start(config)
-    } catch (e) {
+    } catch (error) {
       log.error(
         'Error starting profiler. For troubleshooting tips, see <https://dtdg.co/nodejs-profiler-troubleshooting>',
-        e
+        error
       )
       return false
     }
@@ -279,7 +279,12 @@ class Tracer extends NoopProxy {
         const prioritySampler = config.apmTracingEnabled === false
           ? require('./standalone').configure(config)
           : undefined
-        this._tracer = new DatadogTracer(config, prioritySampler)
+        let otlpExporter
+        if (config.otelTracesEnabled) {
+          const { buildResourceAttributes, createOtlpTraceExporter } = require('./opentelemetry/trace')
+          otlpExporter = createOtlpTraceExporter(config, buildResourceAttributes(config))
+        }
+        this._tracer = new DatadogTracer(config, prioritySampler, otlpExporter)
         this.dataStreamsCheckpointer = this._tracer.dataStreamsCheckpointer
         lazyProxy(this, 'appsec', () => require('./appsec/sdk'), this._tracer, config)
         lazyProxy(this, 'llmobs', () => require('./llmobs/sdk'), this._tracer, this._modules.llmobs, config)

package/packages/dd-trace/src/runtime_metrics/runtime_metrics.js

@@ -55,17 +55,21 @@ module.exports = {
       startGCObserver()
     }
 
-    // Using no-gc prevents the native gc metrics from being tracked. Not
-    // passing any options means all metrics are tracked.
-    // TODO: This is a workaround. We should find a better solution.
-    const watchers = trackEventLoop ? ['loop'] : ['no-gc']
-
-    try {
-      nativeMetrics = require('@datadog/native-metrics')
-      nativeMetrics.start(...watchers)
-    } catch (error) {
-      log.error('Error starting native metrics', error)
-      nativeMetrics = null
+    const useNative = config.runtimeMetrics.native !== false
+
+    if (useNative) {
+      // Using no-gc prevents the native gc metrics from being tracked. Not
+      // passing any options means all metrics are tracked.
+      // TODO: This is a workaround. We should find a better solution.
+      const watchers = trackEventLoop ? ['loop'] : ['no-gc']
+
+      try {
+        nativeMetrics = require('@datadog/native-metrics')
+        nativeMetrics.start(...watchers)
+      } catch (error) {
+        log.error('Error starting native metrics', error)
+        nativeMetrics = null
+      }
     }
 
     client = new MetricsAggregationClient(new DogStatsDClient(clientConfig))

package/packages/dd-trace/src/service-naming/index.js

@@ -41,7 +41,7 @@ class SchemaManager {
    * @param {string} kind
    * @param {string} plugin
    * @param {object} opts
-   * @returns {string}
+   * @returns {object} {name, source}
    */
   serviceName (type, kind, plugin, opts) {
     const schema = this.shouldUseConsistentServiceNaming

package/packages/dd-trace/src/service-naming/schemas/definition.js

@@ -12,7 +12,10 @@ class SchemaDefinition {
 
   getServiceName (type, kind, plugin, opts) {
     const item = this.schema[type][kind][plugin]
-    return item.serviceName(opts)
+    return {
+      name: item.serviceName(opts),
+      source: item.serviceSource?.(opts),
+    }
   }
 }
 

package/packages/dd-trace/src/service-naming/schemas/util.js

@@ -18,8 +18,22 @@ function httpPluginClientService ({ tracerService, pluginConfig, sessionDetails
   return tracerService
 }
 
+function optionServiceSource ({ pluginConfig }) {
+  if (pluginConfig.splitByDomain) {
+    return 'opt.split_by_domain'
+  }
+
+  if (pluginConfig.service) {
+    return 'opt.plugin'
+  }
+}
+
 function awsServiceV0 ({ tracerService, awsService }) {
   return `${tracerService}-aws-${awsService}`
 }
 
-module.exports = { identityService, httpPluginClientService, awsServiceV0 }
+function awsServiceSource ({ awsService }) {
+  return awsService
+}
+
+module.exports = { identityService, httpPluginClientService, awsServiceV0, optionServiceSource, awsServiceSource }

package/packages/dd-trace/src/service-naming/schemas/v0/messaging.js

@@ -1,66 +1,83 @@
 'use strict'
 
-const { identityService, awsServiceV0 } = require('../util')
+const { identityService, awsServiceV0, awsServiceSource } = require('../util')
 
 function amqpServiceName ({ tracerService }) {
   return `${tracerService}-amqp`
 }
 
+function integrationSource (source) {
+  return () => source
+}
+
 const messaging = {
   producer: {
     amqplib: {
       opName: () => 'amqp.command',
       serviceName: amqpServiceName,
+      serviceSource: integrationSource('amqp'),
     },
     amqp10: {
       opName: () => 'amqp.send',
       serviceName: amqpServiceName,
+      serviceSource: integrationSource('amqp'),
     },
     'azure-event-hubs': {
       opName: () => 'azure.eventhubs.send',
       serviceName: ({ tracerService }) => `${tracerService}-azure-event-hubs`,
+      serviceSource: integrationSource('azure-event-hubs'),
     },
     'azure-service-bus': {
       opName: () => 'azure.servicebus.send',
       serviceName: ({ tracerService }) => `${tracerService}-azure-service-bus`,
+      serviceSource: integrationSource('azure-service-bus'),
     },
     'google-cloud-pubsub': {
       opName: () => 'pubsub.request',
       serviceName: ({ tracerService }) => `${tracerService}-pubsub`,
+      serviceSource: integrationSource('google-cloud-pubsub'),
     },
     kafkajs: {
       opName: () => 'kafka.produce',
       serviceName: ({ tracerService }) => `${tracerService}-kafka`,
+      serviceSource: integrationSource('kafka'),
     },
     'confluentinc-kafka-javascript': {
       opName: () => 'kafka.produce',
       serviceName: ({ tracerService }) => `${tracerService}-kafka`,
+      serviceSource: integrationSource('kafka'),
     },
     rhea: {
       opName: () => 'amqp.send',
       serviceName: ({ tracerService }) => `${tracerService}-amqp-producer`,
+      serviceSource: integrationSource('amqp'),
     },
     sqs: {
       opName: () => 'aws.request',
       serviceName: awsServiceV0,
+      serviceSource: awsServiceSource,
     },
     sns: {
       opName: () => 'aws.request',
       serviceName: awsServiceV0,
+      serviceSource: awsServiceSource,
     },
     bullmq: {
       opName: () => 'bullmq.add',
       serviceName: ({ tracerService }) => `${tracerService}-bullmq`,
+      serviceSource: integrationSource('bullmq'),
     },
   },
   consumer: {
     amqplib: {
       opName: () => 'amqp.command',
       serviceName: amqpServiceName,
+      serviceSource: integrationSource('amqp'),
     },
     amqp10: {
       opName: () => 'amqp.receive',
       serviceName: amqpServiceName,
+      serviceSource: integrationSource('amqp'),
     },
     'google-cloud-pubsub': {
       opName: () => 'pubsub.receive',
@@ -69,10 +86,12 @@ const messaging = {
     kafkajs: {
       opName: () => 'kafka.consume',
       serviceName: ({ tracerService }) => `${tracerService}-kafka`,
+      serviceSource: integrationSource('kafka'),
     },
     'confluentinc-kafka-javascript': {
       opName: () => 'kafka.consume',
       serviceName: ({ tracerService }) => `${tracerService}-kafka`,
+      serviceSource: integrationSource('kafka'),
     },
     rhea: {
       opName: () => 'amqp.receive',
@@ -81,20 +100,24 @@ const messaging = {
     sqs: {
       opName: () => 'aws.request',
       serviceName: awsServiceV0,
+      serviceSource: awsServiceSource,
     },
     bullmq: {
       opName: () => 'bullmq.processJob',
       serviceName: ({ tracerService }) => `${tracerService}-bullmq`,
+      serviceSource: integrationSource('bullmq'),
     },
   },
   client: {
     amqplib: {
       opName: () => 'amqp.command',
       serviceName: amqpServiceName,
+      serviceSource: integrationSource('amqp'),
     },
     'google-cloud-pubsub': {
       opName: () => 'pubsub.request',
       serviceName: ({ tracerService }) => `${tracerService}-pubsub`,
+      serviceSource: integrationSource('google-cloud-pubsub'),
     },
   },
 }