dd-trace 5.56.0 → 5.57.1

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

@@ -53,5 +53,6 @@ module.exports = {
   SPAN_POINTER_DIRECTION: Object.freeze({
     UPSTREAM: 'u',
     DOWNSTREAM: 'd'
-  })
+  }),
+  INSTRUMENTED_BY_SSI: Symbol('_dd.instrumented.by.ssi')
 }

package/packages/dd-trace/src/crashtracking/crashtracker.js

@@ -9,31 +9,29 @@ const { URL } = require('url')
 const pkg = require('../../../../package.json')
 
 class Crashtracker {
-  constructor () {
-    this._started = false
-  }
+  #started = false
 
   configure (config) {
-    if (!this._started) return
+    if (!this.#started) return
 
     try {
-      binding.updateConfig(this._getConfig(config))
-      binding.updateMetadata(this._getMetadata(config))
+      binding.updateConfig(this.#getConfig(config))
+      binding.updateMetadata(this.#getMetadata(config))
     } catch (e) {
       log.error('Error configuring crashtracker', e)
     }
   }
 
   start (config) {
-    if (this._started) return this.configure(config)
+    if (this.#started) return this.configure(config)
 
-    this._started = true
+    this.#started = true
 
     try {
       binding.init(
-        this._getConfig(config),
-        this._getReceiverConfig(config),
-        this._getMetadata(config)
+        this.#getConfig(config),
+        this.#getReceiverConfig(),
+        this.#getMetadata(config)
       )
     } catch (e) {
       log.error('Error initialising crashtracker', e)
@@ -50,7 +48,7 @@ class Crashtracker {
   }
 
   // TODO: Send only configured values when defaults are fixed.
-  _getConfig (config) {
+  #getConfig (config) {
     const { hostname = '127.0.0.1', port = 8126 } = config
     const url = config.url || new URL(`http://${hostname}:${port}`)
 
@@ -75,7 +73,7 @@ class Crashtracker {
     }
   }
 
-  _getMetadata (config) {
+  #getMetadata (config) {
     const tags = Object.keys(config.tags).map(key => `${key}:${config.tags[key]}`)
 
     return {
@@ -94,7 +92,7 @@ class Crashtracker {
     }
   }
 
-  _getReceiverConfig () {
+  #getReceiverConfig () {
     return {
       args: [],
       env: [],

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

@@ -7,7 +7,7 @@ function getDataStreamsContext () {
 }
 
 function setDataStreamsContext (dataStreamsContext) {
-  log.debug(() => `Setting new DSM Context: ${JSON.stringify(dataStreamsContext)}.`)
+  log.debug('Setting new DSM Context: %j.', dataStreamsContext)
 
   if (dataStreamsContext) storage('legacy').enterWith({ ...(storage('legacy').getStore()), dataStreamsContext })
 }

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

@@ -204,7 +204,7 @@ class DataStreamsProcessor {
     let closestOppositeDirectionHash = ENTRY_PARENT_HASH
     let closestOppositeDirectionEdgeStart = nowNs
     if (ctx == null) {
-      log.debug(() => 'Setting DSM Checkpoint with empty parent context.')
+      log.debug('Setting DSM Checkpoint with empty parent context.')
     } else {
       pathwayStartNs = ctx.pathwayStartNs
       edgeStartNs = ctx.edgeStartNs

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

@@ -20,7 +20,7 @@ function makeRequest (data, url, cb) {
     url
   }
 
-  log.debug(() => `Request to the intake: ${JSON.stringify(options)}`)
+  log.debug('Request to the intake: %j', options)
 
   request(data, options, (err, res) => {
     cb(err, res)
@@ -39,7 +39,7 @@ class DataStreamsWriter {
 
   flush (payload) {
     if (!request.writable) {
-      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${JSON.stringify(payload)}`)
+      log.debug('Maximum number of active requests reached. Payload discarded: %j', payload)
       return
     }
     const encodedPayload = msgpack.encode(payload)
@@ -50,7 +50,7 @@ class DataStreamsWriter {
         return
       }
       makeRequest(compressedData, this._url, (err, res) => {
-        log.debug(`Response from the agent: ${res}`)
+        log.debug('Response from the agent:', res)
         if (err) {
           log.error('Error sending datastream', err)
         }

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

@@ -87,7 +87,10 @@ async function addBreakpoint (probe) {
   try {
     probe.condition = probe.when?.json && compileCondition(probe.when.json)
   } catch (err) {
-    throw new Error(`Cannot compile expression: ${probe.when.dsl}`, { cause: err })
+    throw new Error(
+      `Cannot compile expression: ${probe.when.dsl} (probe: ${probe.id}, version: ${probe.version})`,
+      { cause: err }
+    )
   }
 
   const locationKey = generateLocationKey(scriptId, lineNumber, columnNumber)
@@ -115,7 +118,7 @@ async function addBreakpoint (probe) {
         condition: probe.condition
       })
     } catch (err) {
-      throw new Error(`Error setting breakpoint for probe ${probe.id}`, { cause: err })
+      throw new Error(`Error setting breakpoint for probe ${probe.id} (version: ${probe.version})`, { cause: err })
     }
     probeToLocation.set(probe.id, locationKey)
     locationToBreakpoint.set(locationKey, { id: result.breakpointId, location, locationKey })
@@ -192,7 +195,7 @@ async function updateBreakpointInternal (breakpoint, probe) {
         condition
       })
     } catch (err) {
-      throw new Error(`Error setting breakpoint for probe ${probe.id}`, { cause: err })
+      throw new Error(`Error setting breakpoint for probe ${probe.id} (version: ${probe.version})`, { cause: err })
     }
     breakpointToProbes.set(result.breakpointId, probesAtLocation)
   }

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

@@ -278,7 +278,7 @@ function guardAgainstCoercionSideEffects (variable) {
 
 function assertString (variable) {
   return `((val) => {
-    if (typeof val === 'string' || val instanceof String) {
+    if (${isString('val')}) {
       return val
     } else {
       throw new TypeError('Variable is not a string')

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

@@ -160,10 +160,9 @@ session.on('Debugger.paused', async ({ params }) => {
   await session.post('Debugger.resume')
   const diff = process.hrtime.bigint() - start // TODO: Recored as telemetry (DEBUG-2858)
 
-  log.debug(
-    '[debugger:devtools_client] Finished processing breakpoints - main thread paused for: %d ms',
+  log.debug(() => `[debugger:devtools_client] Finished processing breakpoints - main thread paused for: ${
     Number(diff) / 1_000_000
-  )
+  } ms`)
 
   const logger = {
     // We can safely use `location.file` from the first probe in the array, since all probes hit by `hitBreakpoints`

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

@@ -165,9 +165,12 @@ session.on('Debugger.scriptParsed', ({ params }) => {
       loadedScripts.push(params)
     }
 
-    clearTimeout(reEvaluateProbesTimer)
-    reEvaluateProbesTimer = setTimeout(() => {
-      session.emit('scriptLoadingStabilized')
-    }, 500)
+    if (reEvaluateProbesTimer === null) {
+      reEvaluateProbesTimer = setTimeout(() => {
+        session.emit('scriptLoadingStabilized')
+      }, 500).unref()
+    } else {
+      reEvaluateProbesTimer.refresh()
+    }
   }
 })

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

@@ -63,7 +63,7 @@ class DogStatsDClient {
   flush () {
     const queue = this._enqueue()
 
-    log.debug(`Flushing ${queue.length} metrics via ${this._httpOptions ? 'HTTP' : 'UDP'}`)
+    log.debug('Flushing %s metrics via', queue.length, this._httpOptions ? 'HTTP' : 'UDP')
 
     if (this._queue.length === 0) return
 
@@ -108,7 +108,7 @@ class DogStatsDClient {
     const socket = family === 6 ? this._udp6 : this._udp4
 
     queue.forEach((buffer) => {
-      log.debug(`Sending to DogStatsD: ${buffer}`)
+      log.debug('Sending to DogStatsD: %s', buffer)
       socket.send(buffer, 0, buffer.length, this._port, address)
     })
   }
@@ -165,7 +165,7 @@ class DogStatsDClient {
         .filter(key => {
           // Skip runtime-id unless enabled as cardinality may be too high
           if (key !== 'runtime-id') return true
-          return (config.experimental && config.experimental.runtimeId)
+          return config.runtimeMetricsRuntimeId
         })
         .forEach(key => {
           // https://docs.datadoghq.com/tagging/#defining-tags

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

@@ -5,6 +5,8 @@ const log = require('../../log')
 const Writer = require('./writer')
 
 class AgentExporter {
+  #timer
+
   constructor (config, prioritySampler) {
     this._config = config
     const { url, hostname, port, lookup, protocolVersion, stats = {}, apmTracingEnabled } = config
@@ -28,8 +30,9 @@ class AgentExporter {
       config
     })
 
-    this._timer = undefined
-    process.once('beforeExit', () => this._writer.flush())
+    process.once('beforeExit', () => {
+      this.flush()
+    })
   }
 
   setUrl (url) {
@@ -49,15 +52,17 @@ class AgentExporter {
 
     if (flushInterval === 0) {
       this._writer.flush()
-    } else if (flushInterval > 0 && !this._timer) {
-      this._timer = setTimeout(() => {
+    } else if (this.#timer === undefined) {
+      this.#timer = setTimeout(() => {
         this._writer.flush()
-        this._timer = clearTimeout(this._timer)
+        this.#timer = undefined
       }, flushInterval).unref()
     }
   }
 
   flush (done = () => {}) {
+    clearTimeout(this.#timer)
+    this.#timer = undefined
     this._writer.flush(done)
   }
 }

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

@@ -92,7 +92,7 @@ function makeRequest (version, data, count, url, headers, lookup, needsStartupLo
   setHeader(options.headers, 'Datadog-Meta-Lang-Version', process.version)
   setHeader(options.headers, 'Datadog-Meta-Lang-Interpreter', process.jsEngine || 'v8')
 
-  log.debug(() => `Request to the agent: ${JSON.stringify(options)}`)
+  log.debug('Request to the agent: %j', options)
 
   request(data, options, (err, res, status) => {
     if (needsStartupLog) {

package/packages/dd-trace/src/exporters/common/agent-info-exporter.js

@@ -59,10 +59,10 @@ class AgentInfoExporter {
 
     if (flushInterval === 0) {
       writer.flush()
-    } else if (flushInterval > 0 && !this[timerKey]) {
+    } else if (this[timerKey] === undefined) {
       this[timerKey] = setTimeout(() => {
         writer.flush()
-        this[timerKey] = clearTimeout(this[timerKey])
+        this[timerKey] = undefined
       }, flushInterval).unref()
     }
   }

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

@@ -9,7 +9,7 @@ const MAX_SIZE = 64 * 1024 // 64kb
 
 class LogExporter {
   export (spans) {
-    log.debug(() => `Adding trace to queue: ${JSON.stringify(spans)}`)
+    log.debug('Adding trace to queue: %j', spans)
 
     let size = TRACE_FORMAT_OVERHEAD
     let queue = []

package/packages/dd-trace/src/exporters/span-stats/writer.js

@@ -20,7 +20,7 @@ class Writer extends BaseWriter {
         done()
         return
       }
-      log.debug(`Response from the intake: ${res}`)
+      log.debug('Response from the intake:', res)
       done()
     })
   }
@@ -41,7 +41,7 @@ function makeRequest (data, url, cb) {
   options.hostname = url.hostname
   options.port = url.port
 
-  log.debug(() => `Request to the intake: ${JSON.stringify(options)}`)
+  log.debug('Request to the intake: %j', options)
 
   request(data, options, (err, res) => {
     cb(err, res)

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

@@ -47,13 +47,15 @@ function guard (fn) {
       { name: 'abort.runtime', tags: [] }
     ])
     log.info('Aborting application instrumentation due to incompatible_runtime.')
-    log.info('Found incompatible runtime nodejs ' + version + ', Supported runtimes: nodejs ' + engines.node + '.')
+    log.info('Found incompatible runtime nodejs %s, Supported runtimes: nodejs %s.', version, engines.node)
     if (forced) {
       log.info('DD_INJECT_FORCE enabled, allowing unsupported runtimes and continuing.')
     }
   }
 
   if (!clobberBailout && (!initBailout || forced)) {
+    // Ensure the instrumentation source is set for the current process and potential 
+    // child processes.
     var result = fn()
     telemetry('complete', ['injection_forced:' + (forced && initBailout ? 'true' : 'false')])
     log.info('Application instrumentation bootstrapping complete')

package/packages/dd-trace/src/guardrails/telemetry.js

@@ -65,7 +65,7 @@ function sendTelemetry (name, tags) {
   })
   proc.on('exit', function (code) {
     if (code !== 0) {
-      log.error('Telemetry forwarder exited with code ' + code)
+      log.error('Telemetry forwarder exited with code', code)
     }
   })
   proc.stdin.on('error', function () {

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

@@ -22,6 +22,8 @@ const LLMObsTagger = require('./tagger')
 const LLMObsSpanWriter = require('./writers/spans')
 const { setAgentStrategy } = require('./writers/util')
 
+const util = require('node:util')
+
 /**
  * Setting writers and processor globally when LLMObs is enabled
  * We're setting these in this module instead of on the SDK.
@@ -75,6 +77,7 @@ function enable (config) {
     spanWriter?.setAgentless(useAgentless)
 
     telemetry.recordLLMObsEnabled(startTime, config)
+    log.debug(`[LLMObs] Enabled LLM Observability with configuration: ${util.inspect(config.llmobs)}`)
   })
 }
 
@@ -90,6 +93,8 @@ function disable () {
 
   spanWriter = null
   evalWriter = null
+
+  log.debug('[LLMObs] Disabled LLM Observability')
 }
 
 // since LLMObs traces can extend between services and be the same trace,
@@ -116,7 +121,7 @@ function handleFlush () {
     evalWriter.flush()
   } catch (e) {
     err = 'writer_flush_error'
-    log.warn(`Failed to flush LLMObs spans and evaluation metrics: ${e.message}`)
+    log.warn('Failed to flush LLMObs spans and evaluation metrics:', e.message)
   }
   telemetry.recordUserFlush(err)
 }
@@ -129,10 +134,11 @@ function handleEvalMetricAppend (payload) {
   try {
     evalWriter.append(payload)
   } catch (e) {
-    log.warn(`
-      Failed to append evaluation metric to LLM Observability writer, likely due to an unserializable property.
-      Evaluation metrics won't be sent to LLM Observability: ${e.message}
-    `)
+    log.warn(
+      // eslint-disable-next-line @stylistic/max-len
+      'Failed to append evaluation metric to LLM Observability writer, likely due to an unserializable property. Evaluation metrics won\'t be sent to LLM Observability:',
+      e.message
+    )
   }
 }
 

package/packages/dd-trace/src/llmobs/plugins/base.js

@@ -70,8 +70,8 @@ class LLMObsPlugin extends TracingPlugin {
     const span = apmStore?.span
     if (!span) {
       log.debug(
-        `Tried to start an LLMObs span for ${this.constructor.name} without an active APM span.
-        Not starting LLMObs span.`
+        'Tried to start an LLMObs span for %s without an active APM span. Not starting LLMObs span.',
+        this.constructor.name
       )
       return
     }

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

@@ -63,7 +63,7 @@ class BaseLangChainLLMObsPlugin extends LLMObsPlugin {
     const type = ctx.type = this.constructor.lcType // langchain operation type (oneof chain,chat_model,llm,embedding)
 
     if (!Object.keys(this._handlers).includes(type)) {
-      log.warn(`Unsupported LangChain operation type: ${type}`)
+      log.warn('Unsupported LangChain operation type:', type)
       return
     }
 

package/packages/dd-trace/src/llmobs/tagger.js

@@ -61,19 +61,6 @@ class LLMObsTagger {
     if (!this._config.llmobs.enabled) return
     if (!kind) return // do not register it in the map if it doesn't have an llmobs span kind
 
-    this._register(span)
-
-    if (name) this._setTag(span, NAME, name)
-
-    this._setTag(span, SPAN_KIND, kind)
-    if (modelName) this._setTag(span, MODEL_NAME, modelName)
-    if (modelProvider) this._setTag(span, MODEL_PROVIDER, modelProvider)
-
-    sessionId = sessionId || registry.get(parent)?.[SESSION_ID]
-    if (sessionId) this._setTag(span, SESSION_ID, sessionId)
-    if (integration) this._setTag(span, INTEGRATION, integration)
-    if (_decorator) this._setTag(span, DECORATOR, _decorator)
-
     const spanMlApp =
       mlApp ||
       registry.get(parent)?.[ML_APP] ||
@@ -87,8 +74,21 @@ class LLMObsTagger {
       )
     }
 
+    this._register(span)
+
     this._setTag(span, ML_APP, spanMlApp)
 
+    if (name) this._setTag(span, NAME, name)
+
+    this._setTag(span, SPAN_KIND, kind)
+    if (modelName) this._setTag(span, MODEL_NAME, modelName)
+    if (modelProvider) this._setTag(span, MODEL_PROVIDER, modelProvider)
+
+    sessionId = sessionId || registry.get(parent)?.[SESSION_ID]
+    if (sessionId) this._setTag(span, SESSION_ID, sessionId)
+    if (integration) this._setTag(span, INTEGRATION, integration)
+    if (_decorator) this._setTag(span, DECORATOR, _decorator)
+
     const parentId =
       parent?.context().toSpanId() ??
       span.context()._trace.tags[PROPAGATED_PARENT_ID_KEY] ??

package/packages/dd-trace/src/llmobs/writers/base.js

@@ -60,7 +60,7 @@ class BaseLLMObsWriter {
       return
     }
 
-    this._bufferSize += byteLength || Buffer.from(JSON.stringify(event)).byteLength
+    this._bufferSize += byteLength || Buffer.byteLength(JSON.stringify(event))
     this._buffer.push(event)
   }
 
@@ -76,7 +76,7 @@ class BaseLLMObsWriter {
     this._bufferSize = 0
     const payload = this._encode(this.makePayload(events))
 
-    log.debug(`Encoded LLMObs payload: ${payload}`)
+    log.debug('Encoded LLMObs payload: %s', payload)
 
     const options = this._getOptions()
 

package/packages/dd-trace/src/llmobs/writers/spans.js

@@ -26,7 +26,7 @@ class LLMObsSpanWriter extends BaseWriter {
   }
 
   append (event) {
-    const eventSizeBytes = Buffer.from(JSON.stringify(event)).byteLength
+    const eventSizeBytes = Buffer.byteLength(JSON.stringify(event))
     telemetry.recordLLMObsRawSpanSize(event, eventSizeBytes)
 
     const shouldTruncate = eventSizeBytes > EVP_EVENT_SIZE_LIMIT
@@ -35,7 +35,7 @@ class LLMObsSpanWriter extends BaseWriter {
     if (shouldTruncate) {
       logger.warn(`Dropping event input/output because its size (${eventSizeBytes}) exceeds the 1MB event size limit`)
       event = this._truncateSpanEvent(event)
-      processedEventSizeBytes = Buffer.from(JSON.stringify(event)).byteLength
+      processedEventSizeBytes = Buffer.byteLength(JSON.stringify(event))
     }
 
     telemetry.recordLLMObsSpanSize(event, processedEventSizeBytes, shouldTruncate)

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

@@ -77,7 +77,7 @@ class Tracer {
           origin
         )
       } else {
-        log.debug(`no dd list member in tracestate from incoming request: ${ts}`)
+        log.debug('no dd list member in tracestate from incoming request:', ts)
       }
     }
 

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

@@ -141,7 +141,7 @@ class TextMapPropagator {
       for (const [key, value] of Object.entries(baggageItems)) {
         const item = `${this._encodeOtelBaggageKey(String(key).trim())}=${encodeURIComponent(String(value).trim())},`
         itemCounter += 1
-        byteCounter += item.length
+        byteCounter += Buffer.byteLength(item)
         if (itemCounter > this._config.baggageMaxItems || byteCounter > this._config.baggageMaxBytes) break
         baggage += item
       }
@@ -325,7 +325,7 @@ class TextMapPropagator {
           extractedContext = this._extractB3MultiContext(carrier)
           break
         default:
-          if (extractor !== 'baggage') log.warn(`Unknown propagation style: ${extractor}`)
+          if (extractor !== 'baggage') log.warn('Unknown propagation style:', extractor)
       }
 
       if (extractedContext === null) { // If the current extractor was invalid, continue to the next extractor
@@ -514,7 +514,7 @@ class TextMapPropagator {
               // If subkey is tid  then do nothing because trace header tid should always be preserved
               if (subKey === 'tid') {
                 if (!hex16.test(value) || spanContext._trace.tags['_dd.p.tid'] !== transformedValue) {
-                  log.error(`Invalid trace id ${value} in tracestate, skipping`)
+                  log.error('Invalid trace id %s in tracestate, skipping', value)
                 }
                 continue
               }
@@ -683,7 +683,7 @@ class TextMapPropagator {
         }
         // Check if value is a valid 16 character lower-case hexadecimal encoded number as per spec
         if (key === '_dd.p.tid' && !(hex16.test(value))) {
-          log.error(`Invalid _dd.p.tid tag ${value}, skipping`)
+          log.error('Invalid _dd.p.tid tag %s, skipping', value)
           continue
         }
         tags[key] = value

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

@@ -240,6 +240,7 @@ class DatadogSpan {
     }
 
     getIntegrationCounter('spans_finished', this._integrationName).inc()
+    this._spanContext._tags['_dd.integration'] = this._integrationName
 
     if (DD_TRACE_EXPERIMENTAL_SPAN_COUNTS && finishedRegistry) {
       runtimeMetrics.decrement('runtime.node.spans.unfinished')

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

@@ -1,7 +1,7 @@
 'use strict'
 
 const { channel } = require('dc-polyfill')
-const { isFalse } = require('./util')
+const { isFalse, normalizePluginEnvName } = require('./util')
 const plugins = require('./plugins')
 const log = require('./log')
 const { getEnvironmentVariable } = require('../../dd-trace/src/config-helper')
@@ -33,11 +33,11 @@ function maybeEnable (Plugin) {
   if (!Plugin || typeof Plugin !== 'function') return
   if (!pluginClasses[Plugin.id]) {
     const envName = `DD_TRACE_${Plugin.id.toUpperCase()}_ENABLED`
-    const enabled = getEnvironmentVariable(envName.replaceAll(/[^a-z0-9_]/ig, '_'))
+    const enabled = getEnvironmentVariable(normalizePluginEnvName(envName))
 
     // TODO: remove the need to load the plugin class in order to disable the plugin
     if (isFalse(enabled) || disabledPlugins.has(Plugin.id)) {
-      log.debug(`Plugin "${Plugin.id}" was disabled via configuration option.`)
+      log.debug('Plugin "%s" was disabled via configuration option.', Plugin.id)
 
       pluginClasses[Plugin.id] = null
     } else {

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

@@ -5,11 +5,11 @@ const StoragePlugin = require('./storage')
 class CachePlugin extends StoragePlugin {
   static get operation () { return 'command' }
 
-  startSpan (options) {
+  startSpan (options, ctx) {
     if (!options.kind) {
       options.kind = this.constructor.kind
     }
-    return super.startSpan(this.operationName(), options)
+    return super.startSpan(this.operationName(), options, ctx)
   }
 }