dd-trace 6.12.0 → 6.14.0

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

@@ -13,6 +13,7 @@ const { storage } = require('../../../../datadog-core')
 const legacyStorage = storage('legacy')
 const urlFilter = require('./urlfilter')
 const { createInferredProxySpan, finishInferredProxySpan } = require('./inferred_proxy')
+const { getServerStatusValidator } = require('./status-validator')
 const { extractURL, obfuscateQs, getQsObfuscator, calculateHttpEndpoint } = require('./url')
 const { NETWORK_PEER_ADDRESS } = require('./http-otel-semantics')
 
@@ -34,12 +35,6 @@ const HTTP_CLIENT_IP = tags.HTTP_CLIENT_IP
 const MANUAL_DROP = tags.MANUAL_DROP
 
 const contexts = new WeakMap()
-const requests = new WeakMap()
-const statusCodeRangesPattern = /^[1-5]\d{2}(?:-[1-5]\d{2})?(?:,[1-5]\d{2}(?:-[1-5]\d{2})?)*$/
-const whitespacePattern = /\s/g
-const MAX_HTTP_STATUS_CODE = 599
-
-/** @typedef {(code: number) => boolean} StatusValidator */
 
 // TODO: change this to no longer rely on creating a dummy plugin to be able to access startSpan
 function createWebPlugin (tracer, config = {}) {
@@ -65,7 +60,7 @@ const web = {
   // Ensure the configuration has the correct structure and defaults.
   normalizeConfig (config) {
     const headers = getHeadersToRecord(config)
-    const validateStatus = getStatusValidator(config)
+    const validateStatus = getServerStatusValidator(config)
     const hooks = getHooks(config)
     const filter = urlFilter.getFilter(config)
     const middleware = getMiddlewareSetting(config)
@@ -133,7 +128,6 @@ const web = {
     context.tracer = tracer
     context.span = span
     context.res = res
-    requests.set(span, req)
 
     this.setConfig(req, config)
     addRequestTags(context, this.TYPE)
@@ -318,7 +312,6 @@ const web = {
     web.finishMiddleware(context)
 
     web.finishSpan(context, spanType)
-    requests.delete(context.span)
 
     finishInferredProxySpan(context)
   },
@@ -348,9 +341,6 @@ const web = {
   getContext (req) {
     return contexts.get(req)
   },
-  getRequest (span) {
-    return requests.get(span)
-  },
   setRouteOrEndpointTag (req) {
     const context = contexts.get(req)
 
@@ -515,9 +505,10 @@ function addResourceTag (context) {
 
   if (spanContext.getTag(RESOURCE_NAME)) return
 
-  const resource = [req.method, spanContext.getTag(HTTP_ROUTE)]
-    .filter(Boolean)
-    .join(' ')
+  let resource = req.method
+  const route = spanContext.getTag(HTTP_ROUTE)
+
+  if (route) resource += ` ${route}`
 
   span.setTag(RESOURCE_NAME, resource)
 }
@@ -563,65 +554,6 @@ function getHeadersToRecord (config) {
   return []
 }
 
-function isNot500ErrorCode (code) {
-  return code < 500
-}
-
-/**
- * @param {{ validateStatus?: unknown, DD_TRACE_HTTP_SERVER_ERROR_STATUSES?: unknown }} config
- * @returns {StatusValidator}
- */
-function getStatusValidator (config) {
-  if (typeof config.validateStatus === 'function') {
-    return /** @type {StatusValidator} */ (config.validateStatus)
-  } else if (config.hasOwnProperty('validateStatus')) {
-    log.error('Expected `validateStatus` to be a function.')
-  }
-
-  const { DD_TRACE_HTTP_SERVER_ERROR_STATUSES } = config
-  if (DD_TRACE_HTTP_SERVER_ERROR_STATUSES === undefined) return isNot500ErrorCode
-  if (typeof DD_TRACE_HTTP_SERVER_ERROR_STATUSES !== 'string') {
-    log.error('Expected `DD_TRACE_HTTP_SERVER_ERROR_STATUSES` to be a string.')
-    return isNot500ErrorCode
-  }
-  if (DD_TRACE_HTTP_SERVER_ERROR_STATUSES === '500-599') return isNot500ErrorCode
-
-  const normalized = DD_TRACE_HTTP_SERVER_ERROR_STATUSES.replaceAll(whitespacePattern, '')
-  if (normalized === '500-599') return isNot500ErrorCode
-  if (!statusCodeRangesPattern.test(normalized)) {
-    log.error(
-      '`DD_TRACE_HTTP_SERVER_ERROR_STATUSES` must contain comma-separated status codes or ranges from 100 to 599.'
-    )
-    return isNot500ErrorCode
-  }
-
-  const errorStatusCodes = new Uint8Array(MAX_HTTP_STATUS_CODE + 1)
-  const ranges = normalized.split(',')
-  for (const range of ranges) {
-    const separator = range.indexOf('-')
-    if (separator === -1) {
-      errorStatusCodes[Number(range)] = 1
-      continue
-    }
-
-    const first = Number(range.slice(0, separator))
-    const second = Number(range.slice(separator + 1))
-    const start = Math.min(first, second)
-    const end = Math.max(first, second)
-    errorStatusCodes.fill(1, start, end + 1)
-  }
-
-  /**
-   * @param {number} code
-   * @returns {boolean}
-   */
-  function isValidStatusCode (code) {
-    return errorStatusCodes[code] !== 1
-  }
-
-  return isValidStatusCode
-}
-
 const noop = () => {}
 
 function getHooks (config) {

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

@@ -222,4 +222,5 @@ function buildProfilingRuntime (config) {
 
 module.exports = {
   buildProfilingRuntime,
+  getProfilingTags,
 }

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

@@ -54,18 +54,24 @@ function strategiesToCallbackMode (strategies, callbackMode) {
  * @returns {string[]}
  */
 function buildExportCommand (exporters, tags) {
-  const tagString = [...Object.entries(tags),
-    ['snapshot', snapshotKinds.ON_OUT_OF_MEMORY]].map(([key, value]) => `${key}:${value}`).join(',')
-  const urls = []
+  let tagString = ''
+  for (const [key, value] of Object.entries(tags)) {
+    if (tagString) tagString += ','
+    tagString += `${key}:${value}`
+  }
+  if (tagString) tagString += ','
+  tagString += `snapshot:${snapshotKinds.ON_OUT_OF_MEMORY}`
+  let urls = ''
   for (const exporter of exporters) {
     const url = exporter.getExportUrl()
     if (url !== undefined) {
-      urls.push(url.toString())
+      if (urls) urls += ','
+      urls += url.toString()
     }
   }
   return [process.execPath,
     path.join(__dirname, 'exporter_cli.js'),
-    urls.join(','), tagString, 'space']
+    urls, tagString, 'space']
 }
 
 module.exports = { oomExportStrategies, ensureOOMExportStrategies, strategiesToCallbackMode, buildExportCommand }

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

@@ -4,7 +4,7 @@ const { EventEmitter } = require('events')
 const dc = require('dc-polyfill')
 const crashtracker = require('../crashtracking')
 const log = require('../log')
-const { buildProfilingRuntime } = require('./config')
+const { buildProfilingRuntime, getProfilingTags } = require('./config')
 const { snapshotKinds } = require('./constants')
 const { threadNamePrefix } = require('./profilers/shared')
 const { isWebServerSpan, endpointNameFromTags, getStartedSpans } = require('./webspan-utils')
@@ -54,6 +54,7 @@ class Profiler extends EventEmitter {
   #compressionFn
   #compressionFnInitialized = false
   #compressionOptions
+  #config
   #customLabelKeys = new Set()
   #enabled = false
   #endpointCounts = new Map()
@@ -64,7 +65,7 @@ class Profiler extends EventEmitter {
   #profilers
   #spanFinishListener
   #systemInfoReport
-  #tags
+  #currentSnapshotTags
   #timer
   #uploadCompression
 
@@ -95,6 +96,10 @@ class Profiler extends EventEmitter {
     for (const key of keys) {
       this.#customLabelKeys.add(key)
     }
+    this.#applyCustomLabelKeys()
+  }
+
+  #applyCustomLabelKeys () {
     if (this.#profilers) {
       for (const profiler of this.#profilers) {
         profiler.setCustomLabelKeys?.(this.#customLabelKeys)
@@ -152,7 +157,7 @@ class Profiler extends EventEmitter {
                 }
               }
             } else {
-              const zstdCompress = require('@datadog/libdatadog').load('datadog-js-zstd').zstd_compress
+              const { zstd_compress: zstdCompress } = require('@datadog/libdatadog')
               const level = clevel ?? 0 // 0 is zstd default compression level
               this.#compressionFn = (buffer) => Promise.resolve(Buffer.from(zstdCompress(buffer, level)))
             }
@@ -172,14 +177,18 @@ class Profiler extends EventEmitter {
     if (this.enabled) return true
     this.#enabled = true
 
-    const { tags, exporters, flushInterval, profilers, uploadCompression, systemInfoReport } =
+    const { tags: snapshotTags, exporters, flushInterval, profilers, uploadCompression, systemInfoReport } =
       buildProfilingRuntime(config)
-    this.#tags = tags
+    this.#config = config
     this.#exporters = exporters
     this.#flushInterval = flushInterval
     this.#profilers = profilers
+    this.#currentSnapshotTags = snapshotTags
     this.#uploadCompression = uploadCompression
     this.#systemInfoReport = systemInfoReport
+    if (this.#customLabelKeys.size > 0) {
+      this.#applyCustomLabelKeys()
+    }
 
     this._setInterval()
     // Log errors if the source map finder fails, but don't prevent the rest
@@ -241,7 +250,7 @@ class Profiler extends EventEmitter {
     processInfo(infos, info, profileType)
     this.#submit({
       [profileType]: encodedProfile,
-    }, infos, start, end, snapshotKinds.ON_OUT_OF_MEMORY)
+    }, infos, start, end, this.#currentSnapshotTags, snapshotKinds.ON_OUT_OF_MEMORY)
   }
 
   _setInterval () {
@@ -325,6 +334,7 @@ class Profiler extends EventEmitter {
 
       const startDate = this.#lastStart
       const endDate = new Date()
+      const snapshotTags = this.#currentSnapshotTags
       const profiles = []
 
       crashtracker.withProfilerSerializing(() => {
@@ -341,6 +351,7 @@ class Profiler extends EventEmitter {
       })
 
       if (restart) {
+        this.#currentSnapshotTags = getProfilingTags(this.#config)
         this._capture(this._timeoutInterval, endDate)
       }
 
@@ -378,7 +389,7 @@ class Profiler extends EventEmitter {
       }))
 
       if (hasEncoded) {
-        await this.#submit(encodedProfiles, infos, startDate, endDate, snapshotKind)
+        await this.#submit(encodedProfiles, infos, startDate, endDate, snapshotTags, snapshotKind)
         profileSubmittedChannel.publish()
         log.debug('Submitted profiles')
       }
@@ -388,9 +399,15 @@ class Profiler extends EventEmitter {
     }
   }
 
-  #submit (profiles, infos, start, end, snapshotKind) {
-    const tags = this.#tags
-
+  /**
+   * @param {Record<string, Buffer|string>} profiles
+   * @param {Record<string, unknown>} infos
+   * @param {Date} start
+   * @param {Date} end
+   * @param {Record<string, string|number|boolean|undefined>} snapshotTags
+   * @param {string} snapshotKind
+   */
+  #submit (profiles, infos, start, end, snapshotTags, snapshotKind) {
     // Flatten endpoint counts
     const endpointCounts = {}
     for (const [endpoint, { count }] of this.#endpointCounts) {
@@ -398,12 +415,12 @@ class Profiler extends EventEmitter {
     }
     this.#endpointCounts.clear()
 
-    tags.snapshot = snapshotKind
-    tags.profile_seq = this.#profileSeq++
+    snapshotTags.snapshot = snapshotKind
+    snapshotTags.profile_seq = this.#profileSeq++
     const customAttributes = this.#customLabelKeys.size > 0
       ? [...this.#customLabelKeys]
       : undefined
-    const exportSpec = { profiles, infos, start, end, tags, endpointCounts, customAttributes }
+    const exportSpec = { profiles, infos, start, end, tags: snapshotTags, endpointCounts, customAttributes }
     const tasks = this.#exporters.map(exporter =>
       exporter.export(exportSpec).catch(error => {
         log.warn(error)

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

@@ -124,13 +124,13 @@ class GCDecorator {
     }
     let reasonLabel = this.reasonLabels[flags]
     if (!reasonLabel) {
-      const reasons = []
+      let reasonStr = ''
       for (const [key, value] of Object.entries(this.flagObj)) {
         if (value & flags) {
-          reasons.push(key)
+          if (reasonStr) reasonStr += ','
+          reasonStr += key
         }
       }
-      const reasonStr = reasons.join(',')
       reasonLabel = labelFromStr(this.stringTable, this.reasonLabelKey, reasonStr)
       this.reasonLabels[flags] = reasonLabel
     }

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

@@ -1,5 +1,8 @@
 'use strict'
 
+const { channel } = require('dc-polyfill')
+
+const log = require('../../log')
 const { oomExportStrategies, ensureOOMExportStrategies, strategiesToCallbackMode, buildExportCommand } =
   require('../oom')
 const { encodeProfileAsync, getThreadLabels } = require('./shared')
@@ -11,10 +14,12 @@ const { encodeProfileAsync, getThreadLabels } = require('./shared')
  */
 
 const STACK_DEPTH = 64
+const identityRefreshChannel = channel('datadog:identity:refresh')
 
 class NativeSpaceProfiler {
   #config
   #exporters
+  #identityRefreshListener
   #mapper
   #pprof
   #samplingInterval
@@ -39,20 +44,36 @@ class NativeSpaceProfiler {
   start ({ mapper, nearOOMCallback } = {}) {
     if (this.#started) return
 
-    const config = this.#config
     this.#mapper = mapper
     this.#pprof = require('@datadog/pprof')
-    this.#pprof.heap.start(this.#samplingInterval, STACK_DEPTH, config.DD_PROFILING_ALLOCATION_ENABLED)
-    if (config.DD_PROFILING_EXPERIMENTAL_OOM_MONITORING_ENABLED) {
+    this.#pprof.heap.start(this.#samplingInterval, STACK_DEPTH, this.#config.DD_PROFILING_ALLOCATION_ENABLED)
+
+    if (this.#config.DD_PROFILING_EXPERIMENTAL_OOM_MONITORING_ENABLED) {
+      const config = this.#config
       const strategies = ensureOOMExportStrategies(config.DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES)
-      this.#pprof.heap.monitorOutOfMemory(
-        config.DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE,
-        config.DD_PROFILING_EXPERIMENTAL_OOM_MAX_HEAP_EXTENSION_COUNT,
-        strategies.includes(oomExportStrategies.LOGS),
-        strategies.includes(oomExportStrategies.PROCESS) ? buildExportCommand(this.#exporters, this.#tags) : [],
-        (profile) => nearOOMCallback(this.type, this.#pprof.encodeSync(profile), this.getInfo()),
-        strategiesToCallbackMode(strategies, this.#pprof.heap.CallbackMode)
-      )
+      const monitorOutOfMemory = () => {
+        this.#pprof.heap.monitorOutOfMemory(
+          config.DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE,
+          config.DD_PROFILING_EXPERIMENTAL_OOM_MAX_HEAP_EXTENSION_COUNT,
+          strategies.includes(oomExportStrategies.LOGS),
+          strategies.includes(oomExportStrategies.PROCESS) ? buildExportCommand(this.#exporters, this.#tags) : [],
+          (profile) => nearOOMCallback(this.type, this.#pprof.encodeSync(profile), this.getInfo()),
+          strategiesToCallbackMode(strategies, this.#pprof.heap.CallbackMode)
+        )
+      }
+      monitorOutOfMemory()
+
+      if (strategies.includes(oomExportStrategies.PROCESS)) {
+        this.#identityRefreshListener = () => {
+          try {
+            Object.assign(this.#tags, config.tags)
+            monitorOutOfMemory()
+          } catch (error) {
+            log.error(error)
+          }
+        }
+        identityRefreshChannel.subscribe(this.#identityRefreshListener)
+      }
     }
 
     this.#started = true
@@ -74,6 +95,12 @@ class NativeSpaceProfiler {
 
   stop () {
     if (!this.#started) return
+
+    if (this.#identityRefreshListener !== undefined) {
+      identityRefreshChannel.unsubscribe(this.#identityRefreshListener)
+      this.#identityRefreshListener = undefined
+    }
+
     this.#pprof.heap.stop()
     this.#started = false
   }

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

@@ -138,7 +138,7 @@ class NativeWallProfiler {
 
     this.#pprof.time.start({
       collectCpuTime: this.#cpuProfilingEnabled,
-      columnNumbers: 'pack',
+      columnNumbers: 'emit',
       durationMillis: this.#flushIntervalMillis,
       intervalMicros: this.#samplingIntervalMicros,
       lineNumbers: false,
@@ -168,8 +168,8 @@ class NativeWallProfiler {
         spanFinishCh.subscribe(this.#boundSpanFinished)
         if (this.#endpointCollectionEnabled) {
           // Web-tags cache publishes once per span at the moment its
-          // walk-result transitions from undefined to a real value —
-          // exactly when we need to refresh the ProfilingContext snapshot.
+          // walk-result changes — exactly when we need to refresh the
+          // ProfilingContext snapshot.
           webTagsCache.resolvedCh.subscribe(this.#boundSpanTagsUpdated)
           // Turn on the cache's own tagsUpdate subscription — it's
           // ref-counted, so this composes with any other active consumer.
@@ -229,13 +229,12 @@ class NativeWallProfiler {
         } else if (current !== sampleContext) {
           this.#pprof.time.setContext(sampleContext)
         }
-      // Every setContext() call in ACF mode allocates a fresh contextHolder
-      // (a node::ObjectWrap with its own v8::Global<v8::Value>) in the native
-      // profiler. Skip the call if the CPED already holds this sampleContext,
-      // which is the common case when the same span is repeatedly activated:
-      // #getProfilingContext caches profilingContext on span[ProfilingContext],
-      // so identity comparison short-circuits.
       } else if (current !== sampleContext) {
+        // Every setContext() call in ACF mode allocates a fresh contextHolder
+        // (a node::ObjectWrap with its own v8::Global<v8::Value>) in the native
+        // profiler. We're only incurring the cost when current !== sampleContext
+        // and skip it when current === sampleContext, which is the common case
+        // when the same span is repeatedly activated.
         this.#pprof.time.setContext(sampleContext)
       }
     } else {
@@ -266,8 +265,8 @@ class NativeWallProfiler {
       }
 
       // webTags is snapshotted into the sample context at getProfilingContext
-      // time; if the answer turns out to be undefined and the span later gets
-      // web-server tags, #spanTagsUpdated refreshes this field via the shared
+      // time; if the answer changes later — the span or an ancestor becomes a
+      // web-server span — #spanTagsUpdated refreshes this field via the shared
       // cache (see web-tags-cache.js).
       const webTags = this.#endpointCollectionEnabled ? webTagsCache.getCachedWebTags(span) : undefined
 
@@ -291,9 +290,10 @@ class NativeWallProfiler {
   }
 
   // Invoked (via webTagsCache.resolvedCh) once per span at the moment the
-  // shared cache promotes a previously-undefined webTags answer into a
-  // real value. Refresh the ProfilingContext snapshot so future samples
-  // pick it up.
+  // shared cache changes its webTags answer: an empty one promoted into a real
+  // value, or an outer request's tag bag replaced by a nearer one. Refresh the
+  // ProfilingContext snapshot in place so samples already holding it — including
+  // those of a span that stays active across the promotion — pick it up.
   #spanTagsUpdated (span) {
     if (!this.#started) return
     const profilingContext = span[ProfilingContext]

package/packages/dd-trace/src/profiling/webspan-utils.js

@@ -8,10 +8,13 @@ function isWebServerSpan (tags) {
 }
 
 function endpointNameFromTags (tags) {
-  return tags[RESOURCE_NAME] || [
-    tags[HTTP_METHOD],
-    tags[HTTP_ROUTE],
-  ].filter(Boolean).join(' ')
+  const resource = tags[RESOURCE_NAME]
+  if (resource) return resource
+
+  let endpoint = tags[HTTP_METHOD] || ''
+  const route = tags[HTTP_ROUTE]
+  if (route) endpoint += endpoint ? ` ${route}` : route
+  return endpoint
 }
 
 // The endpoint name a web-server span's tag bag yields changes over the span's