dd-trace 5.61.0 → 5.62.0

package/packages/dd-trace/src/plugins/consumer.js

@@ -3,9 +3,9 @@
 const InboundPlugin = require('./inbound')
 
 class ConsumerPlugin extends InboundPlugin {
-  static get operation () { return 'receive' }
-  static get kind () { return 'consumer' }
-  static get type () { return 'messaging' }
+  static operation = 'receive'
+  static kind = 'consumer'
+  static type = 'messaging'
 
   startSpan (options, enterOrCtx) {
     if (!options.service) {

package/packages/dd-trace/src/plugins/database.js

@@ -4,8 +4,8 @@ const StoragePlugin = require('./storage')
 const { PEER_SERVICE_KEY, PEER_SERVICE_SOURCE_KEY } = require('../constants')
 
 class DatabasePlugin extends StoragePlugin {
-  static get operation () { return 'query' }
-  static get peerServicePrecursors () { return ['db.name'] }
+  static operation = 'query'
+  static peerServicePrecursors = ['db.name']
 
   constructor (...args) {
     super(...args)

package/packages/dd-trace/src/plugins/index.js

@@ -75,6 +75,7 @@ module.exports = {
   get moleculer () { return require('../../../datadog-plugin-moleculer/src') },
   get mongodb () { return require('../../../datadog-plugin-mongodb-core/src') },
   get 'mongodb-core' () { return require('../../../datadog-plugin-mongodb-core/src') },
+  get mongoose () { return require('../../../datadog-plugin-mongoose/src') },
   get mysql () { return require('../../../datadog-plugin-mysql/src') },
   get mysql2 () { return require('../../../datadog-plugin-mysql2/src') },
   get net () { return require('../../../datadog-plugin-net/src') },

package/packages/dd-trace/src/plugins/log_plugin.js

@@ -45,14 +45,10 @@ module.exports = class LogPlugin extends Plugin {
     })
   }
 
-  _isEnabled (config) {
-    return config.enabled && (config.logInjection === true || config.ciVisAgentlessLogSubmissionEnabled)
-  }
-
   configure (config) {
     return super.configure({
       ...config,
-      enabled: this._isEnabled(config)
+      enabled: config.enabled && (config.logInjection || config.ciVisAgentlessLogSubmissionEnabled)
     })
   }
 }

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

@@ -17,7 +17,7 @@ const COMMON_PEER_SVC_SOURCE_TAGS = [
 
 // TODO: Exit span on finish when AsyncResource instances are removed.
 class OutboundPlugin extends TracingPlugin {
-  static get peerServicePrecursors () { return [] }
+  static peerServicePrecursors = []
 
   constructor (...args) {
     super(...args)

package/packages/dd-trace/src/plugins/plugin.js

@@ -60,7 +60,7 @@ module.exports = class Plugin {
   }
 
   get tracer () {
-    return this._tracer._tracer
+    return this._tracer?._tracer || this._tracer
   }
 
   enter (span, store) {

package/packages/dd-trace/src/plugins/producer.js

@@ -3,9 +3,9 @@
 const OutboundPlugin = require('./outbound')
 
 class ProducerPlugin extends OutboundPlugin {
-  static get operation () { return 'publish' }
-  static get kind () { return 'producer' }
-  static get type () { return 'messaging' }
+  static operation = 'publish'
+  static kind = 'producer'
+  static type = 'messaging'
 
   startSpan (options, enterOrCtx) {
     const spanDefaults = {

package/packages/dd-trace/src/plugins/server.js

@@ -3,9 +3,9 @@
 const InboundPlugin = require('./inbound')
 
 class ServerPlugin extends InboundPlugin {
-  static get operation () { return 'request' }
-  static get kind () { return 'server' }
-  static get type () { return 'web' } // a default that may eventually be overriden by nonweb servers
+  static operation = 'request'
+  static kind = 'server'
+  static type = 'web' // a default that may eventually be overriden by nonweb servers
 }
 
 module.exports = ServerPlugin

package/packages/dd-trace/src/plugins/storage.js

@@ -3,7 +3,7 @@
 const ClientPlugin = require('./client')
 
 class StoragePlugin extends ClientPlugin {
-  static get type () { return 'storage' }
+  static type = 'storage'
 
   constructor (...args) {
     super(...args)

package/packages/dd-trace/src/plugins/tracing.js

@@ -102,28 +102,46 @@ class TracingPlugin extends Plugin {
     }
   }
 
-  startSpan (name, { childOf, kind, meta, metrics, service, resource, type } = {}, enterOrCtx = true) {
+  startSpan (name, options = {}, enterOrCtx = true) {
+    // TODO: modularize this code to a helper function
+    let {
+      component = this.component,
+      childOf,
+      integrationName,
+      kind,
+      meta,
+      metrics,
+      service,
+      startTime,
+      resource,
+      type
+    } = options
+
+    const tracer = options.tracer || this.tracer
+    const config = options.config || this.config
+
     const store = storage('legacy').getStore()
     if (store && childOf === undefined) {
       childOf = store.span
     }
 
-    const span = this.tracer.startSpan(name, {
+    const span = tracer.startSpan(name, {
+      startTime,
       childOf,
       tags: {
-        [COMPONENT]: this.component,
-        'service.name': service || this.tracer._service,
+        [COMPONENT]: component,
+        'service.name': service || meta?.service || tracer._service,
         'resource.name': resource,
         'span.kind': kind,
         'span.type': type,
         ...meta,
         ...metrics
       },
-      integrationName: this.component,
+      integrationName: integrationName || component,
       links: childOf?._links
     })
 
-    analyticsSampler.sample(span, this.config.measured)
+    analyticsSampler.sample(span, config.measured)
 
     // TODO: Remove this after migration to TracingChannel is done.
     if (enterOrCtx === true) {

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

@@ -28,7 +28,8 @@ const {
   CI_NODE_LABELS,
   CI_NODE_NAME,
   PR_NUMBER,
-  CI_JOB_ID
+  CI_JOB_ID,
+  GIT_PULL_REQUEST_BASE_BRANCH_HEAD_SHA
 } = require('./tags')
 const { filterSensitiveInfoFromRepository } = require('./url')
 const { getEnvironmentVariable, getEnvironmentVariables } = require('../../config-helper')
@@ -187,7 +188,9 @@ module.exports = {
         CI_RUNNER_ID,
         CI_RUNNER_TAGS,
         CI_MERGE_REQUEST_TARGET_BRANCH_NAME,
-        CI_MERGE_REQUEST_IID
+        CI_MERGE_REQUEST_IID,
+        CI_MERGE_REQUEST_TARGET_BRANCH_SHA,
+        CI_MERGE_REQUEST_DIFF_BASE_SHA
       } = env
 
       const { name, email } = parseEmailAndName(CI_COMMIT_AUTHOR)
@@ -219,7 +222,9 @@ module.exports = {
         [CI_NODE_NAME]: CI_RUNNER_ID,
         [GIT_PULL_REQUEST_BASE_BRANCH]: CI_MERGE_REQUEST_TARGET_BRANCH_NAME,
         [PR_NUMBER]: CI_MERGE_REQUEST_IID,
-        [CI_JOB_ID]: GITLAB_CI_JOB_ID
+        [CI_JOB_ID]: GITLAB_CI_JOB_ID,
+        [GIT_PULL_REQUEST_BASE_BRANCH_SHA]: CI_MERGE_REQUEST_DIFF_BASE_SHA,
+        [GIT_PULL_REQUEST_BASE_BRANCH_HEAD_SHA]: CI_MERGE_REQUEST_TARGET_BRANCH_SHA
       }
     }
 
@@ -315,7 +320,7 @@ module.exports = {
         tags[GIT_PULL_REQUEST_BASE_BRANCH] = GITHUB_BASE_REF
         try {
           const eventContent = getGitHubEventPayload()
-          tags[GIT_PULL_REQUEST_BASE_BRANCH_SHA] = eventContent.pull_request.base.sha
+          tags[GIT_PULL_REQUEST_BASE_BRANCH_HEAD_SHA] = eventContent.pull_request.base.sha
           tags[GIT_COMMIT_HEAD_SHA] = eventContent.pull_request.head.sha
         } catch {
           // ignore malformed event content
@@ -522,8 +527,7 @@ module.exports = {
         BUILDKITE_MESSAGE,
         BUILDKITE_AGENT_ID,
         BUILDKITE_PULL_REQUEST,
-        BUILDKITE_PULL_REQUEST_BASE_BRANCH,
-        BUILDKITE_CI_JOB_ID
+        BUILDKITE_PULL_REQUEST_BASE_BRANCH
       } = env
 
       const extraTags = Object.keys(env).filter(envVar =>
@@ -555,7 +559,7 @@ module.exports = {
         [CI_NODE_NAME]: BUILDKITE_AGENT_ID,
         [CI_NODE_LABELS]: JSON.stringify(extraTags),
         [PR_NUMBER]: BUILDKITE_PULL_REQUEST,
-        [CI_JOB_ID]: BUILDKITE_CI_JOB_ID
+        [CI_JOB_ID]: BUILDKITE_JOB_ID
       }
 
       if (BUILDKITE_PULL_REQUEST) {

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

@@ -22,7 +22,7 @@ const supportedProxies = {
   }
 }
 
-function createInferredProxySpan (headers, childOf, tracer, context) {
+function createInferredProxySpan (headers, childOf, tracer, reqCtx, traceCtx, config, startSpanHelper) {
   if (!headers) {
     return null
   }
@@ -41,26 +41,22 @@ function createInferredProxySpan (headers, childOf, tracer, context) {
 
   log.debug('Successfully extracted inferred span info %s for proxy:', proxyContext, proxyContext.proxySystemName)
 
-  const span = tracer.startSpan(
-    proxySpanInfo.spanName,
-    {
-      childOf,
-      type: 'web',
-      startTime: proxyContext.requestTime,
-      integrationName: proxySpanInfo.component,
-      tags: {
-        service: proxyContext.domainName || tracer._config.service,
-        component: proxySpanInfo.component,
-        [SPAN_TYPE]: 'web',
-        [HTTP_METHOD]: proxyContext.method,
-        [HTTP_URL]: proxyContext.domainName + proxyContext.path,
-        stage: proxyContext.stage
-      }
+  const span = startSpanHelper(tracer, proxySpanInfo.spanName, {
+    childOf,
+    type: 'web',
+    startTime: proxyContext.requestTime,
+    integrationName: proxySpanInfo.component,
+    meta: {
+      service: proxyContext.domainName || tracer._config.service,
+      component: proxySpanInfo.component,
+      [SPAN_TYPE]: 'web',
+      [HTTP_METHOD]: proxyContext.method,
+      [HTTP_URL]: proxyContext.domainName + proxyContext.path,
+      stage: proxyContext.stage
     }
-  )
+  }, traceCtx, config)
 
-  tracer.scope().activate(span)
-  context.inferredProxySpan = span
+  reqCtx.inferredProxySpan = span
   childOf = span
 
   log.debug('Successfully created inferred proxy span.')

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

@@ -21,6 +21,7 @@ const GIT_COMMIT_HEAD_COMMITTER_EMAIL = 'git.commit.head.committer.email'
 const GIT_COMMIT_HEAD_COMMITTER_NAME = 'git.commit.head.committer.name'
 
 const GIT_PULL_REQUEST_BASE_BRANCH_SHA = 'git.pull_request.base_branch_sha'
+const GIT_PULL_REQUEST_BASE_BRANCH_HEAD_SHA = 'git.pull_request.base_branch_head_sha'
 const GIT_PULL_REQUEST_BASE_BRANCH = 'git.pull_request.base_branch'
 
 const CI_PIPELINE_ID = 'ci.pipeline.id'
@@ -61,6 +62,7 @@ module.exports = {
   GIT_COMMIT_HEAD_COMMITTER_EMAIL,
   GIT_COMMIT_HEAD_COMMITTER_NAME,
   GIT_PULL_REQUEST_BASE_BRANCH_SHA,
+  GIT_PULL_REQUEST_BASE_BRANCH_HEAD_SHA,
   GIT_PULL_REQUEST_BASE_BRANCH,
   CI_PIPELINE_ID,
   CI_PIPELINE_NAME,

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

@@ -10,6 +10,7 @@ const kinds = require('../../../../../ext/kinds')
 const urlFilter = require('./urlfilter')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../constants')
 const { createInferredProxySpan, finishInferredProxySpan } = require('./inferred_proxy')
+const TracingPlugin = require('../tracing')
 
 let extractIp
 
@@ -37,8 +38,25 @@ const HTTP2_HEADER_PATH = ':path'
 const contexts = new WeakMap()
 const ends = new WeakMap()
 
+// TODO: change this to no longer rely on creating a dummy plugin to be able to access startSpan
+function createWebPlugin (tracer, config = {}) {
+  const plugin = new TracingPlugin(tracer, tracer._config)
+  plugin.component = 'web'
+  plugin.config = config
+  return plugin
+}
+
+function startSpanHelper (tracer, name, options, traceCtx, config = {}) {
+  if (!web.plugin) {
+    web.plugin = createWebPlugin(tracer, config)
+  }
+
+  return web.plugin.startSpan(name, { ...options, tracer, config }, traceCtx)
+}
+
 const web = {
   TYPE: WEB,
+  plugin: null,
 
   // Ensure the configuration has the correct structure and defaults.
   normalizeConfig (config) {
@@ -93,7 +111,7 @@ const web = {
     analyticsSampler.sample(span, config.measured, true)
   },
 
-  startSpan (tracer, config, req, res, name) {
+  startSpan (tracer, config, req, res, name, traceCtx) {
     const context = this.patch(req)
 
     let span
@@ -102,7 +120,7 @@ const web = {
       context.span.context()._name = name
       span = context.span
     } else {
-      span = web.startChildSpan(tracer, name, req)
+      span = web.startChildSpan(tracer, config, name, req, traceCtx)
     }
 
     context.tracer = tracer
@@ -163,10 +181,11 @@ const web = {
     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 = tracer.startSpan(name, { childOf })
+    const span = startSpanHelper(tracer, name, { childOf }, traceCtx, config)
 
     analyticsSampler.sample(span, config.measured)
 
@@ -258,20 +277,20 @@ const web = {
   },
 
   // Extract the parent span from the headers and start a new span as its child
-  startChildSpan (tracer, name, req) {
+  startChildSpan (tracer, config, name, req, traceCtx) {
     const headers = req.headers
-    const context = contexts.get(req)
+    const reqCtx = contexts.get(req)
     let childOf = tracer.extract(FORMAT_HTTP_HEADERS, headers)
 
     // we may have headers signaling a router proxy span should be created (such as for AWS API Gateway)
     if (tracer._config?.inferredProxyServicesEnabled) {
-      const proxySpan = createInferredProxySpan(headers, childOf, tracer, context)
+      const proxySpan = createInferredProxySpan(headers, childOf, tracer, reqCtx, traceCtx, config, startSpanHelper)
       if (proxySpan) {
         childOf = proxySpan
       }
     }
 
-    const span = tracer.startSpan(name, { childOf, links: childOf?._links })
+    const span = startSpanHelper(tracer, name, { childOf }, traceCtx, config)
 
     return span
   },

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

@@ -171,6 +171,8 @@ class Config {
       samplingContextsAvailable))
     checkOptionWithSamplingContextAllowed(this.cpuProfilingEnabled, 'CPU profiling')
 
+    this.samplingInterval = coalesce(options.samplingInterval, 1e3 / 99) // 99hz in millis
+
     this.heapSamplingInterval = coalesce(options.heapSamplingInterval,
       Number(DD_PROFILING_HEAP_SAMPLING_INTERVAL))
     const uploadCompression0 = coalesce(options.uploadCompression, DD_PROFILING_DEBUG_UPLOAD_COMPRESSION, 'on')

package/packages/dd-trace/src/profiling/exporters/event_serializer.js

@@ -5,23 +5,7 @@
 const os = require('os')
 const perf = require('perf_hooks').performance
 const version = require('../../../../../package.json').version
-const { getEnvironmentVariable } = require('../../config-helper')
-
-const libuvThreadPoolSize = (() => {
-  const ss = getEnvironmentVariable('UV_THREADPOOL_SIZE')
-  if (ss === undefined) {
-    // Backend will apply the default size based on Node version.
-    return
-  }
-  // libuv uses atoi to parse the value, which is almost the same as parseInt, except that parseInt
-  // will return NaN on invalid input, while atoi will return 0. This is handled at return.
-  const s = Number.parseInt(ss)
-  // We don't interpret the value further here in the library. Backend will interpret the number
-  // based on Node version. In all currently known Node versions, 0 results in 1 worker thread,
-  // negative values (because they're assigned to an unsigned int) become very high positive values,
-  // and the value is finally capped at 1024.
-  return Number.isNaN(s) ? 0 : s
-})()
+const { availableParallelism, libuvThreadPoolSize } = require('../libuv-size')
 
 class EventSerializer {
   constructor ({ env, host, service, version, libraryInjected, activation } = {}) {
@@ -77,10 +61,7 @@ class EventSerializer {
           version
         },
         runtime: {
-          // os.availableParallelism only available in node 18.14.0/19.4.0 and above
-          available_processors: typeof os.availableParallelism === 'function'
-            ? os.availableParallelism()
-            : os.cpus().length,
+          available_processors: availableParallelism(),
           // Using `nodejs` for consistency with the existing `runtime` tag.
           // Note that the event `family` property uses `node`, as that's what's
           // proscribed by the Intake API, but that's an internal enum and is

package/packages/dd-trace/src/profiling/libuv-size.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const { getEnvironmentVariable } = require('../config-helper')
+const os = require('node:os')
+
+function getLibuvThreadPoolSize (envVar) {
+  if (envVar === undefined) {
+    return
+  }
+  // libuv uses atoi to parse the value, which is almost the same as parseInt, except that parseInt
+  // will return NaN on invalid input, while atoi will return 0. This is handled at return.
+  const s = Number.parseInt(envVar, 10)
+  // We don't interpret the value further here in the library. Backend will interpret the number
+  // based on Node version.
+  return Number.isNaN(s) ? 0 : s
+}
+
+const libuvThreadPoolSize = getLibuvThreadPoolSize(getEnvironmentVariable('UV_THREADPOOL_SIZE'))
+
+function getEffectiveLibuvThreadCount (size) {
+  // In all currently known Node versions, 0 results in 1 worker thread, negative values (because
+  // they're assigned to an unsigned int) become very high positive values, and the value is finally
+  // capped at 1024.
+  if (size === undefined) {
+    return 4
+  } else if (size < 0 || size > 1024) {
+    return 1024
+  } else if (size === 0) {
+    return 1
+  }
+  return size
+}
+
+const effectiveLibuvThreadCount = getEffectiveLibuvThreadCount(libuvThreadPoolSize)
+
+function availableParallelism () {
+  // os.availableParallelism only available in node 18.14.0/19.4.0 and above
+  // eslint-disable-next-line n/no-unsupported-features/node-builtins
+  return typeof os.availableParallelism === 'function' ? os.availableParallelism() : os.cpus().length
+}
+
+module.exports = {
+  availableParallelism,
+  effectiveLibuvThreadCount,
+  libuvThreadPoolSize,
+  // Only used for testing
+  getLibuvThreadPoolSize,
+  getEffectiveLibuvThreadCount
+}

package/packages/dd-trace/src/profiling/profilers/event_plugins/dns.js

@@ -3,13 +3,9 @@
 const EventPlugin = require('./event')
 
 class DNSPlugin extends EventPlugin {
-  static get id () {
-    return 'dns'
-  }
+  static id = 'dns'
 
-  static get entryType () {
-    return 'dns'
-  }
+  static entryType = 'dns'
 }
 
 module.exports = DNSPlugin

package/packages/dd-trace/src/profiling/profilers/event_plugins/dns_lookup.js

@@ -3,9 +3,7 @@
 const DNSPlugin = require('./dns')
 
 class DNSLookupPlugin extends DNSPlugin {
-  static get operation () {
-    return 'lookup'
-  }
+  static operation = 'lookup'
 
   extendEvent (event, startEvent) {
     event.name = 'lookup'

package/packages/dd-trace/src/profiling/profilers/event_plugins/dns_lookupservice.js

@@ -3,9 +3,7 @@
 const DNSPlugin = require('./dns')
 
 class DNSLookupServicePlugin extends DNSPlugin {
-  static get operation () {
-    return 'lookup_service'
-  }
+  static operation = 'lookup_service'
 
   extendEvent (event, startEvent) {
     event.name = 'lookupService'

package/packages/dd-trace/src/profiling/profilers/event_plugins/dns_resolve.js

@@ -5,9 +5,7 @@ const DNSPlugin = require('./dns')
 const queryNames = new Map()
 
 class DNSResolvePlugin extends DNSPlugin {
-  static get operation () {
-    return 'resolve'
-  }
+  static operation = 'resolve'
 
   extendEvent (event, startEvent) {
     const rrtype = startEvent.args[1]

package/packages/dd-trace/src/profiling/profilers/event_plugins/dns_reverse.js

@@ -3,9 +3,7 @@
 const DNSPlugin = require('./dns')
 
 class DNSReversePlugin extends DNSPlugin {
-  static get operation () {
-    return 'reverse'
-  }
+  static operation = 'reverse'
 
   extendEvent (event, startEvent) {
     event.name = 'getHostByAddr'

package/packages/dd-trace/src/profiling/profilers/event_plugins/fs.js

@@ -19,17 +19,11 @@ const allowedParams = new Set([
 ])
 
 class FilesystemPlugin extends EventPlugin {
-  static get id () {
-    return 'fs'
-  }
+  static id = 'fs'
 
-  static get operation () {
-    return 'operation'
-  }
+  static operation = 'operation'
 
-  static get entryType () {
-    return 'fs'
-  }
+  static entryType = 'fs'
 
   ignoreEvent (event) {
     // Don't care about sync events, they show up in the event loop samples anyway

package/packages/dd-trace/src/profiling/profilers/event_plugins/net.js

@@ -3,17 +3,11 @@
 const EventPlugin = require('./event')
 
 class NetPlugin extends EventPlugin {
-  static get id () {
-    return 'net'
-  }
+  static id = 'net'
 
-  static get operation () {
-    return 'tcp'
-  }
+  static operation = 'tcp'
 
-  static get entryType () {
-    return 'net'
-  }
+  static entryType = 'net'
 
   extendEvent (event, { options }) {
     event.name = 'connect'