dd-trace 5.84.0 → 5.86.0

package/ci/cypress/polyfills.js

@@ -20,6 +20,6 @@ if (!Array.prototype.at) {
       return (index < 0 || index >= len) ? undefined : this[index]
     },
     writable: true,
-    configurable: true
+    configurable: true,
   })
 }

package/ci/init.js

@@ -14,7 +14,7 @@ const EXPORTER_MAP = {
   cucumber: 'cucumber_worker',
   mocha: 'mocha_worker',
   playwright: 'playwright_worker',
-  vitest: 'vitest_worker'
+  vitest: 'vitest_worker',
 }
 
 function isPackageManager () {
@@ -40,7 +40,7 @@ const isJestWorker = testWorkerType === 'jest'
 const baseOptions = {
   startupLogs: false,
   isCiVisibility: true,
-  flushInterval: isJestWorker ? JEST_FLUSH_INTERVAL : DEFAULT_FLUSH_INTERVAL
+  flushInterval: isJestWorker ? JEST_FLUSH_INTERVAL : DEFAULT_FLUSH_INTERVAL,
 }
 
 let shouldInit = !isFalse(getValueFromEnvSources('DD_CIVISIBILITY_ENABLED'))
@@ -54,13 +54,13 @@ if (!isTestWorker && isPackageManager()) {
 if (isTestWorker) {
   baseOptions.telemetry = { enabled: false }
   baseOptions.experimental = {
-    exporter: EXPORTER_MAP[testWorkerType]
+    exporter: EXPORTER_MAP[testWorkerType],
   }
 } else {
   if (isAgentlessEnabled) {
     if (getValueFromEnvSources('DD_API_KEY')) {
       baseOptions.experimental = {
-        exporter: 'datadog'
+        exporter: 'datadog',
       }
     } else {
       console.error(
@@ -72,7 +72,7 @@ if (isTestWorker) {
     }
   } else {
     baseOptions.experimental = {
-      exporter: 'agent_proxy'
+      exporter: 'agent_proxy',
     }
   }
 }

package/ext/exporters.js

@@ -8,5 +8,5 @@ module.exports = {
   CUCUMBER_WORKER: 'cucumber_worker',
   MOCHA_WORKER: 'mocha_worker',
   PLAYWRIGHT_WORKER: 'playwright_worker',
-  VITEST_WORKER: 'vitest_worker'
+  VITEST_WORKER: 'vitest_worker',
 }

package/ext/formats.js

@@ -5,5 +5,5 @@ module.exports = {
   HTTP_HEADERS: 'http_headers',
   BINARY: 'binary',
   LOG: 'log',
-  TEXT_MAP_DSM: 'text_map_dsm'
+  TEXT_MAP_DSM: 'text_map_dsm',
 }

package/ext/index.js

@@ -13,5 +13,5 @@ module.exports = {
   priority,
   tags,
   types,
-  exporters
+  exporters,
 }

package/ext/kinds.js

@@ -5,5 +5,5 @@ module.exports = {
   CLIENT: 'client',
   PRODUCER: 'producer',
   CONSUMER: 'consumer',
-  INTERNAL: 'internal'
+  INTERNAL: 'internal',
 }

package/ext/priority.js

@@ -4,5 +4,5 @@ module.exports = {
   USER_REJECT: -1,
   AUTO_REJECT: 0,
   AUTO_KEEP: 1,
-  USER_KEEP: 2
+  USER_KEEP: 2,
 }

package/ext/scopes.js

@@ -5,5 +5,5 @@ module.exports = {
   ASYNC_LOCAL_STORAGE: 'async_local_storage',
   ASYNC_HOOKS: 'async_hooks',
   SYNC: 'sync',
-  NOOP: 'noop'
+  NOOP: 'noop',
 }

package/ext/tags.js

@@ -29,7 +29,7 @@ const tags = {
   // Messaging
 
   // DSM Specific
-  PATHWAY_HASH: 'pathway.hash'
+  PATHWAY_HASH: 'pathway.hash',
 }
 
 // Deprecated

package/ext/types.js

@@ -3,5 +3,5 @@
 module.exports = {
   HTTP: 'http',
   SERVERLESS: 'serverless',
-  WEB: 'web'
+  WEB: 'web',
 }

package/index.d.ts

@@ -295,7 +295,18 @@ interface Plugins {
 }
 
 declare namespace tracer {
-  export type SpanOptions = opentracing.SpanOptions;
+  export type SpanOptions = Omit<opentracing.SpanOptions, 'childOf'> & {
+  /**
+   * Set childOf to 'null' to create a root span without a parent, even when a parent span
+   * exists in the current async context. If 'undefined' the parent will be inferred from the
+   * existing async context.
+   */
+    childOf?: opentracing.Span | opentracing.SpanContext | null;
+    /**
+     * Optional name of the integration that crated this span.
+     */
+    integrationName?: string;
+  };
   export { Tracer };
 
   export interface TraceOptions extends Analyzable {
@@ -749,6 +760,14 @@ declare namespace tracer {
      */
     dbmPropagationMode?: 'disabled' | 'service' | 'full'
 
+    /**
+     * Whether to enable Data Streams Monitoring.
+     * Can also be enabled via the DD_DATA_STREAMS_ENABLED environment variable.
+     * When not provided, the value of DD_DATA_STREAMS_ENABLED is used.
+     * @default false
+     */
+    dsmEnabled?: boolean
+
     /**
      * Configuration of the AppSec protection. Can be a boolean as an alias to `appsec.enabled`.
      */
@@ -1574,6 +1593,16 @@ declare namespace tracer {
        */
       blacklist?: string | RegExp | ((urlOrPath: string) => boolean) | (string | RegExp | ((urlOrPath: string) => boolean))[];
 
+      /**
+       * Custom filter function used to decide whether a URL/path is allowed.
+       * When provided, this takes precedence over allowlist/blocklist configuration.
+       * If not provided, allowlist/blocklist logic will be used instead.
+       *
+       * @param urlOrPath - The URL or path to filter
+       * @returns true to instrument the request, false to skip it
+       */
+      filter?: (urlOrPath: string) => boolean;
+
       /**
        * An array of headers to include in the span metadata.
        *
@@ -1626,6 +1655,21 @@ declare namespace tracer {
        * @default true
        */
       middleware?: boolean;
+
+      /**
+       * Whether (or how) to obfuscate querystring values in `http.url`.
+       *
+       * - `true`: obfuscate all values
+       * - `false`: disable obfuscation
+       * - `string`: regex string used to obfuscate matching values (empty string disables)
+       * - `RegExp`: regex used to obfuscate matching values
+       */
+      queryStringObfuscation?: boolean | string | RegExp;
+
+      /**
+       * Whether to enable resource renaming when the framework route is unavailable.
+       */
+      resourceRenamingEnabled?: boolean;
     }
 
     /** @hidden */
@@ -1691,6 +1735,20 @@ declare namespace tracer {
        * @default code => code < 500
        */
       validateStatus?: (code: number) => boolean;
+      /**
+       * Whether (or how) to obfuscate querystring values in `http.url`.
+       *
+       * - `true`: obfuscate all values
+       * - `false`: disable obfuscation
+       * - `string`: regex string used to obfuscate matching values (empty string disables)
+       * - `RegExp`: regex used to obfuscate matching values
+       */
+      queryStringObfuscation?: boolean | string | RegExp;
+
+      /**
+       * Whether to enable resource renaming when the framework route is unavailable.
+       */
+      resourceRenamingEnabled?: boolean;
     }
 
     /** @hidden */
@@ -1827,7 +1885,12 @@ declare namespace tracer {
      * This plugin automatically instruments the
      * @azure/functions module.
     */
-    interface azure_functions extends Instrumentation {}
+    interface azure_functions extends Instrumentation {
+      /**
+       * Whether to enable resource renaming when the framework route is unavailable.
+       */
+      resourceRenamingEnabled?: boolean;
+    }
 
     /**
      * This plugin automatically instruments the
@@ -2178,6 +2241,16 @@ declare namespace tracer {
        */
       blacklist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
 
+      /**
+       * Custom filter function used to decide whether a Redis command should be instrumented.
+       * When provided, this takes precedence over allowlist/blocklist configuration.
+       * If not provided, allowlist/blocklist logic will be used instead.
+       *
+       * @param command - The Redis command name to filter
+       * @returns true to instrument the command, false to skip it
+       */
+      filter?: (command: string) => boolean;
+
       /**
        * Whether to use a different service name for each Redis instance based
        * on the configured connection name of the client.
@@ -2225,6 +2298,16 @@ declare namespace tracer {
        */
       blacklist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
 
+      /**
+       * Custom filter function used to decide whether a Valkey command should be instrumented.
+       * When provided, this takes precedence over allowlist/blocklist configuration.
+       * If not provided, allowlist/blocklist logic will be used instead.
+       *
+       * @param command - The Valkey command name to filter
+       * @returns true to instrument the command, false to skip it
+       */
+      filter?: (command: string) => boolean;
+
       /**
        * Whether to use a different service name for each Redis instance based
        * on the configured connection name of the client.
@@ -2498,6 +2581,16 @@ declare namespace tracer {
        * @hidden
        */
       blacklist?: string | RegExp | ((command: string) => boolean) | (string | RegExp | ((command: string) => boolean))[];
+
+      /**
+       * Custom filter function used to decide whether a Redis command should be instrumented.
+       * When provided, this takes precedence over allowlist/blocklist configuration.
+       * If not provided, allowlist/blocklist logic will be used instead.
+       *
+       * @param command - The Redis command name to filter
+       * @returns true to instrument the command, false to skip it
+       */
+      filter?: (command: string) => boolean;
     }
 
     /**
@@ -2566,28 +2659,7 @@ declare namespace tracer {
     /**
      * This plugin implements shared web request instrumentation helpers.
      */
-    interface web extends HttpServer {
-      /**
-       * Custom filter function used to decide whether a URL/path should be instrumented.
-       * Takes precedence over allowlist/blocklist.
-       */
-      filter?: (urlOrPath: string) => boolean;
-
-      /**
-       * Whether (or how) to obfuscate querystring values in `http.url`.
-       *
-       * - `true`: obfuscate all values
-       * - `false`: disable obfuscation
-       * - `string`: regex string used to obfuscate matching values (empty string disables)
-       * - `RegExp`: regex used to obfuscate matching values
-       */
-      queryStringObfuscation?: boolean | string | RegExp;
-
-      /**
-       * Whether to enable resource renaming when the framework route is unavailable.
-       */
-      resourceRenamingEnabled?: boolean;
-    }
+    interface web extends HttpServer {}
 
     /**
      * This plugin patches the [winston](https://github.com/winstonjs/winston)

package/initialize.mjs

@@ -2,8 +2,7 @@
  * This file serves one of two purposes, depending on how it's used.
  *
  * If used with --import, it will import init.js and register the loader hook.
- * If used with --loader, it will act as the loader hook, except that it will
- * also import init.js inside the source code of the entrypoint file.
+ * If used with --loader, it will act as the loader hook.
  *
  * The result is that no matter how this file is used, so long as it's with
  * one of the two flags, the tracer will always be initialized, and the loader
@@ -12,58 +11,75 @@
 
 /* eslint n/no-unsupported-features/node-builtins: ['error', { ignores: ['module.register'] }] */
 
+import { Buffer } from 'buffer'
+import * as Module from 'module'
+import { types } from 'util'
 import { isMainThread } from 'worker_threads'
 
-import * as Module from 'node:module'
-import { fileURLToPath } from 'node:url'
+// This file must support Node.js 12.0.0 syntax
+
 import {
-  load as origLoad,
-  resolve as origResolve,
-  getSource as origGetSource,
-} from 'import-in-the-middle/hook.mjs'
+  iitmExclusions,
+  load as hookLoad,
+  resolve as hookResolve,
+} from './loader-hook.mjs'
 
 let hasInsertedInit = false
-function insertInit (result) {
-  if (!hasInsertedInit) {
-    hasInsertedInit = true
-    result.source = `
-import '${fileURLToPath(new URL('init.js', import.meta.url))}';
-${result.source}`
+const initJsUrl = new URL('init.js', import.meta.url).href
+// `--loader` only reliably influences ESM entrypoints; for CJS apps use `--import`/`--require`.
+
+/**
+ * @param {{ source?: string|Buffer|Uint8Array, format?: string }} result
+ * @param {unknown} _url_
+ * @param {{ format?: string, isMain?: boolean }} context
+ * @returns {{ source?: string|Buffer|Uint8Array, format?: string }}
+ */
+function insertInit (result, _url_, context) {
+  if (hasInsertedInit) return result
+  // If Node provides `isMain`, only inject into the entrypoint module.
+  if (context && context.isMain === false) return result
+
+  let { source } = result
+  if (typeof source !== 'string') {
+    // Fast decode: handle bytes sources without extra copies when possible.
+    if (Buffer.isBuffer(source)) {
+      source = source.toString('utf8')
+    } else if (types.isUint8Array(source)) {
+      // Create a Buffer view over the same ArrayBuffer segment (no copy).
+      source = Buffer.from(source.buffer, source.byteOffset, source.byteLength).toString('utf8')
+    } else {
+      return result
+    }
   }
+
+  const format = result.format || (context && context.format)
+  if (format !== 'module') return result
+
+  hasInsertedInit = true
+
+  result.source = `import ${JSON.stringify(initJsUrl)};\n${source}`
+
   return result
 }
 
 const [NODE_MAJOR, NODE_MINOR] = process.versions.node.split('.').map(Number)
 
 const brokenLoaders = NODE_MAJOR === 18 && NODE_MINOR === 0
-const iitmExclusions = [
-  /langsmith/,
-  /openai\/_shims/,
-  /openai\/resources\/chat\/completions\/messages/,
-  /openai\/agents-core\/dist\/shims/,
-  /@anthropic-ai\/sdk\/_shims/
-]
 
 export async function load (url, context, nextLoad) {
   const iitmExclusionsMatch = iitmExclusions.some((exclusion) => exclusion.test(url))
-  const loadHook = (brokenLoaders || iitmExclusionsMatch) ? nextLoad : origLoad
-  return insertInit(await loadHook(url, context, nextLoad))
+  const loadHook = (brokenLoaders || iitmExclusionsMatch) ? nextLoad : hookLoad
+  return insertInit(await loadHook(url, context, nextLoad), url, context)
 }
 
-export const resolve = brokenLoaders ? undefined : origResolve
-
-export async function getSource (...args) {
-  return insertInit(await origGetSource(...args))
-}
+export const resolve = brokenLoaders ? undefined : hookResolve
 
 if (isMainThread) {
   const require = Module.createRequire(import.meta.url)
   require('./init.js')
   if (Module.register) {
     Module.register('./loader-hook.mjs', import.meta.url, {
-      data: { exclude: iitmExclusions }
+      data: { exclude: iitmExclusions },
     })
   }
 }
-
-export { getFormat } from 'import-in-the-middle/hook.mjs'

package/loader-hook.mjs

@@ -1,28 +1,30 @@
-import * as iitm from 'import-in-the-middle/hook.mjs'
+import { initialize as origInitialize, load as origLoad, resolve } from 'import-in-the-middle/hook.mjs'
 import regexpEscapeModule from './vendor/dist/escape-string-regexp/index.js'
 import hooks from './packages/datadog-instrumentations/src/helpers/hooks.js'
 import configHelper from './packages/dd-trace/src/config/helper.js'
 import * as rewriterLoader from './packages/datadog-instrumentations/src/helpers/rewriter/loader.mjs'
 import { isRelativeRequire } from './packages/datadog-instrumentations/src/helpers/shared-utils.js'
 
+// This file must support Node.js 12.0.0 syntax
+
 const regexpEscape = regexpEscapeModule.default
 
 // For some reason `getEnvironmentVariable` is not otherwise available to ESM.
 const env = configHelper.getEnvironmentVariable
 
 function initialize (data = {}) {
-  data.include ??= []
-  data.exclude ??= []
+  if (data.include == null) data.include = []
+  if (data.exclude == null) data.exclude = []
 
   addInstrumentations(data)
   addSecurityControls(data)
   addExclusions(data)
 
-  return iitm.initialize(data)
+  return origInitialize(data)
 }
 
 function load (url, context, nextLoad) {
-  return rewriterLoader.load(url, context, (url, context) => iitm.load(url, context, nextLoad))
+  return rewriterLoader.load(url, context, (url, context) => origLoad(url, context, nextLoad))
 }
 
 function addInstrumentations (data) {
@@ -38,27 +40,38 @@ function addInstrumentations (data) {
 }
 
 function addSecurityControls (data) {
-  const securityControls = (env('DD_IAST_SECURITY_CONTROLS_CONFIGURATION') || '')
-    .split(';')
-    .map(sc => sc.trim().split(':')[2])
-    .filter(Boolean)
-    .map(sc => sc.trim())
+  const raw = env('DD_IAST_SECURITY_CONTROLS_CONFIGURATION')
+  if (!raw) return
+  // Parse `;`-separated entries and take the 3rd `:`-separated segment.
+  // Expected form (per entry): `<...>:<...>:<subpath>:<...>`
+  const entries = raw.split(';')
+  for (const entry of entries) {
+    if (entry) {
+      const first = entry.indexOf(':')
+      if (first === -1) continue
+      const second = entry.indexOf(':', first + 1)
+      if (second === -1) continue
+      const third = entry.indexOf(':', second + 1)
 
-  for (const subpath of securityControls) {
-    data.include.push(new RegExp(regexpEscape(subpath)))
+      const subpath = entry.slice(second + 1, third === -1 ? undefined : third).trim()
+      if (subpath) {
+        data.include.push(new RegExp(regexpEscape(subpath)))
+      }
+    }
   }
 }
 
 function addExclusions (data) {
-  data.exclude.push(
-    /middle/,
-    /langsmith/,
-    /openai\/_shims/,
-    /openai\/resources\/chat\/completions\/messages/,
-    /openai\/agents-core\/dist\/shims/,
-    /@anthropic-ai\/sdk\/_shims/
-  )
+  data.exclude.push(...iitmExclusions)
 }
 
-export { initialize, load }
-export { getFormat, resolve, getSource } from 'import-in-the-middle/hook.mjs'
+export const iitmExclusions = [
+  /middle/,
+  /langsmith/,
+  /openai\/_shims/,
+  /openai\/resources\/chat\/completions\/messages/,
+  /openai\/agents-core\/dist\/shims/,
+  /@anthropic-ai\/sdk\/_shims/,
+]
+
+export { initialize, load, resolve }