dd-trace 2.7.0 → 2.9.0

package/LICENSE-3rdparty.csv

@@ -17,7 +17,6 @@ require,lodash.sortby,MIT,Copyright JS Foundation and other contributors
 require,lodash.uniq,MIT,Copyright JS Foundation and other contributors
 require,methods,MIT,Copyright 2013-2014 TJ Holowaychuk
 require,module-details-from-path,MIT,Copyright 2016 Thomas Watson Steen
-require,multer,MIT,Copyright 2014 Hage Yaapa
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc
 require,path-to-regexp,MIT,Copyright 2014 Blake Embrey
 require,performance-now,MIT,Copyright 2013 Braveg1rl
@@ -31,7 +30,6 @@ dev,chai,MIT,Copyright 2017 Chai.js Assertion Library
 dev,chalk,MIT,Copyright Sindre Sorhus
 dev,checksum,MIT,Copyright Daniel D. Shaw
 dev,cli-table3,MIT,Copyright 2014 James Talmage
-dev,codecov,MIT,Copyright 2014 Gregg Caines
 dev,dotenv,BSD-2-Clause,Copyright 2015 Scott Motte
 dev,eslint,MIT,Copyright JS Foundation and other contributors https://js.foundation
 dev,eslint-config-standard,MIT,Copyright Feross Aboukhadijeh
@@ -47,6 +45,7 @@ dev,int64-buffer,MIT,Copyright 2015-2016 Yusuke Kawasaki
 dev,jszip,MIT,Copyright 2015-2016 Stuart Knightley and contributors
 dev,mkdirp,MIT,Copyright 2010 James Halliday
 dev,mocha,MIT,Copyright 2011-2018 JS Foundation and contributors https://js.foundation
+dev,multer,MIT,Copyright 2014 Hage Yaapa
 dev,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
 dev,nyc,ISC,Copyright 2015 Contributors

package/ci/init.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const path = require('path')
 const tracer = require('../packages/dd-trace')
 const { ORIGIN_KEY } = require('../packages/dd-trace/src/constants')
@@ -11,9 +13,22 @@ const options = {
   }
 }
 
-if (process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED && (process.env.DATADOG_API_KEY || process.env.DD_API_KEY)) {
-  options.experimental = {
-    exporter: 'datadog'
+let shouldInit = true
+
+const isAgentlessEnabled = process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED &&
+  process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED !== 'false' &&
+  process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED !== '0'
+
+if (isAgentlessEnabled) {
+  if (process.env.DATADOG_API_KEY || process.env.DD_API_KEY) {
+    options.experimental = {
+      exporter: 'datadog'
+    }
+  } else {
+    console.error(`DD_CIVISIBILITY_AGENTLESS_ENABLED is set, \
+but neither DD_API_KEY nor DATADOG_API_KEY are set in your environment, \
+so dd-trace will not be initialized.`)
+    shouldInit = false
   }
 }
 
@@ -36,8 +51,9 @@ try {
   // ignore error and let the tracer initialize anyway
 }
 
-tracer.init(options)
-
-tracer.use('fs', false)
+if (shouldInit) {
+  tracer.init(options)
+  tracer.use('fs', false)
+}
 
 module.exports = tracer

package/ci/jest/env.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 const tracer = require('../../packages/dd-trace')
 const { ORIGIN_KEY } = require('../../packages/dd-trace/src/constants')
 
@@ -8,13 +10,23 @@ const options = {
   }
 }
 
-if (process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED && (process.env.DATADOG_API_KEY || process.env.DD_API_KEY)) {
-  tracer.init({
-    ...options,
-    experimental: {
-      exporter: 'datadog'
-    }
-  })
+const isAgentlessEnabled = process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED &&
+  process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED !== 'false' &&
+  process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED !== '0'
+
+if (isAgentlessEnabled) {
+  if (process.env.DATADOG_API_KEY || process.env.DD_API_KEY) {
+    tracer.init({
+      ...options,
+      experimental: {
+        exporter: 'datadog'
+      }
+    })
+  } else {
+    console.error(`DD_CIVISIBILITY_AGENTLESS_ENABLED is set, \
+but neither DD_API_KEY nor DATADOG_API_KEY are set in your environment, \
+so dd-trace will not be initialized.`)
+  }
 } else {
   tracer.init({
     ...options,

package/ext/tags.d.ts

@@ -15,6 +15,7 @@ declare const tags: {
   HTTP_ROUTE: 'http.route'
   HTTP_REQUEST_HEADERS: 'http.request.headers'
   HTTP_RESPONSE_HEADERS: 'http.response.headers'
+  HTTP_USERAGENT: 'http.useragent'
 }
 
 export = tags

package/ext/tags.js

@@ -19,7 +19,8 @@ const tags = {
   HTTP_STATUS_CODE: 'http.status_code',
   HTTP_ROUTE: 'http.route',
   HTTP_REQUEST_HEADERS: 'http.request.headers',
-  HTTP_RESPONSE_HEADERS: 'http.response.headers'
+  HTTP_RESPONSE_HEADERS: 'http.response.headers',
+  HTTP_USERAGENT: 'http.useragent'
 }
 
 // Deprecated

package/index.d.ts

@@ -1210,13 +1210,15 @@ declare namespace plugins {
    * This plugin automatically instruments the
    * [mysql](https://github.com/mysqljs/mysql) module.
    */
-  interface mysql extends Instrumentation {}
+  interface mysql extends Instrumentation {
+    service?: string | ((params: any) => string);
+  }
 
   /**
    * This plugin automatically instruments the
    * [mysql2](https://github.com/brianmario/mysql2) module.
    */
-  interface mysql2 extends Instrumentation {}
+  interface mysql2 extends mysql {}
 
   /**
    * This plugin automatically instruments the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.7.0",
+  "version": "2.9.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -32,7 +32,6 @@
     "test:shimmer:ci": "nyc --no-clean --include 'packages/datadog-shimmer/src/**/*.js' -- npm run test:shimmer",
     "leak:core": "node ./scripts/install_plugin_modules && (cd packages/memwatch && yarn) && NODE_PATH=./packages/memwatch/node_modules node --no-warnings ./node_modules/.bin/tape 'packages/dd-trace/test/leak/**/*.js'",
     "leak:plugins": "yarn services && (cd packages/memwatch && yarn) && NODE_PATH=./packages/memwatch/node_modules node --no-warnings ./node_modules/.bin/tape \"packages/datadog-plugin-@($(echo $PLUGINS))/test/leak.js\"",
-    "codecov": "codecov",
     "junit:upload": "node ./scripts/junit_report.js"
   },
   "repository": {
@@ -59,7 +58,7 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^1.1.1",
+    "@datadog/native-appsec": "^1.2.0",
     "@datadog/native-metrics": "^1.2.0",
     "@datadog/pprof": "^0.4.0",
     "@datadog/sketches-js": "^1.0.4",
@@ -77,7 +76,6 @@
     "lodash.uniq": "^4.5.0",
     "methods": "^1.1.2",
     "module-details-from-path": "^1.0.3",
-    "multer": "^1.4.2",
     "opentracing": ">=0.12.1",
     "path-to-regexp": "^0.1.2",
     "performance-now": "^2.1.0",
@@ -93,7 +91,6 @@
     "chalk": "^3.0.0",
     "checksum": "^0.1.1",
     "cli-table3": "^0.5.1",
-    "codecov": "3.8.1",
     "dotenv": "8.2.0",
     "eslint": "^7.32.0",
     "eslint-config-standard": "^11.0.0-beta.0",
@@ -109,6 +106,7 @@
     "jszip": "^3.5.0",
     "mkdirp": "^0.5.1",
     "mocha": "8",
+    "multer": "^1.4.2",
     "msgpack-lite": "^0.1.26",
     "nock": "^11.3.3",
     "nyc": "^15.1.0",

package/packages/datadog-core/src/storage/async_resource.js

@@ -69,7 +69,7 @@ class AsyncResourceStorage {
   }
 
   _executionAsyncResource () {
-    return executionAsyncResource()
+    return executionAsyncResource() || {}
   }
 }
 

package/packages/datadog-instrumentations/index.js

@@ -2,6 +2,7 @@
 
 require('./src/amqplib')
 require('./src/amqp10')
+require('./src/aws-sdk')
 require('./src/bluebird')
 require('./src/bunyan')
 require('./src/cassandra-driver')
@@ -15,6 +16,7 @@ require('./src/fastify')
 require('./src/find-my-way')
 require('./src/generic-pool')
 require('./src/google-cloud-pubsub')
+require('./src/hapi')
 require('./src/http')
 require('./src/ioredis')
 require('./src/jest')
@@ -22,6 +24,7 @@ require('./src/kafkajs')
 require('./src/knex')
 require('./src/koa')
 require('./src/memcached')
+require('./src/moleculer')
 require('./src/mongodb-core')
 require('./src/mongoose')
 require('./src/mysql')

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

@@ -9,62 +9,63 @@ const shimmer = require('../../datadog-shimmer')
 
 addHook({ name: 'amqp10', file: 'lib/sender_link.js', versions: ['>=3'] }, SenderLink => {
   const startCh = channel('apm:amqp10:send:start')
-  const asyncEndCh = channel('apm:amqp10:send:async-end')
-  const endCh = channel('apm:amqp10:send:end')
+  const finishCh = channel('apm:amqp10:send:finish')
   const errorCh = channel('apm:amqp10:send:error')
   shimmer.wrap(SenderLink.prototype, 'send', send => function (msg, options) {
     if (!startCh.hasSubscribers) {
       return send.apply(this, arguments)
     }
-    startCh.publish({ link: this })
-    try {
-      const promise = send.apply(this, arguments)
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    return asyncResource.runInAsyncScope(() => {
+      startCh.publish({ link: this })
+      try {
+        const promise = send.apply(this, arguments)
 
-      if (!promise) {
-        finish(asyncEndCh, errorCh)
-        return promise
-      }
-
-      const asyncResource = new AsyncResource('bound-anonymous-fn')
+        if (!promise) {
+          finish(finishCh, errorCh)
+          return promise
+        }
 
-      promise.then(asyncResource.bind(() => finish(asyncEndCh, errorCh)),
-        asyncResource.bind(e => finish(asyncEndCh, errorCh, e)))
+        promise.then(asyncResource.bind(() => finish(finishCh, errorCh)),
+          asyncResource.bind(e => finish(finishCh, errorCh, e)))
 
-      return promise
-    } catch (err) {
-      finish(asyncEndCh, errorCh, err)
-      throw err
-    } finally {
-      endCh.publish(undefined)
-    }
+        return promise
+      } catch (err) {
+        finish(finishCh, errorCh, err)
+        throw err
+      }
+    })
   })
   return SenderLink
 })
 
 addHook({ name: 'amqp10', file: 'lib/receiver_link.js', versions: ['>=3'] }, ReceiverLink => {
   const startCh = channel('apm:amqp10:receive:start')
-  const endCh = channel('apm:amqp10:receive:end')
+  const finishCh = channel('apm:amqp10:receive:finish')
   const errorCh = channel('apm:amqp10:receive:error')
   shimmer.wrap(ReceiverLink.prototype, '_messageReceived', messageReceived => function (transferFrame) {
     if (!transferFrame || transferFrame.aborted || transferFrame.more) {
       return messageReceived.apply(this, arguments)
     }
-    startCh.publish({ link: this })
-    try {
-      return messageReceived.apply(this, arguments)
-    } catch (err) {
-      errorCh.publish(err)
-      throw err
-    } finally {
-      endCh.publish(undefined)
-    }
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    return asyncResource.runInAsyncScope(() => {
+      startCh.publish({ link: this })
+      try {
+        return messageReceived.apply(this, arguments)
+      } catch (err) {
+        errorCh.publish(err)
+        throw err
+      } finally {
+        finishCh.publish()
+      }
+    })
   })
   return ReceiverLink
 })
 
-function finish (asyncEndCh, errorCh, error) {
+function finish (finishCh, errorCh, error) {
   if (error) {
     errorCh.publish(error)
   }
-  asyncEndCh.publish(undefined)
+  finishCh.publish()
 }

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

@@ -2,13 +2,14 @@
 
 const {
   channel,
-  addHook
+  addHook,
+  AsyncResource
 } = require('./helpers/instrument')
 const kebabCase = require('lodash.kebabcase')
 const shimmer = require('../../datadog-shimmer')
 
 const startCh = channel('apm:amqplib:command:start')
-const endCh = channel('apm:amqplib:command:end')
+const finishCh = channel('apm:amqplib:command:finish')
 const errorCh = channel('apm:amqplib:command:error')
 
 let methods = {}
@@ -40,17 +41,21 @@ function instrument (send, channel, args, method, fields, message) {
   if (!startCh.hasSubscribers) {
     return send.apply(channel, args)
   }
-  startCh.publish({ channel, method, fields, message })
 
-  try {
-    return send.apply(channel, args)
-  } catch (err) {
-    errorCh.publish(err)
+  const asyncResource = new AsyncResource('bound-anonymous-fn')
+  return asyncResource.runInAsyncScope(() => {
+    startCh.publish({ channel, method, fields, message })
 
-    throw err
-  } finally {
-    endCh.publish(undefined)
-  }
+    try {
+      return send.apply(channel, args)
+    } catch (err) {
+      errorCh.publish(err)
+
+      throw err
+    } finally {
+      finishCh.publish()
+    }
+  })
 }
 
 function isCamelCase (str) {

package/packages/datadog-instrumentations/src/aws-sdk.js

@@ -0,0 +1,105 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+function wrapRequest (send) {
+  return function wrappedRequest (cb) {
+    if (!this.service) return send.apply(this, arguments)
+
+    const serviceIdentifier = this.service.serviceIdentifier
+    const channelSuffix = getChannelSuffix(serviceIdentifier)
+    const startCh = channel(`apm:aws:request:start:${channelSuffix}`)
+    if (!startCh.hasSubscribers) return send.apply(this, arguments)
+    const innerAr = new AsyncResource('apm:aws:request:inner')
+    const outerAr = new AsyncResource('apm:aws:request:outer')
+
+    return innerAr.runInAsyncScope(() => {
+      this.on('complete', innerAr.bind(response => {
+        channel(`apm:aws:request:complete:${channelSuffix}`).publish({ response })
+      }))
+
+      startCh.publish({
+        serviceIdentifier,
+        operation: this.operation,
+        awsRegion: this.service.config && this.service.config.region,
+        awsService: this.service.api && this.service.api.className,
+        request: this
+      })
+
+      if (typeof cb === 'function') {
+        arguments[0] = wrapCb(cb, channelSuffix, this, outerAr)
+      }
+      return send.apply(this, arguments)
+    })
+  }
+}
+
+function wrapCb (cb, serviceName, request, ar) {
+  return function wrappedCb (err, response) {
+    const obj = { request, response }
+    return ar.runInAsyncScope(() => {
+      channel(`apm:aws:response:start:${serviceName}`).publish(obj)
+      // TODO(bengl) make this work without needing a needsFinish property added to the object
+      if (!obj.needsFinish) {
+        return cb.apply(this, arguments)
+      }
+      const finishChannel = channel(`apm:aws:response:finish:${serviceName}`)
+      try {
+        let result = cb.apply(this, arguments)
+        if (result && result.then) {
+          result = result.then(x => {
+            finishChannel.publish()
+            return x
+          }, e => {
+            finishChannel.publish(e)
+            throw e
+          })
+        } else {
+          finishChannel.publish()
+        }
+        return result
+      } catch (e) {
+        finishChannel.publish(e)
+        throw e
+      }
+    })
+  }
+}
+
+function getChannelSuffix (name) {
+  return [
+    'cloudwatchlogs',
+    'dynamodb',
+    'eventbridge',
+    'kinesis',
+    'lambda',
+    'redshift',
+    's3',
+    'sns',
+    'sqs'
+  ].includes(name) ? name : 'default'
+}
+
+addHook({ name: 'aws-sdk', versions: ['>=2.3.0'] }, AWS => {
+  shimmer.wrap(AWS.Request.prototype, 'promise', wrapRequest)
+  shimmer.wrap(AWS.config, 'setPromisesDependency', setPromisesDependency => {
+    return function wrappedSetPromisesDependency (dep) {
+      const result = setPromisesDependency.apply(this, arguments)
+      shimmer.wrap(AWS.Request.prototype, 'promise', wrapRequest)
+      return result
+    }
+  })
+  return AWS
+})
+
+// <2.1.35 has breaking changes for instrumentation
+// https://github.com/aws/aws-sdk-js/pull/629
+addHook({ name: 'aws-sdk', versions: ['>=2.1.35'] }, AWS => {
+  shimmer.wrap(AWS.Request.prototype, 'send', wrapRequest)
+  return AWS
+})

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

@@ -8,8 +8,7 @@ const {
 const shimmer = require('../../datadog-shimmer')
 
 const startCh = channel('apm:cassandra:query:start')
-const asyncEndCh = channel('apm:cassandra:query:async-end')
-const endCh = channel('apm:cassandra:query:end')
+const finishCh = channel('apm:cassandra:query:finish')
 const errorCh = channel('apm:cassandra:query:error')
 const addConnectionCh = channel(`apm:cassandra:query:addConnection`)
 
@@ -18,34 +17,34 @@ addHook({ name: 'cassandra-driver', versions: ['>=3.0.0'] }, cassandra => {
     if (!startCh.hasSubscribers) {
       return batch.apply(this, arguments)
     }
+    const callbackResource = new AsyncResource('bound-anonymous-fn')
     const asyncResource = new AsyncResource('bound-anonymous-fn')
-    startCh.publish({ keyspace: this.keyspace, query: queries })
-
     const lastIndex = arguments.length - 1
     let cb = arguments[lastIndex]
 
     if (typeof cb === 'function') {
-      cb = asyncResource.bind(cb)
-      arguments[lastIndex] = wrapCallback(asyncEndCh, errorCh, cb)
+      cb = callbackResource.bind(cb)
+      arguments[lastIndex] = wrapCallback(finishCh, errorCh, asyncResource, cb)
     }
 
-    try {
-      const res = batch.apply(this, arguments)
-      if (typeof res === 'function' || !res) {
-        return wrapCallback(asyncEndCh, errorCh, res)
-      } else {
-        const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
-        return res.then(
-          promiseAsyncResource.bind(() => finish(asyncEndCh, errorCh)),
-          promiseAsyncResource.bind(err => finish(asyncEndCh, errorCh, err))
-        )
+    return asyncResource.runInAsyncScope(() => {
+      startCh.publish({ keyspace: this.keyspace, query: queries })
+      try {
+        const res = batch.apply(this, arguments)
+        if (typeof res === 'function' || !res) {
+          return wrapCallback(finishCh, errorCh, asyncResource, res)
+        } else {
+          const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
+          return res.then(
+            promiseAsyncResource.bind(() => finish(finishCh, errorCh)),
+            promiseAsyncResource.bind(err => finish(finishCh, errorCh, err))
+          )
+        }
+      } catch (e) {
+        finish(finishCh, errorCh, e)
+        throw e
       }
-    } catch (e) {
-      finish(asyncEndCh, errorCh, e)
-      throw e
-    } finally {
-      endCh.publish(undefined)
-    }
+    })
   })
   return cassandra
 })
@@ -55,17 +54,19 @@ addHook({ name: 'cassandra-driver', versions: ['>=4.4'] }, cassandra => {
     if (!startCh.hasSubscribers) {
       return _execute.apply(this, arguments)
     }
-    startCh.publish({ keyspace: this.keyspace, query })
-    const promise = _execute.apply(this, arguments)
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    return asyncResource.runInAsyncScope(() => {
+      startCh.publish({ keyspace: this.keyspace, query })
+      const promise = _execute.apply(this, arguments)
 
-    const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
+      const promiseAsyncResource = new AsyncResource('bound-anonymous-fn')
 
-    promise.then(
-      promiseAsyncResource.bind(() => finish(asyncEndCh, errorCh)),
-      promiseAsyncResource.bind(err => finish(asyncEndCh, errorCh, err))
-    )
-    endCh.publish(undefined)
-    return promise
+      promise.then(
+        promiseAsyncResource.bind(() => finish(finishCh, errorCh)),
+        promiseAsyncResource.bind(err => finish(finishCh, errorCh, err))
+      )
+      return promise
+    })
   })
   return cassandra
 })
@@ -76,6 +77,7 @@ 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')
       const isValid = (args) => {
         return args.length === 4 || typeof args[3] === 'function'
@@ -85,24 +87,24 @@ addHook({ name: 'cassandra-driver', versions: ['3 - 4.3'] }, cassandra => {
         return _innerExecute.apply(this, arguments)
       }
 
-      startCh.publish({ keyspace: this.keyspace, query })
+      return asyncResource.runInAsyncScope(() => {
+        startCh.publish({ keyspace: this.keyspace, query })
 
-      const lastIndex = arguments.length - 1
-      let cb = arguments[lastIndex]
+        const lastIndex = arguments.length - 1
+        let cb = arguments[lastIndex]
 
-      if (typeof cb === 'function') {
-        cb = asyncResource.bind(cb)
-        arguments[lastIndex] = wrapCallback(asyncEndCh, errorCh, cb)
-      }
+        if (typeof cb === 'function') {
+          cb = callbackResource.bind(cb)
+          arguments[lastIndex] = wrapCallback(finishCh, errorCh, asyncResource, cb)
+        }
 
-      try {
-        return _innerExecute.apply(this, arguments)
-      } catch (e) {
-        finish(asyncEndCh, errorCh, e)
-        throw e
-      } finally {
-        endCh.publish(undefined)
-      }
+        try {
+          return _innerExecute.apply(this, arguments)
+        } catch (e) {
+          finish(finishCh, errorCh, e)
+          throw e
+        }
+      })
     }
   )
   return cassandra
@@ -167,16 +169,16 @@ addHook({ name: 'cassandra-driver', versions: ['3 - 3.2'], file: 'lib/request-ha
   return RequestHandler
 })
 
-function finish (asyncEndCh, errorCh, error) {
+function finish (finishCh, errorCh, error) {
   if (error) {
     errorCh.publish(error)
   }
-  asyncEndCh.publish(undefined)
+  finishCh.publish(undefined)
 }
 
-function wrapCallback (asyncEndCh, errorCh, callback) {
-  return AsyncResource.bind(function (err) {
-    finish(asyncEndCh, errorCh, err)
+function wrapCallback (finishCh, errorCh, asyncResource, callback) {
+  return asyncResource.bind(function (err) {
+    finish(finishCh, errorCh, err)
     if (callback) {
       return callback.apply(this, arguments)
     }