dd-trace 5.56.0 → 5.57.1

package/index.d.ts

@@ -212,6 +212,7 @@ interface Plugins {
   "playwright": tracer.plugins.playwright;
   "pg": tracer.plugins.pg;
   "pino": tracer.plugins.pino;
+  "prisma": tracer.plugins.prisma;
   "protobufjs": tracer.plugins.protobufjs;
   "redis": tracer.plugins.redis;
   "restify": tracer.plugins.restify;
@@ -483,10 +484,14 @@ declare namespace tracer {
     flushMinSpans?: number;
 
     /**
-     * Whether to enable runtime metrics.
+     * Whether to enable runtime metrics, or an object specifying whether to enable specific metric types.
      * @default false
      */
-    runtimeMetrics?: boolean
+    runtimeMetrics?: boolean | {
+      enabled?: boolean,
+      gc?: boolean,
+      eventLoop?: boolean
+    }
 
     /**
      * Custom function for DNS lookups when sending requests to the agent.
@@ -1271,6 +1276,15 @@ declare namespace tracer {
       meta?: boolean;
     }
 
+    /** @hidden */
+    interface Prisma extends Instrumentation {}
+
+    /** @hidden */
+    interface PrismaClient extends Prisma {}
+
+    /** @hidden */
+    interface PrismaEngine extends Prisma {}
+
     /**
      * This plugin automatically instruments the
      * [aerospike](https://github.com/aerospike/aerospike-client-nodejs) for module versions >= v3.16.2.
@@ -1820,6 +1834,13 @@ declare namespace tracer {
      * [mongodb-core](https://github.com/mongodb-js/mongodb-core) module.
      */
     interface mongodb_core extends Instrumentation {
+      /**
+       * Whether to enable mongo heartbeats spans.
+       *
+       * @default true
+       */
+      heartbeatEnabled?: boolean;
+
       /**
        * Whether to include the query contents in the resource name.
        */
@@ -1918,6 +1939,10 @@ declare namespace tracer {
        * The database monitoring propagation mode to be used for this plugin.
        */
       dbmPropagationMode?: string;
+      /**
+       * Appends the SQL comment propagation to the query string. Prepends the comment if `false`. For long query strings, the appended propagation comment might be truncated, causing loss of correlation between the query and trace.
+       */
+      appendComment?: boolean;
     }
 
     /**
@@ -1927,6 +1952,23 @@ declare namespace tracer {
      * on the tracer.
      */
     interface pino extends Integration {}
+
+    /**
+     * This plugin automatically instruments the
+     * [@prisma/client](https://www.prisma.io/docs/orm/prisma-client) module.
+     */
+    interface prisma extends PrismaClient, PrismaEngine {
+      /**
+       * Configuration for prisma client.
+       */
+      client?: PrismaClient | boolean,
+
+      /**
+       * Configuration for Prisma engine.
+       */
+      engine?: PrismaEngine | boolean
+    }
+
     /**
      * This plugin automatically patches the [protobufjs](https://protobufjs.github.io/protobuf.js/)
      * to collect protobuf message schemas when Datastreams Monitoring is enabled.

package/init.js

@@ -5,5 +5,8 @@
 var guard = require('./packages/dd-trace/src/guardrails')
 
 module.exports = guard(function () {
-  return require('.').init()
+  var INSTRUMENTED_BY_SSI = require('./packages/dd-trace/src/constants').INSTRUMENTED_BY_SSI
+  var obj = {}
+  obj[INSTRUMENTED_BY_SSI] = 'ssi'
+  return require('.').init(obj)
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.56.0",
+  "version": "5.57.1",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -8,7 +8,7 @@
     "env": "bash ./plugin-env",
     "preinstall": "node scripts/preinstall.js",
     "bench": "node benchmark/index.js",
-    "bench:e2e:ci-visibility": "node benchmark/e2e-ci/benchmark-run.js",
+    "bench:e2e:test-optimization": "node benchmark/e2e-test-optimization/benchmark-run.js",
     "dependencies:dedupe": "yarn-deduplicate yarn.lock",
     "type:doc": "cd docs && yarn && yarn build",
     "type:test": "cd docs && yarn && yarn test",
@@ -84,24 +84,24 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@datadog/libdatadog": "^0.6.0",
+    "@datadog/libdatadog": "0.7.0",
     "@datadog/native-appsec": "8.5.2",
     "@datadog/native-iast-taint-tracking": "4.0.0",
-    "@datadog/native-metrics": "^3.1.1",
-    "@datadog/pprof": "5.8.2",
-    "@datadog/sketches-js": "^2.1.1",
+    "@datadog/native-metrics": "3.1.1",
+    "@datadog/pprof": "5.9.0",
+    "@datadog/sketches-js": "2.1.1",
     "@datadog/wasm-js-rewriter": "4.0.1",
     "@isaacs/ttlcache": "^1.4.1",
-    "@opentelemetry/api": ">=1.0.0 <1.9.0",
+    "@opentelemetry/api": "1.8.0",
     "@opentelemetry/core": "^1.14.0",
     "crypto-randomuuid": "^1.0.0",
-    "dc-polyfill": "0.1.9",
+    "dc-polyfill": "^0.1.9",
     "ignore": "^5.2.4",
-    "import-in-the-middle": "1.14.0",
-    "istanbul-lib-coverage": "3.2.2",
+    "import-in-the-middle": "^1.14.2",
+    "istanbul-lib-coverage": "^3.2.2",
     "jest-docblock": "^29.7.0",
     "koalas": "^1.0.2",
-    "limiter": "1.1.5",
+    "limiter": "^1.1.5",
     "lodash.sortby": "^4.7.0",
     "lru-cache": "^7.18.3",
     "module-details-from-path": "^1.0.4",
@@ -119,30 +119,30 @@
     "ttl-set": "^1.0.0"
   },
   "devDependencies": {
-    "@babel/helpers": "^7.27.3",
+    "@babel/helpers": "^7.27.6",
     "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.27.0",
+    "@eslint/js": "^9.29.0",
     "@msgpack/msgpack": "^3.1.2",
-    "@stylistic/eslint-plugin": "^4.4.0",
+    "@stylistic/eslint-plugin": "^5.0.0",
     "@types/node": "^18.19.106",
-    "axios": "^1.9.0",
+    "axios": "^1.10.0",
     "benchmark": "^2.1.4",
     "body-parser": "^2.2.0",
     "chai": "^4.5.0",
-    "eslint": "^9.27.0",
+    "eslint": "^9.29.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-mocha": "^10.5.0",
-    "eslint-plugin-n": "^17.18.0",
+    "eslint-plugin-n": "^17.20.0",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-unicorn": "^57.0.0",
     "express": "^4.21.2",
     "get-port": "^5.1.1",
     "glob": "^7.2.3",
     "globals": "^15.15.0",
-    "graphql": "0.13.2",
+    "graphql": "*",
     "jszip": "^3.10.1",
-    "mocha": "^10.8.2",
+    "mocha": "^11.6.0",
     "multer": "^2.0.1",
     "nock": "^11.9.1",
     "nyc": "^15.1.0",

package/packages/datadog-esbuild/index.js

@@ -53,8 +53,30 @@ for (const pkg of INSTRUMENTED) {
 
 module.exports.name = 'datadog-esbuild'
 
+function isESMBuild (build) {
+  // check toLowerCase? to be safe if unexpected object is there instead of a string
+  const format = build.initialOptions.format?.toLowerCase?.()
+  const outputFile = build.initialOptions.outfile?.toLowerCase?.()
+  const outExtension = build.initialOptions.outExtension?.['.js']
+  return format === 'esm' || outputFile?.endsWith('.mjs') || outExtension === '.mjs'
+}
+
 module.exports.setup = function (build) {
   const externalModules = new Set(build.initialOptions.external || [])
+  if (isESMBuild(build)) {
+    build.initialOptions.banner ??= {}
+    build.initialOptions.banner.js ??= ''
+    if (!build.initialOptions.banner.js.includes('import { createRequire as $dd_createRequire } from \'module\'')) {
+      build.initialOptions.banner.js = `import { createRequire as $dd_createRequire } from 'module';
+import { fileURLToPath as $dd_fileURLToPath } from 'url';
+import { dirname as $dd_dirname } from 'path';
+globalThis.require ??= $dd_createRequire(import.meta.url);
+globalThis.__filename ??= $dd_fileURLToPath(import.meta.url);
+globalThis.__dirname ??= $dd_dirname(globalThis.__filename);
+${build.initialOptions.banner.js}`
+    }
+  }
+
   build.onResolve({ filter: /.*/ }, args => {
     if (externalModules.has(args.path)) {
       // Internal Node.js packages will still be instrumented via require()

package/packages/datadog-instrumentations/src/cassandra-driver.js

@@ -2,8 +2,7 @@
 
 const {
   channel,
-  addHook,
-  AsyncResource
+  addHook
 } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
@@ -12,36 +11,33 @@ const finishCh = channel('apm:cassandra-driver:query:finish')
 const errorCh = channel('apm:cassandra-driver:query:error')
 const connectCh = channel('apm:cassandra-driver:query:connect')
 
+let startCtx = {}
+
 addHook({ name: 'cassandra-driver', versions: ['>=3.0.0'] }, cassandra => {
   shimmer.wrap(cassandra.Client.prototype, 'batch', batch => function (queries, options, callback) {
     if (!startCh.hasSubscribers) {
       return batch.apply(this, arguments)
     }
-    const callbackResource = new AsyncResource('bound-anonymous-fn')
-    const asyncResource = new AsyncResource('bound-anonymous-fn')
     const lastIndex = arguments.length - 1
-    let cb = arguments[lastIndex]
+    const cb = arguments[lastIndex]
 
-    if (typeof cb === 'function') {
-      cb = callbackResource.bind(cb)
-      arguments[lastIndex] = wrapCallback(finishCh, errorCh, asyncResource, cb)
-    }
+    startCtx = { keyspace: this.keyspace, query: queries, contactPoints: this.options && this.options.contactPoints }
+    return startCh.runStores(startCtx, () => {
+      if (typeof cb === 'function') {
+        arguments[lastIndex] = wrapCallback(finishCh, errorCh, startCtx, cb)
+      }
 
-    return asyncResource.runInAsyncScope(() => {
-      const contactPoints = this.options && this.options.contactPoints
-      startCh.publish({ keyspace: this.keyspace, query: queries, contactPoints })
       try {
         const res = batch.apply(this, arguments)
         if (typeof res === 'function' || !res) {
-          return wrapCallback(finishCh, errorCh, asyncResource, res)
+          return wrapCallback(finishCh, errorCh, startCtx, res)
         }
-        const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
         return res.then(
-          promiseAsyncResource.bind(() => finish(finishCh, errorCh)),
-          promiseAsyncResource.bind(err => finish(finishCh, errorCh, err))
+          () => finish(finishCh, errorCh, startCtx),
+          err => finish(finishCh, errorCh, startCtx, err)
         )
       } catch (e) {
-        finish(finishCh, errorCh, e)
+        finish(finishCh, errorCh, startCtx, e)
         throw e
       }
     })
@@ -54,17 +50,13 @@ addHook({ name: 'cassandra-driver', versions: ['>=4.4'] }, cassandra => {
     if (!startCh.hasSubscribers) {
       return _execute.apply(this, arguments)
     }
-    const asyncResource = new AsyncResource('bound-anonymous-fn')
-    return asyncResource.runInAsyncScope(() => {
-      const contactPoints = this.options && this.options.contactPoints
-      startCh.publish({ keyspace: this.keyspace, query, contactPoints })
+    startCtx = { keyspace: this.keyspace, query, contactPoints: this.options && this.options.contactPoints }
+    return startCh.runStores(startCtx, () => {
       const promise = _execute.apply(this, arguments)
 
-      const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
-
       promise.then(
-        promiseAsyncResource.bind(() => finish(finishCh, errorCh)),
-        promiseAsyncResource.bind(err => finish(finishCh, errorCh, err))
+        () => finish(finishCh, errorCh, startCtx),
+        err => finish(finishCh, errorCh, startCtx, err)
       )
       return promise
     })
@@ -82,29 +74,23 @@ addHook({ name: 'cassandra-driver', versions: ['3 - 4.3'] }, cassandra => {
       if (!startCh.hasSubscribers) {
         return _innerExecute.apply(this, arguments)
       }
-      const callbackResource = new AsyncResource('bound-anonymous-fn')
-      const asyncResource = new AsyncResource('bound-anonymous-fn')
-
       if (!isValid(arguments)) {
         return _innerExecute.apply(this, arguments)
       }
 
-      return asyncResource.runInAsyncScope(() => {
-        const contactPoints = this.options && this.options.contactPoints
-        startCh.publish({ keyspace: this.keyspace, query, contactPoints })
-
+      startCtx = { keyspace: this.keyspace, query, contactPoints: this.options && this.options.contactPoints }
+      return startCh.runStores(startCtx, () => {
         const lastIndex = arguments.length - 1
-        let cb = arguments[lastIndex]
+        const cb = arguments[lastIndex]
 
         if (typeof cb === 'function') {
-          cb = callbackResource.bind(cb)
-          arguments[lastIndex] = wrapCallback(finishCh, errorCh, asyncResource, cb)
+          arguments[lastIndex] = wrapCallback(finishCh, errorCh, startCtx, cb)
         }
 
         try {
           return _innerExecute.apply(this, arguments)
         } catch (e) {
-          finish(finishCh, errorCh, e)
+          finish(finishCh, errorCh, startCtx, e)
           throw e
         }
       })
@@ -118,7 +104,8 @@ addHook({ name: 'cassandra-driver', versions: ['>=3.3'], file: 'lib/request-exec
     if (!startCh.hasSubscribers) {
       return _sendOnConnection.apply(this, arguments)
     }
-    connectCh.publish({ hostname: this._connection.address, port: this._connection.port })
+    startCtx = { hostname: this._connection.address, port: this._connection.port, ...startCtx }
+    connectCh.publish(startCtx)
     return _sendOnConnection.apply(this, arguments)
   })
   return RequestExecution
@@ -129,19 +116,16 @@ addHook({ name: 'cassandra-driver', versions: ['3.3 - 4.3'], file: 'lib/request-
     if (!startCh.hasSubscribers) {
       return getHostCallback.apply(this, arguments)
     }
-    const asyncResource = new AsyncResource('bound-anonymous-fn')
     const execution = this
 
     if (!isRequestValid(this, arguments, 1)) {
       return start.apply(this, arguments)
     }
 
-    getHostCallback = asyncResource.bind(getHostCallback)
-
-    arguments[0] = AsyncResource.bind(function () {
-      connectCh.publish({ hostname: execution._connection.address, port: execution._connection.port })
-      return getHostCallback.apply(this, arguments)
-    })
+    arguments[0] = function () {
+      startCtx = { hostname: execution._connection.address, port: execution._connection.port, ...startCtx }
+      return connectCh.runStores(startCtx, getHostCallback, this, ...arguments)
+    }
 
     return start.apply(this, arguments)
   })
@@ -158,34 +142,33 @@ addHook({ name: 'cassandra-driver', versions: ['3 - 3.2'], file: 'lib/request-ha
     if (!isRequestValid(this, arguments, 3)) {
       return send.apply(this, arguments)
     }
-    const asyncResource = new AsyncResource('bound-anonymous-fn')
-
-    callback = asyncResource.bind(callback)
 
-    arguments[2] = AsyncResource.bind(function () {
-      connectCh.publish({ hostname: handler.connection.address, port: handler.connection.port })
-      return callback.apply(this, arguments)
-    })
+    arguments[2] = function () {
+      startCtx = { hostname: handler.connection.address, port: handler.connection.port, ...startCtx }
+      return connectCh.runStores(startCtx, callback, this, ...arguments)
+    }
 
     return send.apply(this, arguments)
   })
   return RequestHandler
 })
 
-function finish (finishCh, errorCh, error) {
+function finish (finishCh, errorCh, ctx, error) {
   if (error) {
-    errorCh.publish(error)
+    ctx.error = error
+    errorCh.publish(ctx)
   }
-  finishCh.publish()
+  finishCh.runStores(ctx, () => {})
 }
 
-function wrapCallback (finishCh, errorCh, asyncResource, callback) {
-  return shimmer.wrapFunction(callback, callback => asyncResource.bind(function (err) {
-    finish(finishCh, errorCh, err)
-    if (callback) {
-      return callback.apply(this, arguments)
+function wrapCallback (finishCh, errorCh, ctx, callback) {
+  return shimmer.wrapFunction(callback, callback => function (err) {
+    if (err) {
+      ctx.error = err
+      errorCh.publish(ctx)
     }
-  }))
+    return finishCh.runStores(ctx, callback, this, ...arguments)
+  })
 }
 
 function isRequestValid (exec, args, length) {

package/packages/datadog-instrumentations/src/confluentinc-kafka-javascript.js

@@ -10,20 +10,20 @@ const log = require('../../dd-trace/src/log')
 
 // Create channels for Confluent Kafka JavaScript
 const channels = {
-  producerStart: channel('apm:@confluentinc/kafka-javascript:produce:start'),
-  producerFinish: channel('apm:@confluentinc/kafka-javascript:produce:finish'),
-  producerError: channel('apm:@confluentinc/kafka-javascript:produce:error'),
-  producerCommit: channel('apm:@confluentinc/kafka-javascript:produce:commit'),
-  consumerStart: channel('apm:@confluentinc/kafka-javascript:consume:start'),
-  consumerFinish: channel('apm:@confluentinc/kafka-javascript:consume:finish'),
-  consumerError: channel('apm:@confluentinc/kafka-javascript:consume:error'),
-  consumerCommit: channel('apm:@confluentinc/kafka-javascript:consume:commit'),
+  producerStart: channel('apm:confluentinc-kafka-javascript:produce:start'),
+  producerFinish: channel('apm:confluentinc-kafka-javascript:produce:finish'),
+  producerError: channel('apm:confluentinc-kafka-javascript:produce:error'),
+  producerCommit: channel('apm:confluentinc-kafka-javascript:produce:commit'),
+  consumerStart: channel('apm:confluentinc-kafka-javascript:consume:start'),
+  consumerFinish: channel('apm:confluentinc-kafka-javascript:consume:finish'),
+  consumerError: channel('apm:confluentinc-kafka-javascript:consume:error'),
+  consumerCommit: channel('apm:confluentinc-kafka-javascript:consume:commit'),
 
   // batch operations
-  batchConsumerStart: channel('apm:@confluentinc/kafka-javascript:consume-batch:start'),
-  batchConsumerFinish: channel('apm:@confluentinc/kafka-javascript:consume-batch:finish'),
-  batchConsumerError: channel('apm:@confluentinc/kafka-javascript:consume-batch:error'),
-  batchConsumerCommit: channel('apm:@confluentinc/kafka-javascript:consume-batch:commit')
+  batchConsumerStart: channel('apm:confluentinc-kafka-javascript:consume-batch:start'),
+  batchConsumerFinish: channel('apm:confluentinc-kafka-javascript:consume-batch:finish'),
+  batchConsumerError: channel('apm:confluentinc-kafka-javascript:consume-batch:error'),
+  batchConsumerCommit: channel('apm:confluentinc-kafka-javascript:consume-batch:commit')
 }
 
 const disabledHeaderWeakSet = new WeakSet()

package/packages/datadog-instrumentations/src/cucumber.js

@@ -157,9 +157,9 @@ function getErrorFromCucumberResult (cucumberResult) {
   return error
 }
 
-function getChannelPromise (channelToPublishTo, isParallel = false) {
+function getChannelPromise (channelToPublishTo, isParallel = false, frameworkVersion = null) {
   return new Promise(resolve => {
-    channelToPublishTo.publish({ onDone: resolve, isParallel })
+    channelToPublishTo.publish({ onDone: resolve, isParallel, frameworkVersion })
   })
 }
 
@@ -451,7 +451,7 @@ function getWrappedStart (start, frameworkVersion, isParallel = false, isCoordin
     }
     let errorSkippableRequest
 
-    const configurationResponse = await getChannelPromise(libraryConfigurationCh, isParallel)
+    const configurationResponse = await getChannelPromise(libraryConfigurationCh, isParallel, frameworkVersion)
 
     isEarlyFlakeDetectionEnabled = configurationResponse.libraryConfig?.isEarlyFlakeDetectionEnabled
     earlyFlakeDetectionNumRetries = configurationResponse.libraryConfig?.earlyFlakeDetectionNumRetries
@@ -490,9 +490,7 @@ function getWrappedStart (start, frameworkVersion, isParallel = false, isCoordin
 
         isSuitesSkipped = picklesToRun.length !== oldPickles.length
 
-        log.debug(
-          () => `${picklesToRun.length} out of ${oldPickles.length} suites are going to run.`
-        )
+        log.debug('%s out of %s suites are going to run.', picklesToRun.length, oldPickles.length)
 
         if (isCoordinator) {
           this.sourcedPickles = picklesToRun

package/packages/datadog-instrumentations/src/elasticsearch.js

@@ -2,8 +2,7 @@
 
 const {
   channel,
-  addHook,
-  AsyncResource
+  addHook
 } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
@@ -73,33 +72,30 @@ function createWrapRequest (name) {
 
       if (!params) return request.apply(this, arguments)
 
-      const parentResource = new AsyncResource('bound-anonymous-fn')
-      const asyncResource = new AsyncResource('bound-anonymous-fn')
-
-      return asyncResource.runInAsyncScope(() => {
-        startCh.publish({ params })
-
+      const ctx = { params }
+      return startCh.runStores(ctx, () => {
         try {
           const lastIndex = arguments.length - 1
           cb = arguments[lastIndex]
 
           if (typeof cb === 'function') {
-            cb = parentResource.bind(cb)
-
-            arguments[lastIndex] = shimmer.wrapFunction(cb, cb => asyncResource.bind(function (error) {
-              finish(params, error)
-              return cb.apply(null, arguments)
-            }))
+            arguments[lastIndex] = shimmer.wrapFunction(cb, cb => function (error) {
+              if (error) {
+                ctx.error = error
+                errorCh.publish(ctx)
+              }
+              return finishCh.runStores(ctx, cb, null, ...arguments)
+            })
             return request.apply(this, arguments)
           }
           const promise = request.apply(this, arguments)
           if (promise && typeof promise.then === 'function') {
-            const onResolve = asyncResource.bind(() => finish(params))
-            const onReject = asyncResource.bind(e => finish(params, e))
+            const onResolve = () => finish(ctx)
+            const onReject = e => finish(ctx, e)
 
             promise.then(onResolve, onReject)
           } else {
-            finish(params)
+            finish(ctx)
           }
           return promise
         } catch (err) {
@@ -112,11 +108,12 @@ function createWrapRequest (name) {
     }
   }
 
-  function finish (params, error) {
+  function finish (ctx, error) {
     if (error) {
+      ctx.error = error
       errorCh.publish(error)
     }
-    finishCh.publish({ params })
+    return finishCh.runStores(ctx, () => {})
   }
 }