dd-trace 4.19.0 → 4.21.0

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

@@ -20,6 +20,10 @@ class Tracer {
     return this
   }
 
+  profilerStarted () {
+    return Promise.resolve(false)
+  }
+
   trace (name, options, fn) {
     if (!fn) {
       fn = options

package/packages/dd-trace/src/opentracing/propagation/text_map.js

@@ -236,11 +236,20 @@ class TextMapPropagator {
   _extractDatadogContext (carrier) {
     const spanContext = this._extractGenericContext(carrier, traceKey, spanKey, 10)
 
-    if (spanContext) {
-      this._extractOrigin(carrier, spanContext)
-      this._extractBaggageItems(carrier, spanContext)
-      this._extractSamplingPriority(carrier, spanContext)
-      this._extractTags(carrier, spanContext)
+    if (!spanContext) return spanContext
+
+    this._extractOrigin(carrier, spanContext)
+    this._extractBaggageItems(carrier, spanContext)
+    this._extractSamplingPriority(carrier, spanContext)
+    this._extractTags(carrier, spanContext)
+
+    if (this._config.tracePropagationExtractFirst) return spanContext
+
+    const tc = this._extractTraceparentContext(carrier)
+
+    if (tc && spanContext._traceId.equals(tc._traceId)) {
+      spanContext._traceparent = tc._traceparent
+      spanContext._tracestate = tc._tracestate
     }
 
     return spanContext

package/packages/dd-trace/src/opentracing/span.js

@@ -13,6 +13,7 @@ const log = require('../log')
 const { storage } = require('../../../datadog-core')
 const telemetryMetrics = require('../telemetry/metrics')
 const { channel } = require('dc-polyfill')
+const spanleak = require('../spanleak')
 
 const tracerMetrics = telemetryMetrics.manager.namespace('tracers')
 
@@ -90,6 +91,7 @@ class DatadogSpan {
 
       unfinishedRegistry.register(this, operationName, this)
     }
+    spanleak.addSpan(this, operationName)
   }
 
   toString () {

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

@@ -124,7 +124,8 @@ module.exports = class CiPlugin extends Plugin {
       osArchitecture,
       runtimeName,
       runtimeVersion,
-      branch
+      branch,
+      testLevel: 'suite'
     }
   }
 

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

@@ -17,6 +17,7 @@ module.exports = {
   get '@opensearch-project/opensearch' () { return require('../../../datadog-plugin-opensearch/src') },
   get '@redis/client' () { return require('../../../datadog-plugin-redis/src') },
   get '@smithy/smithy-client' () { return require('../../../datadog-plugin-aws-sdk/src') },
+  get 'aerospike' () { return require('../../../datadog-plugin-aerospike/src') },
   get 'amqp10' () { return require('../../../datadog-plugin-amqp10/src') },
   get 'amqplib' () { return require('../../../datadog-plugin-amqplib/src') },
   get 'aws-sdk' () { return require('../../../datadog-plugin-aws-sdk/src') },

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

@@ -111,7 +111,7 @@ function getLatestCommits () {
   }
 }
 
-function getCommitsToUpload (commitsToExclude, commitsToInclude) {
+function getCommitsRevList (commitsToExclude, commitsToInclude) {
   const commitsToExcludeString = commitsToExclude.map(commit => `^${commit}`)
 
   try {
@@ -236,7 +236,7 @@ module.exports = {
   getLatestCommits,
   getRepositoryUrl,
   generatePackFilesForCommits,
-  getCommitsToUpload,
+  getCommitsRevList,
   GIT_REV_LIST_MAX_BUFFER,
   isShallowRepository,
   unshallowRepository

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

@@ -397,8 +397,9 @@ function addIntelligentTestRunnerSpanTags (
     testModuleSpan.setTag(TEST_ITR_FORCED_RUN, 'true')
   }
 
-  // If suites have been skipped we don't want to report the total coverage, as it will be wrong
-  if (testCodeCoverageLinesTotal !== undefined && !isSuitesSkipped) {
+  // This will not be reported unless the user has manually added code coverage.
+  // This is always the case for Mocha and Cucumber, but not for Jest.
+  if (testCodeCoverageLinesTotal !== undefined) {
     testSessionSpan.setTag(TEST_CODE_COVERAGE_LINES_PCT, testCodeCoverageLinesTotal)
     testModuleSpan.setTag(TEST_CODE_COVERAGE_LINES_PCT, testCodeCoverageLinesTotal)
   }

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

@@ -8,7 +8,7 @@ process.once('beforeExit', () => { profiler.stop() })
 
 module.exports = {
   start: config => {
-    const { service, version, env, url, hostname, port, tags } = config
+    const { service, version, env, url, hostname, port, tags, repositoryUrl, commitSHA } = config
     const { enabled, sourceMap, exporters } = config.profiling
     const logger = {
       debug: (message) => log.debug(message),
@@ -17,7 +17,7 @@ module.exports = {
       error: (message) => log.error(message)
     }
 
-    profiler.start({
+    return profiler.start({
       enabled,
       service,
       version,
@@ -28,7 +28,9 @@ module.exports = {
       url,
       hostname,
       port,
-      tags
+      tags,
+      repositoryUrl,
+      commitSHA
     })
   },
 

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

@@ -11,6 +11,7 @@ const WallProfiler = require('./profilers/wall')
 const SpaceProfiler = require('./profilers/space')
 const EventsProfiler = require('./profilers/events')
 const { oomExportStrategies, snapshotKinds } = require('./constants')
+const { GIT_REPOSITORY_URL, GIT_COMMIT_SHA } = require('../plugins/util/tags')
 const { tagger } = require('./tagger')
 const { isFalse, isTrue } = require('../util')
 
@@ -72,6 +73,13 @@ class Config {
       tagger.parse(options.tags),
       tagger.parse({ env, host, service, version, functionname })
     )
+
+    // Add source code integration tags if available
+    if (options.repositoryUrl && options.commitSHA) {
+      this.tags[GIT_REPOSITORY_URL] = options.repositoryUrl
+      this.tags[GIT_COMMIT_SHA] = options.commitSHA
+    }
+
     this.logger = ensureLogger(options.logger)
     const logger = this.logger
     function logExperimentalVarDeprecation (shortVarName) {
@@ -131,10 +139,12 @@ class Config {
       : getProfilers({
         DD_PROFILING_HEAP_ENABLED,
         DD_PROFILING_WALLTIME_ENABLED,
-        DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED,
         DD_PROFILING_PROFILERS
       })
 
+    this.timelineEnabled = isTrue(coalesce(options.timelineEnabled,
+      DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED, false))
+
     this.codeHotspotsEnabled = isTrue(coalesce(options.codeHotspotsEnabled,
       DD_PROFILING_CODEHOTSPOTS_ENABLED,
       DD_PROFILING_EXPERIMENTAL_CODEHOTSPOTS_ENABLED, false))
@@ -147,8 +157,7 @@ class Config {
 module.exports = { Config }
 
 function getProfilers ({
-  DD_PROFILING_HEAP_ENABLED, DD_PROFILING_WALLTIME_ENABLED,
-  DD_PROFILING_PROFILERS, DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED
+  DD_PROFILING_HEAP_ENABLED, DD_PROFILING_WALLTIME_ENABLED, DD_PROFILING_PROFILERS
 }) {
   // First consider "legacy" DD_PROFILING_PROFILERS env variable, defaulting to wall + space
   // Use a Set to avoid duplicates
@@ -172,11 +181,6 @@ function getProfilers ({
     }
   }
 
-  // Events profiler is a profiler for timeline events that goes with the wall
-  // profiler
-  if (profilers.has('wall') && DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED) {
-    profilers.add('events')
-  }
   return [...profilers]
 }
 
@@ -238,8 +242,6 @@ function getProfiler (name, options) {
       return new WallProfiler(options)
     case 'space':
       return new SpaceProfiler(options)
-    case 'events':
-      return new EventsProfiler(options)
     default:
       options.logger.error(`Unknown profiler "${name}"`)
   }
@@ -257,6 +259,11 @@ function ensureProfilers (profilers, options) {
     }
   }
 
+  // Events profiler is a profiler for timeline events
+  if (options.timelineEnabled) {
+    profilers.push(new EventsProfiler(options))
+  }
+
   // Filter out any invalid profilers
   return profilers.filter(v => v)
 }

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

@@ -23,15 +23,19 @@ class Profiler extends EventEmitter {
   }
 
   start (options) {
-    this._start(options).catch((err) => { if (options.logger) options.logger.error(err) })
-    return this
+    return this._start(options).catch((err) => {
+      if (options.logger) {
+        options.logger.error(err)
+      }
+      return false
+    })
   }
 
   async _start (options) {
-    if (this._enabled) return
+    if (this._enabled) return true
 
     const config = this._config = new Config(options)
-    if (!config.enabled) return
+    if (!config.enabled) return false
 
     this._logger = config.logger
     this._enabled = true
@@ -67,9 +71,11 @@ class Profiler extends EventEmitter {
       }
 
       this._capture(this._timeoutInterval)
+      return true
     } catch (e) {
       this._logger.error(e)
       this._stop()
+      return false
     }
   }
 

package/packages/dd-trace/src/profiling/profilers/events.js

@@ -1,5 +1,5 @@
 const { performance, constants, PerformanceObserver } = require('node:perf_hooks')
-const { END_TIMESTAMP, THREAD_NAME, threadNamePrefix } = require('./shared')
+const { END_TIMESTAMP } = require('./shared')
 const semver = require('semver')
 const { Function, Label, Line, Location, Profile, Sample, StringTable, ValueType } = require('pprof-format')
 const pprof = require('@datadog/pprof/')
@@ -14,7 +14,137 @@ const MS_TO_NS = 1000000
 // perf_hooks events, the emitted pprof file uses the type "timeline".
 const pprofValueType = 'timeline'
 const pprofValueUnit = 'nanoseconds'
-const threadName = `${threadNamePrefix} GC`
+
+function labelFromStr (stringTable, key, valStr) {
+  return new Label({ key, str: stringTable.dedup(valStr) })
+}
+
+function labelFromStrStr (stringTable, keyStr, valStr) {
+  return labelFromStr(stringTable, stringTable.dedup(keyStr), valStr)
+}
+
+class GCDecorator {
+  constructor (stringTable) {
+    this.stringTable = stringTable
+    this.reasonLabelKey = stringTable.dedup('gc reason')
+    this.kindLabels = []
+    this.reasonLabels = []
+    this.flagObj = {}
+
+    const kindLabelKey = stringTable.dedup('gc type')
+
+    // Create labels for all GC performance flags and kinds of GC
+    for (const [key, value] of Object.entries(constants)) {
+      if (key.startsWith('NODE_PERFORMANCE_GC_FLAGS_')) {
+        this.flagObj[key.substring(26).toLowerCase()] = value
+      } else if (key.startsWith('NODE_PERFORMANCE_GC_')) {
+        // It's a constant for a kind of GC
+        const kind = key.substring(20).toLowerCase()
+        this.kindLabels[value] = labelFromStr(stringTable, kindLabelKey, kind)
+      }
+    }
+  }
+
+  decorateSample (sampleInput, item) {
+    const { kind, flags } = node16 ? item.detail : item
+    sampleInput.label.push(this.kindLabels[kind])
+    const reasonLabel = this.getReasonLabel(flags)
+    if (reasonLabel) {
+      sampleInput.label.push(reasonLabel)
+    }
+  }
+
+  getReasonLabel (flags) {
+    if (flags === 0) {
+      return null
+    }
+    let reasonLabel = this.reasonLabels[flags]
+    if (!reasonLabel) {
+      const reasons = []
+      for (const [key, value] of Object.entries(this.flagObj)) {
+        if (value & flags) {
+          reasons.push(key)
+        }
+      }
+      const reasonStr = reasons.join(',')
+      reasonLabel = labelFromStr(this.stringTable, this.reasonLabelKey, reasonStr)
+      this.reasonLabels[flags] = reasonLabel
+    }
+    return reasonLabel
+  }
+}
+
+class DNSDecorator {
+  constructor (stringTable) {
+    this.stringTable = stringTable
+    this.operationNameLabelKey = stringTable.dedup('operation')
+    this.hostLabelKey = stringTable.dedup('host')
+    this.addressLabelKey = stringTable.dedup('address')
+    this.portLabelKey = stringTable.dedup('port')
+  }
+
+  decorateSample (sampleInput, item) {
+    const labels = sampleInput.label
+    const stringTable = this.stringTable
+    function addLabel (labelNameKey, labelValue) {
+      labels.push(labelFromStr(stringTable, labelNameKey, labelValue))
+    }
+    const op = item.name
+    addLabel(this.operationNameLabelKey, item.name)
+    const detail = item.detail
+    switch (op) {
+      case 'lookup':
+        addLabel(this.hostLabelKey, detail.hostname)
+        break
+      case 'lookupService':
+        addLabel(this.addressLabelKey, detail.host)
+        labels.push(new Label({ key: this.portLabelKey, num: detail.port }))
+        break
+      case 'getHostByAddr':
+        addLabel(this.addressLabelKey, detail.host)
+        break
+      default:
+        if (op.startsWith('query')) {
+          addLabel(this.hostLabelKey, detail.host)
+        }
+    }
+  }
+}
+
+class NetDecorator {
+  constructor (stringTable) {
+    this.stringTable = stringTable
+    this.operationNameLabelKey = stringTable.dedup('operation')
+    this.hostLabelKey = stringTable.dedup('host')
+    this.portLabelKey = stringTable.dedup('port')
+  }
+
+  decorateSample (sampleInput, item) {
+    const labels = sampleInput.label
+    const stringTable = this.stringTable
+    function addLabel (labelNameKey, labelValue) {
+      labels.push(labelFromStr(stringTable, labelNameKey, labelValue))
+    }
+    const op = item.name
+    addLabel(this.operationNameLabelKey, op)
+    if (op === 'connect') {
+      const detail = item.detail
+      addLabel(this.hostLabelKey, detail.host)
+      labels.push(new Label({ key: this.portLabelKey, num: detail.port }))
+    }
+  }
+}
+
+// Keys correspond to PerformanceEntry.entryType, values are constructor
+// functions for type-specific decorators.
+const decoratorTypes = {
+  gc: GCDecorator
+}
+// Needs at least node 16 for DNS and Net
+if (node16) {
+  decoratorTypes.dns = DNSDecorator
+  decoratorTypes.net = NetDecorator
+}
 
 /**
  * This class generates pprof files with timeline events sourced from Node.js
@@ -35,8 +165,7 @@ class EventsProfiler {
     if (!this._observer) {
       this._observer = new PerformanceObserver(add.bind(this))
     }
-    // Currently only support GC
-    this._observer.observe({ type: 'gc' })
+    this._observer.observe({ entryTypes: Object.keys(decoratorTypes) })
   }
 
   stop () {
@@ -46,92 +175,61 @@ class EventsProfiler {
   }
 
   profile () {
+    if (this.entries.length === 0) {
+      // No events in the period; don't produce a profile
+      return null
+    }
+
     const stringTable = new StringTable()
-    const timestampLabelKey = stringTable.dedup(END_TIMESTAMP)
-    const kindLabelKey = stringTable.dedup('gc type')
-    const reasonLabelKey = stringTable.dedup('gc reason')
-    const kindLabels = []
-    const reasonLabels = []
     const locations = []
     const functions = []
-    const locationsPerKind = []
-    const flagObj = {}
-
-    function labelFromStr (key, valStr) {
-      return new Label({ key, str: stringTable.dedup(valStr) })
-    }
-
-    function labelFromStrStr (keyStr, valStr) {
-      return labelFromStr(stringTable.dedup(keyStr), valStr)
-    }
-
-    // Create labels for all GC performance flags and kinds of GC
-    for (const [key, value] of Object.entries(constants)) {
-      if (key.startsWith('NODE_PERFORMANCE_GC_FLAGS_')) {
-        flagObj[key.substring(26).toLowerCase()] = value
-      } else if (key.startsWith('NODE_PERFORMANCE_GC_')) {
-        // It's a constant for a kind of GC
-        const kind = key.substring(20).toLowerCase()
-        kindLabels[value] = labelFromStr(kindLabelKey, kind)
-        // Construct a single-frame "location" too
-        const fn = new Function({ id: functions.length + 1, name: stringTable.dedup(`${kind} GC`) })
-        functions.push(fn)
-        const line = new Line({ functionId: fn.id })
-        const location = new Location({ id: locations.length + 1, line: [line] })
-        locations.push(location)
-        locationsPerKind[value] = [location.id]
-      }
-    }
 
-    const gcEventLabel = labelFromStrStr('event', 'gc')
-    const threadLabel = labelFromStrStr(THREAD_NAME, threadName)
+    // A synthetic single-frame location to serve as the location for timeline
+    // samples. We need these as the profiling backend (mimicking official pprof
+    // tool's behavior) ignores these.
+    const locationId = (() => {
+      const fn = new Function({ id: functions.length + 1, name: stringTable.dedup('') })
+      functions.push(fn)
+      const line = new Line({ functionId: fn.id })
+      const location = new Location({ id: locations.length + 1, line: [line] })
+      locations.push(location)
+      return [location.id]
+    })()
 
-    function getReasonLabel (flags) {
-      if (flags === 0) {
-        return null
-      }
-      let reasonLabel = reasonLabels[flags]
-      if (!reasonLabel) {
-        const reasons = []
-        for (const [key, value] of Object.entries(flagObj)) {
-          if (value & flags) {
-            reasons.push(key)
-          }
-        }
-        const reasonStr = reasons.join(',')
-        reasonLabel = labelFromStr(reasonLabelKey, reasonStr)
-        reasonLabels[flags] = reasonLabel
-      }
-      return reasonLabel
+    const decorators = {}
+    for (const [eventType, DecoratorCtor] of Object.entries(decoratorTypes)) {
+      const decorator = new DecoratorCtor(stringTable)
+      decorator.eventTypeLabel = labelFromStrStr(stringTable, 'event', eventType)
+      decorators[eventType] = decorator
     }
+    const timestampLabelKey = stringTable.dedup(END_TIMESTAMP)
 
     let durationFrom = Number.POSITIVE_INFINITY
     let durationTo = 0
     const dateOffset = BigInt(Math.round(performance.timeOrigin * MS_TO_NS))
 
     const samples = this.entries.map((item) => {
+      const decorator = decorators[item.entryType]
+      if (!decorator) {
+        // Shouldn't happen but it's better to not rely on observer only getting
+        // requested event types.
+        return null
+      }
       const { startTime, duration } = item
-      const { kind, flags } = node16 ? item.detail : item
       const endTime = startTime + duration
       if (durationFrom > startTime) durationFrom = startTime
       if (durationTo < endTime) durationTo = endTime
-      const labels = [
-        gcEventLabel,
-        threadLabel,
-        new Label({ key: timestampLabelKey, num: dateOffset + BigInt(Math.round(endTime * MS_TO_NS)) }),
-        kindLabels[kind]
-      ]
-      const reasonLabel = getReasonLabel(flags)
-      if (reasonLabel) {
-        labels.push(reasonLabel)
-      }
-      const sample = new Sample({
+      const sampleInput = {
         value: [Math.round(duration * MS_TO_NS)],
-        label: labels,
-        locationId: locationsPerKind[kind]
-      })
-      return sample
-    })
+        locationId,
+        label: [
+          decorator.eventTypeLabel,
+          new Label({ key: timestampLabelKey, num: dateOffset + BigInt(Math.round(endTime * MS_TO_NS)) })
+        ]
+      }
+      decorator.decorateSample(sampleInput, item)
+      return new Sample(sampleInput)
+    }).filter(v => v)
 
     this.entries = []