dd-trace 5.38.0 → 5.40.0

package/packages/dd-trace/src/datastreams/processor.js

@@ -5,7 +5,7 @@ const { LogCollapsingLowestDenseDDSketch } = require('@datadog/sketches-js')
 const { DsmPathwayCodec } = require('./pathway')
 const { DataStreamsWriter } = require('./writer')
 const { computePathwayHash } = require('./pathway')
-const { types } = require('util')
+const { getAmqpMessageSize, getHeadersSize, getMessageSize, getSizeOrZero } = require('./size')
 const { PATHWAY_HASH } = require('../../../../ext/tags')
 const { SchemaBuilder } = require('./schemas/schema_builder')
 const { SchemaSampler } = require('./schemas/schema_sampler')
@@ -115,49 +115,6 @@ class StatsBucket {
   }
 }
 
-function getSizeOrZero (obj) {
-  if (typeof obj === 'string') {
-    return Buffer.from(obj, 'utf-8').length
-  }
-  if (types.isArrayBuffer(obj)) {
-    return obj.byteLength
-  }
-  if (Buffer.isBuffer(obj)) {
-    return obj.length
-  }
-  if (Array.isArray(obj) && obj.length > 0) {
-    if (typeof obj[0] === 'number') return Buffer.from(obj).length
-    let payloadSize = 0
-    obj.forEach(item => {
-      payloadSize += getSizeOrZero(item)
-    })
-    return payloadSize
-  }
-  if (obj !== null && typeof obj === 'object') {
-    try {
-      return getHeadersSize(obj)
-    } catch {
-      // pass
-    }
-  }
-  return 0
-}
-
-function getHeadersSize (headers) {
-  if (headers === undefined) return 0
-  return Object.entries(headers).reduce((prev, [key, val]) => getSizeOrZero(key) + getSizeOrZero(val) + prev, 0)
-}
-
-function getMessageSize (message) {
-  const { key, value, headers } = message
-  return getSizeOrZero(key) + getSizeOrZero(value) + getHeadersSize(headers)
-}
-
-function getAmqpMessageSize (message) {
-  const { headers, content } = message
-  return getSizeOrZero(content) + getHeadersSize(headers)
-}
-
 class TimeBuckets extends Map {
   forTime (time) {
     if (!this.has(time)) {

package/packages/dd-trace/src/datastreams/size.js

@@ -0,0 +1,53 @@
+'use strict'
+
+const { types } = require('util')
+
+function getSizeOrZero (obj) {
+  if (typeof obj === 'string') {
+    return Buffer.from(obj, 'utf-8').length
+  }
+  if (types.isArrayBuffer(obj)) {
+    return obj.byteLength
+  }
+  if (Buffer.isBuffer(obj)) {
+    return obj.length
+  }
+  if (Array.isArray(obj) && obj.length > 0) {
+    if (typeof obj[0] === 'number') return Buffer.from(obj).length
+    let payloadSize = 0
+    obj.forEach(item => {
+      payloadSize += getSizeOrZero(item)
+    })
+    return payloadSize
+  }
+  if (obj !== null && typeof obj === 'object') {
+    try {
+      return getHeadersSize(obj)
+    } catch {
+      // pass
+    }
+  }
+  return 0
+}
+
+function getHeadersSize (headers) {
+  if (headers === undefined) return 0
+  return Object.entries(headers).reduce((prev, [key, val]) => getSizeOrZero(key) + getSizeOrZero(val) + prev, 0)
+}
+
+function getMessageSize (message) {
+  const { key, value, headers } = message
+  return getSizeOrZero(key) + getSizeOrZero(value) + getHeadersSize(headers)
+}
+
+function getAmqpMessageSize (message) {
+  const { headers, content } = message
+  return getSizeOrZero(content) + getHeadersSize(headers)
+}
+
+module.exports = {
+  getMessageSize,
+  getHeadersSize,
+  getSizeOrZero,
+  getAmqpMessageSize
+}

package/packages/dd-trace/src/debugger/devtools_client/breakpoints.js

@@ -76,12 +76,12 @@ async function removeBreakpoint ({ id }) {
   if (breakpoints.size === 0) return stop() // return instead of await to reduce number of promises created
 }
 
-async function start () {
+function start () {
   sessionStarted = true
   return session.post('Debugger.enable') // return instead of await to reduce number of promises created
 }
 
-async function stop () {
+function stop () {
   sessionStarted = false
   return session.post('Debugger.disable') // return instead of await to reduce number of promises created
 }

package/packages/dd-trace/src/debugger/devtools_client/snapshot/collector.js

@@ -63,7 +63,7 @@ async function traverseGetPropertiesResult (props, opts, depth) {
   return props
 }
 
-async function getObjectProperties (subtype, objectId, opts, depth) {
+function getObjectProperties (subtype, objectId, opts, depth) {
   if (ITERABLE_SUBTYPES.has(subtype)) {
     return getIterable(objectId, opts, depth)
   } else if (subtype === 'promise') {

package/packages/dd-trace/src/debugger/devtools_client/source-maps.js

@@ -4,10 +4,11 @@ const { join, dirname } = require('path')
 const { readFileSync } = require('fs')
 const { readFile } = require('fs/promises')
 const { SourceMapConsumer } = require('source-map')
+const { NODE_MAJOR } = require('../../../../../version')
 
 const cache = new Map()
 let cacheTimer = null
-let cacheTimerLastSet = 0
+let cacheTime = null
 
 const self = module.exports = {
   async loadSourceMap (dir, url) {
@@ -34,28 +35,34 @@ const self = module.exports = {
   }
 }
 
-// TODO: Remove if-statement around `setTimeout` below once it's safe to do so.
-//
-// This is a workaround for, what seems like a bug in Node.js core, that seems to trigger when, among other things, a
-// lot of timers are being created very rapidly. This makes the call to `setTimeout` throw an error from within
-// `AsyncLocalStorage._propagate` with the following error message:
+// The version check inside this function is to guard against a bug Node.js version 18, in which calls to `setTimeout`
+// might throw an uncatchable error from within `AsyncLocalStorage._propagate` with the following error message:
 //
 //     TypeError: Cannot read properties of undefined (reading 'Symbol(kResourceStore)')
 //
 // Source: https://github.com/nodejs/node/blob/v18.20.6/lib/async_hooks.js#L312
 function cacheIt (key, value) {
-  const now = Date.now()
-  if (now > cacheTimerLastSet + 1_000) {
-    clearTimeout(cacheTimer)
-    cacheTimer = setTimeout(function () {
+  if (NODE_MAJOR < 20) return value
+  cacheTime = Date.now()
+  setCacheTTL()
+  cache.set(key, value)
+  return value
+}
+
+function setCacheTTL () {
+  if (cacheTimer !== null) return
+
+  cacheTimer = setTimeout(function () {
+    cacheTimer = null
+    if (Date.now() - cacheTime < 2_500) {
+      // If the last cache entry was added recently, keep the cache alive
+      setCacheTTL()
+    } else {
       // Optimize for app boot, where a lot of reads might happen
       // Clear cache a few seconds after it was last used
       cache.clear()
-    }, 10_000).unref()
-    cacheTimerLastSet = now
-  }
-  cache.set(key, value)
-  return value
+    }
+  }, 5_000).unref()
 }
 
 function loadInlineSourceMap (data) {

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

@@ -14,6 +14,10 @@ const TYPE_GAUGE = 'g'
 const TYPE_DISTRIBUTION = 'd'
 const TYPE_HISTOGRAM = 'h'
 
+/**
+ * @import { DogStatsD } from "../../../index.d.ts"
+ * @implements {DogStatsD}
+ */
 class DogStatsDClient {
   constructor (options = {}) {
     if (options.metricsProxyUrl) {
@@ -39,6 +43,10 @@ class DogStatsDClient {
     this._add(stat, value, TYPE_COUNTER, tags)
   }
 
+  decrement (stat, value, tags) {
+    this._add(stat, -value, TYPE_COUNTER, tags)
+  }
+
   gauge (stat, value, tags) {
     this._add(stat, value, TYPE_GAUGE, tags)
   }
@@ -77,7 +85,7 @@ class DogStatsDClient {
           // we're not getting a 200 from the proxy endpoint. If it's a 404,
           // then we know we'll never have the endpoint, so just clear out the
           // options. Either way, we can give UDP a try.
-          this._httpOptions = null
+          this._httpOptions = undefined
         }
         this._sendUdp(queue)
       }
@@ -185,11 +193,22 @@ class DogStatsDClient {
   }
 }
 
-// This is a simplified user-facing proxy to the underlying DogStatsDClient instance
+/**
+ * This is a simplified user-facing proxy to the underlying DogStatsDClient instance
+ *
+ * @implements {DogStatsD}
+ */
 class CustomMetrics {
   constructor (config) {
     const clientConfig = DogStatsDClient.generateClientConfig(config)
     this.dogstatsd = new DogStatsDClient(clientConfig)
+
+    const flush = this.flush.bind(this)
+
+    // TODO(bengl) this magic number should be configurable
+    setInterval(flush, 10 * 1000).unref()
+
+    process.once('beforeExit', flush)
   }
 
   increment (stat, value = 1, tags) {
@@ -201,9 +220,9 @@ class CustomMetrics {
   }
 
   decrement (stat, value = 1, tags) {
-    return this.dogstatsd.increment(
+    return this.dogstatsd.decrement(
       stat,
-      value * -1,
+      value,
       CustomMetrics.tagTranslator(tags)
     )
   }

package/packages/dd-trace/src/exporters/agent/index.js

@@ -7,7 +7,7 @@ const Writer = require('./writer')
 class AgentExporter {
   constructor (config, prioritySampler) {
     this._config = config
-    const { url, hostname, port, lookup, protocolVersion, stats = {}, appsec } = config
+    const { url, hostname, port, lookup, protocolVersion, stats = {}, apmTracingEnabled } = config
     this._url = url || new URL(format({
       protocol: 'http:',
       hostname: hostname || 'localhost',
@@ -15,7 +15,7 @@ class AgentExporter {
     }))
 
     const headers = {}
-    if (stats.enabled || appsec?.standalone?.enabled) {
+    if (stats.enabled || apmTracingEnabled === false) {
       headers['Datadog-Client-Computed-Stats'] = 'yes'
     }
 

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

@@ -92,6 +92,9 @@ const flare = {
 function recordLog (msg) {
   if (tracerLogs.length > MAX_LOG_SIZE) return
 
+  if (msg && typeof msg === 'object') {
+    msg = JSON.stringify(msg)
+  }
   tracerLogs.write(`${msg}\n`) // TODO: gzip
 }
 

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

@@ -1,6 +1,12 @@
+/**
+ * @import { DogStatsD } from "../../../../index.d.ts"
+ * @implements {DogStatsD}
+ */
 module.exports = class NoopDogStatsDClient {
   increment () { }
 
+  decrement () { }
+
   gauge () { }
 
   distribution () { }

package/packages/dd-trace/src/opentelemetry/tracer.js

@@ -6,8 +6,10 @@ const { sanitizeAttributes } = require('@opentelemetry/core')
 const Sampler = require('./sampler')
 const Span = require('./span')
 const id = require('../id')
+const log = require('../log')
 const SpanContext = require('./span_context')
 const TextMapPropagator = require('../opentracing/propagation/text_map')
+const TraceState = require('../opentracing/propagation/tracestate')
 
 class Tracer {
   constructor (library, config, tracerProvider) {
@@ -39,7 +41,49 @@ class Tracer {
   // Extracted method to create span context for a new span
   _createSpanContextForNewSpan (context) {
     const { traceId, spanId, traceFlags, traceState } = context
-    return TextMapPropagator._convertOtelContextToDatadog(traceId, spanId, traceFlags, traceState)
+    return this._convertOtelContextToDatadog(traceId, spanId, traceFlags, traceState)
+  }
+
+  _convertOtelContextToDatadog (traceId, spanId, traceFlag, ts, meta = {}) {
+    const origin = null
+    let samplingPriority = traceFlag
+
+    ts = ts?.traceparent || null
+
+    if (ts) {
+      // Use TraceState.fromString to parse the tracestate header
+      const traceState = TraceState.fromString(ts)
+      let ddTraceStateData = null
+
+      // Extract Datadog specific trace state data
+      traceState.forVendor('dd', (state) => {
+        ddTraceStateData = state
+        return state // You might need to adjust this part based on actual logic needed
+      })
+
+      if (ddTraceStateData) {
+        // Assuming ddTraceStateData is now a Map or similar structure containing Datadog trace state data
+        // Extract values as needed, similar to the original logic
+        const samplingPriorityTs = ddTraceStateData.get('s')
+        const origin = ddTraceStateData.get('o')
+        // Convert Map to object for meta
+        const otherPropagatedTags = Object.fromEntries(ddTraceStateData.entries())
+
+        // Update meta and samplingPriority based on extracted values
+        Object.assign(meta, otherPropagatedTags)
+        samplingPriority = TextMapPropagator._getSamplingPriority(traceFlag, parseInt(samplingPriorityTs, 10), origin)
+      } else {
+        log.debug(`no dd list member in tracestate from incoming request: ${ts}`)
+      }
+    }
+
+    const spanContext = new SpanContext({
+      traceId: id(traceId, 16), spanId: id(), tags: meta, parentId: id(spanId, 16)
+    })
+
+    spanContext._sampling = { priority: samplingPriority }
+    spanContext._trace = { origin }
+    return spanContext
   }
 
   startSpan (name, options = {}, context = api.context.active()) {

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

@@ -3,7 +3,6 @@
 const pick = require('../../../../datadog-core/src/utils/src/pick')
 const id = require('../../id')
 const DatadogSpanContext = require('../span_context')
-const OtelSpanContext = require('../../opentelemetry/span_context')
 const log = require('../../log')
 const TraceState = require('./tracestate')
 const tags = require('../../../../../ext/tags')
@@ -33,11 +32,13 @@ const b3HeaderExpr = /^(([0-9a-f]{16}){1,2}-[0-9a-f]{16}(-[01d](-[0-9a-f]{16})?)
 const baggageExpr = new RegExp(`^${baggagePrefix}(.+)$`)
 const tagKeyExpr = /^_dd\.p\.[\x21-\x2b\x2d-\x7e]+$/ // ASCII minus spaces and commas
 const tagValueExpr = /^[\x20-\x2b\x2d-\x7e]*$/ // ASCII minus commas
-const ddKeys = [traceKey, spanKey, samplingKey, originKey]
-const b3Keys = [b3TraceKey, b3SpanKey, b3ParentKey, b3SampledKey, b3FlagsKey, b3HeaderKey]
-const logKeys = ddKeys.concat(b3Keys)
 const traceparentExpr = /^([a-f0-9]{2})-([a-f0-9]{32})-([a-f0-9]{16})-([a-f0-9]{2})(-.*)?$/i
 const traceparentKey = 'traceparent'
+const tracestateKey = 'tracestate'
+const ddKeys = [traceKey, spanKey, samplingKey, originKey]
+const b3Keys = [b3TraceKey, b3SpanKey, b3ParentKey, b3SampledKey, b3FlagsKey, b3HeaderKey]
+const w3cKeys = [traceparentKey, tracestateKey]
+const logKeys = ddKeys.concat(b3Keys, w3cKeys)
 // Origin value in tracestate replaces '~', ',' and ';' with '_"
 const tracestateOriginFilter = /[^\x20-\x2b\x2d-\x3a\x3c-\x7d]/g
 // Tag keys in tracestate replace ' ', ',' and '=' with '_'
@@ -78,7 +79,12 @@ class TextMapPropagator {
       extractCh.publish({ spanContext, carrier })
     }
 
-    log.debug(() => `Extract from carrier: ${JSON.stringify(pick(carrier, logKeys))}.`)
+    log.debug(() => {
+      const keys = JSON.stringify(pick(carrier, logKeys))
+      const styles = this._config.tracePropagationStyle.extract.join(', ')
+
+      return `Extract from carrier (${styles}): ${keys}.`
+    })
 
     return spanContext
   }
@@ -708,48 +714,6 @@ class TextMapPropagator {
     return spanContext._traceId.toString(16)
   }
 
-  static _convertOtelContextToDatadog (traceId, spanId, traceFlag, ts, meta = {}) {
-    const origin = null
-    let samplingPriority = traceFlag
-
-    ts = ts?.traceparent || null
-
-    if (ts) {
-      // Use TraceState.fromString to parse the tracestate header
-      const traceState = TraceState.fromString(ts)
-      let ddTraceStateData = null
-
-      // Extract Datadog specific trace state data
-      traceState.forVendor('dd', (state) => {
-        ddTraceStateData = state
-        return state // You might need to adjust this part based on actual logic needed
-      })
-
-      if (ddTraceStateData) {
-        // Assuming ddTraceStateData is now a Map or similar structure containing Datadog trace state data
-        // Extract values as needed, similar to the original logic
-        const samplingPriorityTs = ddTraceStateData.get('s')
-        const origin = ddTraceStateData.get('o')
-        // Convert Map to object for meta
-        const otherPropagatedTags = Object.fromEntries(ddTraceStateData.entries())
-
-        // Update meta and samplingPriority based on extracted values
-        Object.assign(meta, otherPropagatedTags)
-        samplingPriority = TextMapPropagator._getSamplingPriority(traceFlag, parseInt(samplingPriorityTs, 10), origin)
-      } else {
-        log.debug(`no dd list member in tracestate from incoming request: ${ts}`)
-      }
-    }
-
-    const spanContext = new OtelSpanContext({
-      traceId: id(traceId, 16), spanId: id(), tags: meta, parentId: id(spanId, 16)
-    })
-
-    spanContext._sampling = { priority: samplingPriority }
-    spanContext._trace = { origin }
-    return spanContext
-  }
-
   static _getSamplingPriority (traceparentSampled, tracestateSamplingPriority, origin = null) {
     const fromRumWithoutPriority = !tracestateSamplingPriority && origin === 'rum'
 

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

@@ -1,7 +1,7 @@
 const pick = require('../../../../datadog-core/src/utils/src/pick')
 const log = require('../../log')
 
-const { DsmPathwayCodec } = require('../../datastreams/pathway')
+const { DsmPathwayCodec } = require('../../datastreams')
 
 const base64Key = 'dd-pathway-ctx-base64'
 const logKeys = [base64Key]

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

@@ -13,7 +13,6 @@ const log = require('../log')
 const { storage } = require('../../../datadog-core')
 const telemetryMetrics = require('../telemetry/metrics')
 const { channel } = require('dc-polyfill')
-const spanleak = require('../spanleak')
 const util = require('util')
 
 const tracerMetrics = telemetryMetrics.manager.namespace('tracers')
@@ -99,7 +98,18 @@ class DatadogSpan {
 
       unfinishedRegistry.register(this, operationName, this)
     }
-    spanleak.addSpan(this, operationName)
+
+    // Nullish operator is used here because both `tracer` and `tracer._config`
+    // can be null and there are tests passing invalid values to the `Span`
+    // constructor which still succeed today. Part of the problem is that `Span`
+    // stores only the tracer and not the config, so anything that needs the
+    // config has to read it from the tracer stored on the span, including
+    // even `Span` itself in this case.
+    //
+    // TODO: Refactor Tracer/Span + tests to avoid having to do nullish checks.
+    if (tracer?._config?.spanLeakDebug > 0) {
+      require('../spanleak').addSpan(this, operationName)
+    }
 
     if (startCh.hasSubscribers) {
       startCh.publish({ span: this, fields })

package/packages/dd-trace/src/payload-tagging/config/aws.json

@@ -94,5 +94,13 @@
     ],
     "expand": [
     ]
+  },
+  "dynamodb": {
+    "request": [
+    ],
+    "response": [
+    ],
+    "expand": [
+    ]
   }
 }

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

@@ -28,9 +28,6 @@ loadChannel.subscribe(({ name }) => {
   maybeEnable(plugins[name])
 })
 
-// Globals
-maybeEnable(require('../../datadog-plugin-fetch/src'))
-
 // Always enabled
 maybeEnable(require('../../datadog-plugin-dd-trace-api/src'))
 
@@ -106,6 +103,10 @@ module.exports = class PluginManager {
     this._tracerConfig = config
     this._tracer._nomenclature.configure(config)
 
+    if (!config._isInServerlessEnvironment?.()) {
+      maybeEnable(require('../../datadog-plugin-fetch/src'))
+    }
+
     for (const name in pluginClasses) {
       this.loadPlugin(name)
     }

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

@@ -40,6 +40,7 @@ const {
 } = require('../ci-visibility/telemetry')
 const { CI_PROVIDER_NAME, GIT_REPOSITORY_URL, GIT_COMMIT_SHA, GIT_BRANCH, CI_WORKSPACE_PATH } = require('./util/tags')
 const { OS_VERSION, OS_PLATFORM, OS_ARCHITECTURE, RUNTIME_NAME, RUNTIME_VERSION } = require('./util/env')
+const getDiClient = require('../ci-visibility/dynamic-instrumentation')
 
 module.exports = class CiPlugin extends Plugin {
   constructor (...args) {
@@ -207,8 +208,7 @@ module.exports = class CiPlugin extends Plugin {
     }
 
     if (config.isTestDynamicInstrumentationEnabled && !this.di) {
-      const testVisibilityDynamicInstrumentation = require('../ci-visibility/dynamic-instrumentation')
-      this.di = testVisibilityDynamicInstrumentation
+      this.di = getDiClient()
     }
 
     this.testEnvironmentMetadata = getTestEnvironmentMetadata(this.constructor.id, this.config)

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

@@ -116,7 +116,7 @@ class PrioritySampler {
     }
   }
 
-  setPriority (span, samplingPriority, mechanism = SAMPLING_MECHANISM_MANUAL) {
+  setPriority (span, samplingPriority, product) {
     if (!span || !this.validate(samplingPriority)) return
 
     const context = this._getContext(span)
@@ -128,6 +128,8 @@ class PrioritySampler {
     }
 
     context._sampling.priority = samplingPriority
+
+    const mechanism = product?.mechanism ?? SAMPLING_MECHANISM_MANUAL
     context._sampling.mechanism = mechanism
 
     log.trace(span, samplingPriority, mechanism)
@@ -229,8 +231,8 @@ class PrioritySampler {
     }
   }
 
-  static keepTrace (span, mechanism) {
-    span?._prioritySampler?.setPriority(span, USER_KEEP, mechanism)
+  static keepTrace (span, product) {
+    span?._prioritySampler?.setPriority(span, USER_KEEP, product)
   }
 }
 

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

@@ -126,7 +126,7 @@ class Profiler extends EventEmitter {
     this._timeoutInterval = this._config.flushInterval
   }
 
-  async stop () {
+  stop () {
     if (!this._enabled) return
 
     // collect and export current profiles

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

@@ -286,14 +286,25 @@ class NativeWallProfiler {
 
     const labels = { ...getThreadLabels() }
 
-    const { context: { ref }, timestamp } = context
-    const { spanId, rootSpanId, webTags, endpoint } = ref ?? {}
-
     if (this._timelineEnabled) {
       // Incoming timestamps are in microseconds, we emit nanos.
-      labels[END_TIMESTAMP_LABEL] = timestamp * 1000n
+      labels[END_TIMESTAMP_LABEL] = context.timestamp * 1000n
+    }
+
+    const asyncId = context.asyncId
+    if (asyncId !== undefined && asyncId !== -1) {
+      labels['async id'] = asyncId
     }
 
+    // Native profiler doesn't set context.context for some samples, such as idle samples or when
+    // the context was otherwise unavailable when the sample was taken.
+    const ref = context.context?.ref
+    if (typeof ref !== 'object') {
+      return labels
+    }
+
+    const { spanId, rootSpanId, webTags, endpoint } = ref
+
     if (spanId !== undefined) {
       labels[SPAN_ID_LABEL] = spanId
     }