dd-trace 2.12.0 → 2.13.0

package/LICENSE-3rdparty.csv

@@ -18,7 +18,6 @@ require,methods,MIT,Copyright 2013-2014 TJ Holowaychuk
 require,module-details-from-path,MIT,Copyright 2016 Thomas Watson Steen
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc
 require,path-to-regexp,MIT,Copyright 2014 Blake Embrey
-require,performance-now,MIT,Copyright 2013 Braveg1rl
 require,retry,MIT,Copyright 2011 Tim Koschützki Felix Geisendörfer
 require,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,autocannon,MIT,Copyright 2016 Matteo Collina

package/ext/formats.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const opentracing = require('opentracing')
-
 module.exports = {
-  TEXT_MAP: opentracing.FORMAT_TEXT_MAP,
-  HTTP_HEADERS: opentracing.FORMAT_HTTP_HEADERS,
-  BINARY: opentracing.FORMAT_BINARY,
+  TEXT_MAP: 'text_map',
+  HTTP_HEADERS: 'http_headers',
+  BINARY: 'binary',
   LOG: 'log'
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -59,9 +59,9 @@
   },
   "dependencies": {
     "@datadog/native-appsec": "^1.2.1",
-    "@datadog/native-metrics": "^1.4.1",
-    "@datadog/pprof": "^1.0.0",
-    "@datadog/sketches-js": "^1.0.5",
+    "@datadog/native-metrics": "^1.4.2",
+    "@datadog/pprof": "^1.0.2",
+    "@datadog/sketches-js": "^2.0.0",
     "@types/node": ">=12",
     "crypto-randomuuid": "^1.0.0",
     "diagnostics_channel": "^1.1.0",
@@ -77,7 +77,6 @@
     "module-details-from-path": "^1.0.3",
     "opentracing": ">=0.12.1",
     "path-to-regexp": "^0.1.2",
-    "performance-now": "^2.1.0",
     "retry": "^0.10.1",
     "semver": "^5.5.0"
   },

package/packages/datadog-instrumentations/index.js

@@ -1,54 +1,3 @@
 'use strict'
 
-require('./src/amqplib')
-require('./src/amqp10')
-require('./src/aws-sdk')
-require('./src/bluebird')
-require('./src/bunyan')
-require('./src/cassandra-driver')
-require('./src/connect')
-require('./src/couchbase')
-require('./src/cucumber')
-require('./src/dns')
-require('./src/elasticsearch')
-require('./src/express')
-require('./src/fastify')
-require('./src/find-my-way')
-require('./src/generic-pool')
-require('./src/google-cloud-pubsub')
-require('./src/graphql')
-require('./src/grpc')
-require('./src/hapi')
-require('./src/http')
-require('./src/http2')
-require('./src/ioredis')
-require('./src/jest')
-require('./src/kafkajs')
-require('./src/knex')
-require('./src/koa')
-require('./src/memcached')
-require('./src/microgateway-core')
-require('./src/moleculer')
-require('./src/mongodb-core')
-require('./src/mongoose')
-require('./src/mysql')
-require('./src/mysql2')
-require('./src/mocha')
-require('./src/net')
-require('./src/next')
-require('./src/oracledb')
-require('./src/paperplane')
-require('./src/pino')
-require('./src/pg')
-require('./src/promise')
-require('./src/promise-js')
-require('./src/q')
-require('./src/redis')
-require('./src/restify')
-require('./src/router')
-require('./src/rhea')
-require('./src/sharedb')
-require('./src/tedious')
-require('./src/when')
-require('./src/winston')
-require('./src/limitd-client')
+require('./src/helpers/register')

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

@@ -78,12 +78,12 @@ function wrapLayerHandle (layer) {
 
       try {
         return original.apply(this, arguments)
-      } catch (e) {
-        errorChannel.publish(e)
+      } catch (error) {
+        errorChannel.publish({ req, error })
         nextChannel.publish({ req })
         exitChannel.publish({ req })
 
-        throw e
+        throw error
       }
     })
   })
@@ -92,13 +92,13 @@ function wrapLayerHandle (layer) {
 function wrapNext (req, next) {
   return function (error) {
     if (error) {
-      errorChannel.publish(error)
+      errorChannel.publish({ req, error })
     }
 
     nextChannel.publish({ req })
     exitChannel.publish({ req })
 
-    next.apply(null, arguments)
+    next.apply(this, arguments)
   }
 }
 

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

@@ -6,7 +6,6 @@ const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const errorChannel = channel('apm:fastify:middleware:error')
 const handleChannel = channel('apm:fastify:request:handle')
 
-const requestResources = new WeakMap()
 const parsingResources = new WeakMap()
 
 function wrapFastify (fastify, hasParsingEvents) {
@@ -42,16 +41,13 @@ function wrapAddHook (addHook) {
 
     arguments[arguments.length - 1] = shimmer.wrap(fn, function (request, reply, done) {
       const req = getReq(request)
-      const requestResource = requestResources.get(req)
-
-      if (!requestResource) return fn.apply(this, arguments)
 
       try {
         if (typeof done === 'function') {
           done = arguments[arguments.length - 1]
 
           arguments[arguments.length - 1] = function (err) {
-            publishError(err, requestResource)
+            publishError(err, req)
 
             if (name === 'onRequest' || name === 'preParsing') {
               const parsingResource = new AsyncResource('bound-anonymous-fn')
@@ -71,13 +67,13 @@ function wrapAddHook (addHook) {
           const promise = fn.apply(this, arguments)
 
           if (promise && typeof promise.catch === 'function') {
-            return promise.catch(err => publishError(err, requestResource))
+            return promise.catch(err => publishError(err, req))
           }
 
           return promise
         }
       } catch (e) {
-        throw publishError(e, requestResource)
+        throw publishError(e, req)
       }
     })
 
@@ -90,14 +86,10 @@ function onRequest (request, reply, done) {
 
   const req = getReq(request)
   const res = getRes(reply)
-  const requestResource = new AsyncResource('bound-anonymous-fn')
 
-  requestResources.set(req, requestResource)
+  handleChannel.publish({ req, res })
 
-  return requestResource.runInAsyncScope(() => {
-    handleChannel.publish({ req, res })
-    return done()
-  })
+  return done()
 }
 
 function preHandler (request, reply, done) {
@@ -105,9 +97,8 @@ function preHandler (request, reply, done) {
   if (!reply || typeof reply.send !== 'function') return done()
 
   const req = getReq(request)
-  const requestResource = requestResources.get(req)
 
-  reply.send = wrapSend(reply.send, requestResource)
+  reply.send = wrapSend(reply.send, req)
 
   done()
 }
@@ -133,12 +124,10 @@ function preParsing (request, reply, payload, done) {
   parsingResource.runInAsyncScope(() => done())
 }
 
-function wrapSend (send, resource) {
-  return function sendWithTrace (payload) {
-    if (payload instanceof Error) {
-      resource.runInAsyncScope(() => {
-        errorChannel.publish(payload)
-      })
+function wrapSend (send, req) {
+  return function sendWithTrace (error) {
+    if (error instanceof Error) {
+      errorChannel.publish({ req, error })
     }
 
     return send.apply(this, arguments)
@@ -153,11 +142,9 @@ function getRes (reply) {
   return reply && (reply.raw || reply.res || reply)
 }
 
-function publishError (error, resource) {
+function publishError (error, req) {
   if (error) {
-    resource.runInAsyncScope(() => {
-      errorChannel.publish(error)
-    })
+    errorChannel.publish({ error, req })
   }
 
   return error

package/packages/datadog-instrumentations/src/helpers/hooks.js

@@ -0,0 +1,68 @@
+'use strict'
+
+module.exports = {
+  '@cucumber/cucumber': () => require('../cucumber'),
+  '@elastic/elasticsearch': () => require('../elasticsearch'),
+  '@elastic/transport': () => require('../elasticsearch'),
+  '@google-cloud/pubsub': () => require('../google-cloud-pubsub'),
+  '@grpc/grpc-js': () => require('../grpc'),
+  '@hapi/hapi': () => require('../hapi'),
+  '@koa/router': () => require('../koa'),
+  '@node-redis/client': () => require('../redis'),
+  'amqp10': () => require('../amqp10'),
+  'amqplib': () => require('../amqplib'),
+  'aws-sdk': () => require('../aws-sdk'),
+  'bluebird': () => require('../bluebird'),
+  'bunyan': () => require('../bunyan'),
+  'cassandra-driver': () => require('../cassandra-driver'),
+  'connect': () => require('../connect'),
+  'couchbase': () => require('../couchbase'),
+  'cypress': () => require('../cypress'),
+  'dns': () => require('../dns'),
+  'elasticsearch': () => require('../elasticsearch'),
+  'express': () => require('../express'),
+  'fastify': () => require('../fastify'),
+  'find-my-way': () => require('../find-my-way'),
+  'graphql': () => require('../graphql'),
+  'grpc': () => require('../grpc'),
+  'hapi': () => require('../hapi'),
+  'http': () => require('../http'),
+  'http2': () => require('../http2'),
+  'https': () => require('../http'),
+  'ioredis': () => require('../ioredis'),
+  'jest-environment-node': () => require('../jest'),
+  'jest-environment-jsdom': () => require('../jest'),
+  'jest-jasmine2': () => require('../jest'),
+  'koa': () => require('../koa'),
+  'koa-router': () => require('../koa'),
+  'kafkajs': () => require('../kafkajs'),
+  'limitd-client': () => require('../limitd-client'),
+  'memcached': () => require('../memcached'),
+  'microgateway-core': () => require('../microgateway-core'),
+  'mocha': () => require('../mocha'),
+  'mocha-each': () => require('../mocha'),
+  'moleculer': () => require('../moleculer'),
+  'mongodb': () => require('../mongodb-core'),
+  'mongodb-core': () => require('../mongodb-core'),
+  'mongoose': () => require('../mongoose'),
+  'mysql': () => require('../mysql'),
+  'mysql2': () => require('../mysql2'),
+  'net': () => require('../net'),
+  'next': () => require('../next'),
+  'oracledb': () => require('../oracledb'),
+  'paperplane': () => require('../paperplane'),
+  'pg': () => require('../pg'),
+  'pino': () => require('../pino'),
+  'pino-pretty': () => require('../pino'),
+  'promise-js': () => require('../promise-js'),
+  'promise': () => require('../promise'),
+  'q': () => require('../q'),
+  'redis': () => require('../redis'),
+  'restify': () => require('../restify'),
+  'rhea': () => require('../rhea'),
+  'router': () => require('../router'),
+  'sharedb': () => require('../sharedb'),
+  'tedious': () => require('../tedious'),
+  'when': () => require('../when'),
+  'winston': () => require('../winston')
+}

package/packages/datadog-instrumentations/src/helpers/instrument.js

@@ -1,16 +1,12 @@
 'use strict'
 
 const dc = require('diagnostics_channel')
-const path = require('path')
 const semver = require('semver')
-const Hook = require('./hook')
-const requirePackageJson = require('../../../dd-trace/src/require-package-json')
+const instrumentations = require('./instrumentations')
 const { AsyncResource } = require('async_hooks')
-const log = require('../../../dd-trace/src/log')
 
-const pathSepExpr = new RegExp(`\\${path.sep}`, 'g')
 const channelMap = {}
-exports.channel = function channel (name) {
+exports.channel = function (name) {
   const maybe = channelMap[name]
   if (maybe) return maybe
   const ch = dc.channel(name)
@@ -19,36 +15,11 @@ exports.channel = function channel (name) {
 }
 
 exports.addHook = function addHook ({ name, versions, file }, hook) {
-  const fullFilename = filename(name, file)
-
-  Hook([name], (moduleExports, moduleName, moduleBaseDir) => {
-    moduleName = moduleName.replace(pathSepExpr, '/')
-
-    if (moduleName !== fullFilename || !matchVersion(getVersion(moduleBaseDir), versions)) {
-      return moduleExports
-    }
-
-    try {
-      return hook(moduleExports)
-    } catch (e) {
-      log.error(e)
-      return moduleExports
-    }
-  })
-}
-
-function matchVersion (version, ranges) {
-  return !version || (ranges && ranges.some(range => semver.satisfies(semver.coerce(version), range)))
-}
-
-function getVersion (moduleBaseDir) {
-  if (moduleBaseDir) {
-    return requirePackageJson(moduleBaseDir, module).version
+  if (!instrumentations[name]) {
+    instrumentations[name] = []
   }
-}
 
-function filename (name, file) {
-  return [name, file].filter(val => val).join('/')
+  instrumentations[name].push({ name, versions, file, hook })
 }
 
 // AsyncResource.bind exists and binds `this` properly only from 17.8.0 and up.

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

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = {}

package/packages/datadog-instrumentations/src/helpers/register.js

@@ -0,0 +1,59 @@
+'use strict'
+
+const { channel } = require('diagnostics_channel')
+const path = require('path')
+const semver = require('semver')
+const Hook = require('./hook')
+const requirePackageJson = require('../../../dd-trace/src/require-package-json')
+const log = require('../../../dd-trace/src/log')
+
+const hooks = require('./hooks')
+const instrumentations = require('./instrumentations')
+const names = Object.keys(hooks)
+const pathSepExpr = new RegExp(`\\${path.sep}`, 'g')
+
+const loadChannel = channel('dd-trace:instrumentation:load')
+
+// TODO: make this more efficient
+
+for (const packageName of names) {
+  Hook([packageName], (moduleExports, moduleName, moduleBaseDir) => {
+    moduleName = moduleName.replace(pathSepExpr, '/')
+
+    hooks[packageName]()
+
+    for (const { name, file, versions, hook } of instrumentations[packageName]) {
+      const fullFilename = filename(name, file)
+
+      if (moduleName === fullFilename) {
+        const version = getVersion(moduleBaseDir)
+
+        if (matchVersion(version, versions)) {
+          try {
+            loadChannel.publish({ name, version, file })
+
+            moduleExports = hook(moduleExports)
+          } catch (e) {
+            log.error(e)
+          }
+        }
+      }
+    }
+
+    return moduleExports
+  })
+}
+
+function matchVersion (version, ranges) {
+  return !version || (ranges && ranges.some(range => semver.satisfies(semver.coerce(version), range)))
+}
+
+function getVersion (moduleBaseDir) {
+  if (moduleBaseDir) {
+    return requirePackageJson(moduleBaseDir, module).version
+  }
+}
+
+function filename (name, file) {
+  return [name, file].filter(val => val).join('/')
+}

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

@@ -126,13 +126,13 @@ function wrapMiddleware (fn, layer) {
 }
 
 function fulfill (ctx, error) {
-  if (error) {
-    errorChannel.publish(error)
-  }
-
   const req = ctx.req
   const route = ctx.routePath
 
+  if (error) {
+    errorChannel.publish({ req, error })
+  }
+
   // TODO: make sure that the parent class cannot override this in `enter`
   if (route) {
     routeChannel.publish({ req, route })
@@ -145,7 +145,7 @@ function wrapNext (req, next) {
   return function () {
     nextChannel.publish({ req })
 
-    return next.apply(null, arguments)
+    return next.apply(this, arguments)
   }
 }
 

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

@@ -153,7 +153,10 @@ function mochaHook (Runner) {
       if (isHook && testOrHook.ctx) {
         test = testOrHook.ctx.currentTest
       }
-      const asyncResource = getTestAsyncResource(test)
+      let asyncResource
+      if (test) {
+        asyncResource = getTestAsyncResource(test)
+      }
       if (asyncResource) {
         asyncResource.runInAsyncScope(() => {
           if (isHook) {

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

@@ -6,7 +6,10 @@ const handlers = ['use', 'pre']
 const methods = ['del', 'get', 'head', 'opts', 'post', 'put', 'patch']
 
 const handleChannel = channel('apm:restify:request:handle')
-const routeChannel = channel('apm:restify:request:route')
+const errorChannel = channel('apm:restify:middleware:error')
+const enterChannel = channel('apm:restify:middleware:enter')
+const exitChannel = channel('apm:restify:middleware:exit')
+const nextChannel = channel('apm:restify:middleware:next')
 
 function wrapSetupRequest (setupRequest) {
   return function (req, res) {
@@ -37,18 +40,37 @@ function wrapFn (fn) {
   if (Array.isArray(fn)) return wrapMiddleware(fn)
 
   return function (req, res, next) {
-    if (req.route) {
-      routeChannel.publish({ req, route: req.route })
+    if (typeof next === 'function') {
+      arguments[2] = wrapNext(req, next)
     }
 
-    return fn.apply(this, arguments)
+    const route = req.route && req.route.path
+
+    enterChannel.publish({ req, route })
+
+    try {
+      return fn.apply(this, arguments)
+    } catch (error) {
+      errorChannel.publish({ req, error })
+      nextChannel.publish({ req })
+      exitChannel.publish({ req })
+    }
+  }
+}
+
+function wrapNext (req, next) {
+  return function () {
+    nextChannel.publish({ req })
+    exitChannel.publish({ req })
+
+    next.apply(this, arguments)
   }
 }
 
 addHook({ name: 'restify', versions: ['>=3'], file: 'lib/server.js' }, Server => {
   shimmer.wrap(Server.prototype, '_setupRequest', wrapSetupRequest)
   shimmer.massWrap(Server.prototype, handlers, wrapHandler)
-  shimmer.wrap(Server.prototype, methods, wrapMethod)
+  shimmer.massWrap(Server.prototype, methods, wrapMethod)
 
   return Server
 })

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

@@ -49,12 +49,12 @@ function createWrapRouterMethod (name) {
 
         try {
           return original.apply(this, arguments)
-        } catch (e) {
-          errorChannel.publish(e)
+        } catch (error) {
+          errorChannel.publish({ req, error })
           nextChannel.publish({ req })
           exitChannel.publish({ req })
 
-          throw e
+          throw error
         }
       })
     })
@@ -91,13 +91,13 @@ function createWrapRouterMethod (name) {
   function wrapNext (req, next) {
     return function (error) {
       if (error) {
-        errorChannel.publish(error)
+        errorChannel.publish({ req, error })
       }
 
       nextChannel.publish({ req })
       exitChannel.publish({ req })
 
-      next.apply(null, arguments)
+      next.apply(this, arguments)
     }
   }
 

package/packages/datadog-plugin-aws-sdk/src/base.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const Tags = require('opentracing').Tags
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
 const Plugin = require('../../dd-trace/src/plugins/plugin')
 const { storage } = require('../../datadog-core')
@@ -33,7 +32,7 @@ class BaseAwsSdkPlugin extends Plugin {
       const serviceName = this.getServiceName(serviceIdentifier)
       const childOf = this.tracer.scope().active()
       const tags = {
-        [Tags.SPAN_KIND]: 'client',
+        'span.kind': 'client',
         'service.name': serviceName,
         'aws.operation': operation,
         'aws.region': awsRegion,

package/packages/datadog-plugin-aws-sdk/src/services/sqs.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const Tags = require('opentracing').Tags
 const log = require('../../../dd-trace/src/log')
 const BaseAwsSdkPlugin = require('../base')
 const { storage } = require('../../../datadog-core')
@@ -25,7 +24,7 @@ class Sqs extends BaseAwsSdkPlugin {
           tags: Object.assign(
             {},
             this.requestTags.get(request) || {},
-            { [Tags.SPAN_KIND]: 'server' }
+            { 'span.kind': 'server' }
           )
         }
         const span = plugin.tracer.startSpan('aws.response', options)

package/packages/datadog-plugin-mocha/src/index.js

@@ -161,12 +161,12 @@ class MochaPlugin extends Plugin {
     const testSuiteSpan = this._testSuites.get(test.parent)
 
     if (testSuiteSpan) {
-      const testSuiteId = testSuiteSpan.context()._spanId.toString('hex')
+      const testSuiteId = testSuiteSpan.context()._spanId.toString(16)
       testSuiteTags[TEST_SUITE_ID] = testSuiteId
     }
 
     if (this.testSessionSpan) {
-      const testSessionId = this.testSessionSpan.context()._traceId.toString('hex')
+      const testSessionId = this.testSessionSpan.context()._traceId.toString(16)
       testSuiteTags[TEST_SESSION_ID] = testSessionId
       testSuiteTags[TEST_COMMAND] = this.command
     }

package/packages/datadog-plugin-restify/src/index.js

@@ -19,6 +19,13 @@ class RestifyPlugin extends RouterPlugin {
       web.setRoute(req, route)
     })
   }
+
+  configure (config) {
+    return super.configure({
+      ...config,
+      middleware: false // not supported
+    })
+  }
 }
 
 module.exports = RestifyPlugin

package/packages/datadog-plugin-router/src/index.js

@@ -16,7 +16,10 @@ class RouterPlugin extends WebPlugin {
     this._contexts = new WeakMap()
 
     this.addSub(`apm:${this.constructor.name}:middleware:enter`, ({ req, name, route }) => {
-      const childOf = this._getActive(req)
+      const childOf = this._getActive(req) || this._getStoreSpan()
+
+      if (!childOf) return
+
       const span = this._getMiddlewareSpan(name, childOf)
       const context = this._createContext(req, route, childOf)
 
@@ -46,14 +49,16 @@ class RouterPlugin extends WebPlugin {
       context.middleware.pop().finish()
     })
 
-    this.addSub(`apm:${this.constructor.name}:middleware:error`, err => {
-      const store = storage.getStore()
+    this.addSub(`apm:${this.constructor.name}:middleware:error`, ({ req, error }) => {
+      web.addError(req, error)
 
-      web.addError(store.req, err)
+      if (!this.config.middleware) return
 
-      if (this.config.middleware) {
-        this.addError(err)
-      }
+      const span = this._getActive(req)
+
+      if (!span) return
+
+      span.setTag('error', error)
     })
 
     this.addSub(`apm:http:server:request:finish`, ({ req }) => {
@@ -72,7 +77,7 @@ class RouterPlugin extends WebPlugin {
   _getActive (req) {
     const context = this._contexts.get(req)
 
-    if (!context) return this._getStoreSpan()
+    if (!context) return
     if (context.middleware.length === 0) return context.span
 
     return context.middleware[context.middleware.length - 1]