dd-trace 5.64.0 → 5.66.0

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

@@ -45,9 +45,13 @@ function guard (fn) {
     telemetry([
       { name: 'abort', tags: ['reason:incompatible_runtime'] },
       { name: 'abort.runtime', tags: [] }
-    ])
+    ], undefined, {
+      result: 'abort',
+      result_class: 'incompatible_runtime',
+      result_reason: 'Incompatible runtime Node.js ' + version + ', supported runtimes: Node.js ' + engines.node
+    })
     log.info('Aborting application instrumentation due to incompatible_runtime.')
-    log.info('Found incompatible runtime nodejs %s, Supported runtimes: nodejs %s.', version, engines.node)
+    log.info('Found incompatible runtime Node.js %s, Supported runtimes: Node.js %s.', version, engines.node)
     if (forced) {
       log.info('DD_INJECT_FORCE enabled, allowing unsupported runtimes and continuing.')
     }
@@ -56,7 +60,11 @@ function guard (fn) {
   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')])
+    telemetry('complete', ['injection_forced:' + (forced && initBailout ? 'true' : 'false')], {
+      result: 'success',
+      result_class: 'success',
+      result_reason: 'Successfully configured ddtrace package'
+    })
     log.info('Application instrumentation bootstrapping complete')
     return result
   }

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

@@ -47,7 +47,7 @@ function shouldSend (point) {
   return true
 }
 
-function sendTelemetry (name, tags) {
+function sendTelemetry (name, tags, resultMetadata) {
   var points = name
   if (typeof name === 'string') {
     points = [{ name: name, tags: tags || [] }]
@@ -62,32 +62,31 @@ function sendTelemetry (name, tags) {
   if (points.length === 0) {
     return
   }
+
+  // Update metadata with provided result metadata
+  var currentMetadata = {}
+  for (var key in metadata) {
+    currentMetadata[key] = metadata[key]
+  }
+  if (resultMetadata) {
+    for (var resultKey in resultMetadata) {
+      currentMetadata[resultKey] = resultMetadata[resultKey]
+    }
+  }
+
   var proc = spawn(process.env.DD_TELEMETRY_FORWARDER_PATH, ['library_entrypoint'], {
     stdio: 'pipe'
   })
   proc.on('error', function () {
     log.error('Failed to spawn telemetry forwarder')
-    metadata.result = 'error'
-    metadata.result_class = 'internal_error'
-    metadata.result_reason = 'Failed to spawn telemetry forwarder'
   })
   proc.on('exit', function (code) {
-    if (code === 0) {
-      metadata.result = 'success'
-      metadata.result_class = 'success'
-      metadata.result_reason = 'Successfully configured ddtrace package'
-    } else {
+    if (code !== 0) {
       log.error('Telemetry forwarder exited with code', code)
-      metadata.result = 'error'
-      metadata.result_class = 'internal_error'
-      metadata.result_reason = 'Telemetry forwarder exited with code ' + code
     }
   })
   proc.stdin.on('error', function () {
     log.error('Failed to write telemetry data to telemetry forwarder')
-    metadata.result = 'error'
-    metadata.result_class = 'internal_error'
-    metadata.result_reason = 'Failed to write telemetry data to telemetry forwarder'
   })
-  proc.stdin.end(JSON.stringify({ metadata: metadata, points: points }))
+  proc.stdin.end(JSON.stringify({ metadata: currentMetadata, points: points }))
 }

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

@@ -65,7 +65,8 @@ class LLMObsTagger {
       mlApp ||
       registry.get(parent)?.[ML_APP] ||
       span.context()._trace.tags[PROPAGATED_ML_APP_KEY] ||
-      this._config.llmobs.mlApp
+      this._config.llmobs.mlApp ||
+      this._config.service // this should always have a default
 
     if (!spanMlApp) {
       throw new Error(

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

@@ -71,7 +71,7 @@ function setStackTraceLimitFunction (fn) {
 function onError (err) {
   const { formatted, cause } = getErrorLog(err)
 
-  // calling twice logger.error() because Error cause is only available in nodejs v16.9.0
+  // calling twice logger.error() because Error cause is only available in Node.js v16.9.0
   // TODO: replace it with Error(message, { cause }) when cause has broad support
   if (formatted) {
     withNoop(() => {

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

@@ -145,7 +145,10 @@ module.exports = class PluginManager {
       ciVisAgentlessLogSubmissionEnabled,
       isTestDynamicInstrumentationEnabled,
       isServiceUserProvided,
-      middlewareTracingEnabled
+      middlewareTracingEnabled,
+      traceWebsocketMessagesEnabled,
+      traceWebsocketMessagesInheritSampling,
+      traceWebsocketMessagesSeparateTraces
     } = this._tracerConfig
 
     const sharedConfig = {
@@ -160,7 +163,10 @@ module.exports = class PluginManager {
       ciVisibilityTestSessionName,
       ciVisAgentlessLogSubmissionEnabled,
       isTestDynamicInstrumentationEnabled,
-      isServiceUserProvided
+      isServiceUserProvided,
+      traceWebsocketMessagesEnabled,
+      traceWebsocketMessagesInheritSampling,
+      traceWebsocketMessagesSeparateTraces
     }
 
     if (logInjection !== undefined) {

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

@@ -102,5 +102,6 @@ module.exports = {
   get sharedb () { return require('../../../datadog-plugin-sharedb/src') },
   get tedious () { return require('../../../datadog-plugin-tedious/src') },
   get undici () { return require('../../../datadog-plugin-undici/src') },
-  get winston () { return require('../../../datadog-plugin-winston/src') }
+  get winston () { return require('../../../datadog-plugin-winston/src') },
+  get ws () { return require('../../../datadog-plugin-ws/src') }
 }

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

@@ -1,6 +1,5 @@
 'use strict'
 
-const { BlockList } = require('net')
 const net = require('net')
 
 const FORWARED_HEADER_NAME = 'forwarded'
@@ -32,7 +31,7 @@ const privateCIDRs = [
   'fd00::/8'
 ]
 
-const privateIPMatcher = new BlockList()
+const privateIPMatcher = new net.BlockList()
 
 for (const cidr of privateCIDRs) {
   const [address, prefix] = cidr.split('/')
@@ -45,7 +44,11 @@ function extractIp (config, req) {
   if (config.clientIpHeader) {
     if (!headers) return
 
-    const ip = findFirstIp(headers[config.clientIpHeader])
+    const ipHeaderName = config.clientIpHeader
+    const header = headers[ipHeaderName]
+    if (typeof header !== 'string') return
+
+    const ip = findFirstIp(header, ipHeaderName === FORWARED_HEADER_NAME)
     return ip.public || ip.private
   }
 
@@ -53,12 +56,14 @@ function extractIp (config, req) {
   if (headers) {
     for (const ipHeaderName of ipHeaderList) {
       const header = headers[ipHeaderName]
-      const firstIp = ipHeaderName === FORWARED_HEADER_NAME ? findFirstIpForwardedFormat(header) : findFirstIp(header)
+      if (typeof header !== 'string') continue
+
+      const ip = findFirstIp(header, ipHeaderName === FORWARED_HEADER_NAME)
 
-      if (firstIp.public) {
-        return firstIp.public
-      } else if (!firstPrivateIp && firstIp.private) {
-        firstPrivateIp = firstIp.private
+      if (ip.public) {
+        return ip.public
+      } else if (!firstPrivateIp && ip.private) {
+        firstPrivateIp = ip.private
       }
     }
   }
@@ -66,25 +71,39 @@ function extractIp (config, req) {
   return firstPrivateIp || req.socket?.remoteAddress
 }
 
-function isPublicIp (ip, type) {
-  return !privateIPMatcher.check(ip, type === 6 ? 'ipv6' : 'ipv4')
-}
-
-function findFirstIp (str) {
+function findFirstIp (str, isForwardedHeader) {
   const result = {}
   if (!str) return result
 
   const splitted = str.split(',')
 
-  for (const part of splitted) {
-    const chunk = part.trim()
+  for (let chunk of splitted) {
+    if (isForwardedHeader) {
+      // find "for" directive
+      const forDirective = chunk.split(';').find(subchunk => subchunk.trim().toLowerCase().startsWith('for='))
+
+      // if found remove the "for=" prefix
+      // else keep going as is
+      if (forDirective) {
+        chunk = forDirective.slice(4)
+      }
+    }
+
+    chunk = chunk.trim()
+
+    // trim potential double quotes
+    if (chunk.startsWith('"') && chunk.endsWith('"')) {
+      chunk = chunk.slice(1, -1).trim()
+    }
 
-    // TODO: strip port and interface data ?
+    // TODO: when min node support is v24 we can instead use net.SocketAddress.parse()
+    chunk = cleanIp(chunk)
+    if (!chunk) continue
 
     const type = net.isIP(chunk)
     if (!type) continue
 
-    if (isPublicIp(chunk, type)) {
+    if (!privateIPMatcher.check(chunk, type === 6 ? 'ipv6' : 'ipv4')) {
       // it's public, return it immediately
       result.public = chunk
       return result
@@ -97,37 +116,21 @@ function findFirstIp (str) {
   return result
 }
 
-const forwardedForRegexp = /for="?\[?(([0-9]+\.)+[0-9]+|[0-9a-f:]*:[0-9a-f]*)/i
-const forwardedByRegexp = /by="?\[?(([0-9]+\.)+[0-9]+|[0-9a-f:]*:[0-9a-f]*)/i
-const forwardedRegexps = [forwardedForRegexp, forwardedByRegexp]
-
-function findFirstIpForwardedFormat (str) {
-  const result = {}
-  if (!str) return result
-
-  const splitted = str.split(',')
-
-  for (const part of splitted) {
-    const chunk = part.trim()
-
-    for (const regex of forwardedRegexps) {
-      const ip = regex.exec(chunk)?.[1]
-
-      const type = net.isIP(ip)
-      if (!type) continue
-
-      if (isPublicIp(ip, type)) {
-        // it's public, return it immediately
-        result.public = ip
-        return result
-      }
+function cleanIp (input) {
+  const colonIndex = input.indexOf(':')
+  if (colonIndex !== -1 && input.includes('.')) {
+    // treat it as ipv4 with port
+    return input.slice(0, colonIndex).trim()
+  }
 
-      // it's private, only save the first one found
-      if (!result.private) result.private = ip
-    }
+  const closingBracketIndex = input.indexOf(']')
+  if (closingBracketIndex !== -1 && input.startsWith('[')) {
+    // treat as ipv6 with brackets
+    return input.slice(1, closingBracketIndex).trim()
   }
 
-  return result
+  // no need to clean it
+  return input
 }
 
 module.exports = {

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

@@ -13,6 +13,7 @@ const {
   getThreadLabels,
   encodeProfileAsync
 } = require('./shared')
+const TRACE_ENDPOINT_LABEL = 'trace endpoint'
 
 const { isWebServerSpan, endpointNameFromTags, getStartedSpans } = require('../webspan-utils')
 
@@ -251,7 +252,12 @@ class NativeWallProfiler {
       this._enter()
       this._lastSampleCount = 0
     }
-    const profile = this._pprof.time.stop(restart, this._generateLabels)
+
+    // Mark thread labels and trace endpoint label as good deduplication candidates
+    const lowCardinalityLabels = Object.keys(getThreadLabels())
+    lowCardinalityLabels.push(TRACE_ENDPOINT_LABEL)
+
+    const profile = this._pprof.time.stop(restart, this._generateLabels, lowCardinalityLabels)
 
     if (restart) {
       const v8BugDetected = this._pprof.time.v8ProfilerStuckEventLoopDetected()
@@ -312,10 +318,10 @@ class NativeWallProfiler {
       labels[LOCAL_ROOT_SPAN_ID_LABEL] = rootSpanId
     }
     if (webTags !== undefined && Object.keys(webTags).length !== 0) {
-      labels['trace endpoint'] = endpointNameFromTags(webTags)
+      labels[TRACE_ENDPOINT_LABEL] = endpointNameFromTags(webTags)
     } else if (endpoint) {
       // fallback to endpoint computed when sample was taken
-      labels['trace endpoint'] = endpoint
+      labels[TRACE_ENDPOINT_LABEL] = endpoint
     }
 
     return labels