dd-trace 3.3.1 → 3.12.1

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

@@ -11,8 +11,8 @@ const startCh = channel('apm:redis:command:start')
 const finishCh = channel('apm:redis:command:finish')
 const errorCh = channel('apm:redis:command:error')
 
-addHook({ name: '@node-redis/client', file: 'dist/lib/client/commands-queue.js', versions: ['>=1'] }, redis => {
-  shimmer.wrap(redis.default.prototype, 'addCommand', addCommand => function (command) {
+function wrapAddCommand (addCommand) {
+  return function (command) {
     if (!startCh.hasSubscribers) {
       return addCommand.apply(this, arguments)
     }
@@ -32,7 +32,16 @@ addHook({ name: '@node-redis/client', file: 'dist/lib/client/commands-queue.js',
 
       return res
     })
-  })
+  }
+}
+
+addHook({ name: '@redis/client', file: 'dist/lib/client/commands-queue.js', versions: ['>=1.1'] }, redis => {
+  shimmer.wrap(redis.default.prototype, 'addCommand', wrapAddCommand)
+  return redis
+})
+
+addHook({ name: '@node-redis/client', file: 'dist/lib/client/commands-queue.js', versions: ['>=1'] }, redis => {
+  shimmer.wrap(redis.default.prototype, 'addCommand', wrapAddCommand)
   return redis
 })
 

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

@@ -9,6 +9,7 @@ const handleChannel = channel('apm:restify:request:handle')
 const errorChannel = channel('apm:restify:middleware:error')
 const enterChannel = channel('apm:restify:middleware:enter')
 const exitChannel = channel('apm:restify:middleware:exit')
+const finishChannel = channel('apm:restify:middleware:finish')
 const nextChannel = channel('apm:restify:middleware:next')
 
 function wrapSetupRequest (setupRequest) {
@@ -53,6 +54,9 @@ function wrapFn (fn) {
     } catch (error) {
       errorChannel.publish({ req, error })
       nextChannel.publish({ req })
+      finishChannel.publish({ req })
+      throw error
+    } finally {
       exitChannel.publish({ req })
     }
   }
@@ -61,7 +65,7 @@ function wrapFn (fn) {
 function wrapNext (req, next) {
   return function () {
     nextChannel.publish({ req })
-    exitChannel.publish({ req })
+    finishChannel.publish({ req })
 
     next.apply(this, arguments)
   }

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

@@ -11,16 +11,29 @@ const circularBufferConstructor = Symbol('circularBufferConstructor')
 const inFlightDeliveries = Symbol('inFlightDeliveries')
 
 const patched = new WeakSet()
-const dispatchCh = channel('apm:rhea:dispatch')
-const errorCh = channel('apm:rhea:error')
-const finishCh = channel('apm:rhea:finish')
+
+const startSendCh = channel('apm:rhea:send:start')
+const encodeSendCh = channel('apm:rhea:send:encode')
+const errorSendCh = channel('apm:rhea:send:error')
+const finishSendCh = channel('apm:rhea:send:finish')
+
+const startReceiveCh = channel('apm:rhea:receive:start')
+const dispatchReceiveCh = channel('apm:rhea:receive:dispatch')
+const errorReceiveCh = channel('apm:rhea:receive:error')
+const finishReceiveCh = channel('apm:rhea:receive:finish')
 
 const contexts = new WeakMap()
 
-addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/link.js' }, obj => {
-  const startSendCh = channel('apm:rhea:send:start')
-  const startReceiveCh = channel('apm:rhea:receive:start')
+addHook({ name: 'rhea', versions: ['>=1'] }, rhea => {
+  shimmer.wrap(rhea.message, 'encode', encode => function (msg) {
+    encodeSendCh.publish(msg)
+    return encode.apply(this, arguments)
+  })
 
+  return rhea
+})
+
+addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/link.js' }, obj => {
   const Sender = obj.Sender
   const Receiver = obj.Receiver
   shimmer.wrap(Sender.prototype, 'send', send => function (msg, tag, format) {
@@ -47,7 +60,7 @@ addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/link.js' }, obj => {
       try {
         return delivery
       } catch (err) {
-        errorCh.publish(err)
+        errorSendCh.publish(err)
 
         throw err
       }
@@ -76,7 +89,7 @@ addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/link.js' }, obj => {
         try {
           return dispatch.apply(this, arguments)
         } catch (err) {
-          errorCh.publish(err)
+          errorReceiveCh.publish(err)
 
           throw err
         }
@@ -100,8 +113,9 @@ addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/connection.js' }, Connecti
           if (!asyncResource) return
 
           asyncResource.runInAsyncScope(() => {
-            errorCh.publish(error)
-            finish(delivery, null)
+            errorReceiveCh.publish(error)
+            beforeFinish(delivery, null)
+            finishReceiveCh.publish()
           })
         })
       }
@@ -137,7 +151,7 @@ function wrapDeliveryUpdate (obj, update) {
     const cb = asyncResource.bind(update)
     return AsyncResource.bind(function wrappedUpdate (settled, stateData) {
       const state = getStateFromData(stateData)
-      dispatchCh.publish({ state })
+      dispatchReceiveCh.publish({ state })
       return cb.apply(this, arguments)
     })
   }
@@ -173,7 +187,8 @@ function patchCircularBuffer (proto, Session) {
                 const state = remoteState && remoteState.constructor
                   ? entry.remote_state.constructor.composite_type : undefined
                 asyncResource.runInAsyncScope(() => {
-                  return finish(entry, state)
+                  beforeFinish(entry, state)
+                  finishSendCh.publish()
                 })
               }
 
@@ -201,13 +216,12 @@ function addToInFlightDeliveries (connection, delivery) {
   deliveries.add(delivery)
 }
 
-function finish (delivery, state) {
+function beforeFinish (delivery, state) {
   const obj = contexts.get(delivery)
   if (obj) {
     if (state) {
-      dispatchCh.publish({ state })
+      dispatchReceiveCh.publish({ state })
     }
-    finishCh.publish(undefined)
     if (obj.connection && obj.connection[inFlightDeliveries]) {
       obj.connection[inFlightDeliveries].delete(delivery)
     }

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

@@ -3,11 +3,12 @@
 const METHODS = require('methods').concat('all')
 const pathToRegExp = require('path-to-regexp')
 const shimmer = require('../../datadog-shimmer')
-const { addHook, channel, AsyncResource } = require('./helpers/instrument')
+const { addHook, channel } = require('./helpers/instrument')
 
 function createWrapRouterMethod (name) {
   const enterChannel = channel(`apm:${name}:middleware:enter`)
   const exitChannel = channel(`apm:${name}:middleware:exit`)
+  const finishChannel = channel(`apm:${name}:middleware:finish`)
   const errorChannel = channel(`apm:${name}:middleware:error`)
   const nextChannel = channel(`apm:${name}:middleware:next`)
 
@@ -21,7 +22,6 @@ function createWrapRouterMethod (name) {
       if (!enterChannel.hasSubscribers) return original.apply(this, arguments)
 
       const matchers = layerMatchers.get(layer)
-      const middlewareResource = new AsyncResource('bound-anonymous-fn')
       const lastIndex = arguments.length - 1
       const name = original._name || original.name
       const req = arguments[arguments.length > 3 ? 1 : 0]
@@ -31,32 +31,32 @@ function createWrapRouterMethod (name) {
         arguments[lastIndex] = wrapNext(req, next)
       }
 
-      return middlewareResource.runInAsyncScope(() => {
-        let route
+      let route
 
-        if (matchers) {
-          // Try to guess which path actually matched
-          for (let i = 0; i < matchers.length; i++) {
-            if (matchers[i].test(layer)) {
-              route = matchers[i].path
+      if (matchers) {
+        // Try to guess which path actually matched
+        for (let i = 0; i < matchers.length; i++) {
+          if (matchers[i].test(layer)) {
+            route = matchers[i].path
 
-              break
-            }
+            break
           }
         }
+      }
 
-        enterChannel.publish({ name, req, route })
+      enterChannel.publish({ name, req, route })
 
-        try {
-          return original.apply(this, arguments)
-        } catch (error) {
-          errorChannel.publish({ req, error })
-          nextChannel.publish({ req })
-          exitChannel.publish({ req })
+      try {
+        return original.apply(this, arguments)
+      } catch (error) {
+        errorChannel.publish({ req, error })
+        nextChannel.publish({ req })
+        finishChannel.publish({ req })
 
-          throw error
-        }
-      })
+        throw error
+      } finally {
+        exitChannel.publish({ req })
+      }
     })
 
     // This is a workaround for the `loopback` library so that it can find the correct express layer
@@ -90,12 +90,12 @@ function createWrapRouterMethod (name) {
 
   function wrapNext (req, next) {
     return function (error) {
-      if (error) {
+      if (error && error !== 'route' && error !== 'router') {
         errorChannel.publish({ req, error })
       }
 
       nextChannel.publish({ req })
-      exitChannel.publish({ req })
+      finishChannel.publish({ req })
 
       next.apply(this, arguments)
     }

package/packages/datadog-plugin-amqp10/src/consumer.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const ConsumerPlugin = require('../../dd-trace/src/plugins/consumer')
+const { getAddress, getShortName } = require('./util')
+
+class Amqp10ConsumerPlugin extends ConsumerPlugin {
+  static get name () { return 'amqp10' }
+  static get system () { return 'amqp' }
+
+  start ({ link }) {
+    const source = getShortName(link)
+    const address = getAddress(link)
+
+    this.startSpan('amqp.receive', {
+      service: this.config.service || `${this.tracer._service}-amqp`,
+      resource: ['receive', source].filter(v => v).join(' '),
+      type: 'worker',
+      kind: 'consumer',
+      meta: {
+        'amqp.link.source.address': source,
+        'amqp.link.role': 'receiver',
+        'amqp.link.name': link.name,
+        'amqp.link.handle': link.handle,
+        'amqp.connection.host': address.host,
+        'amqp.connection.port': address.port,
+        'amqp.connection.user': address.user
+      }
+    })
+  }
+}
+
+module.exports = Amqp10ConsumerPlugin

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

@@ -1,107 +1,17 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class Amqp10Plugin extends Plugin {
-  static get name () {
-    return 'amqp10'
+const ProducerPlugin = require('./producer')
+const ConsumerPlugin = require('./consumer')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+
+class Amqp10Plugin extends CompositePlugin {
+  static get name () { return 'amqp10' }
+  static get plugins () {
+    return {
+      producer: ProducerPlugin,
+      consumer: ConsumerPlugin
+    }
   }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:amqp10:send:start`, ({ link }) => {
-      const address = getAddress(link)
-      const target = getShortName(link)
-
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-
-      const span = this.tracer.startSpan('amqp.send', {
-        childOf,
-        tags: {
-          'resource.name': ['send', target].filter(v => v).join(' '),
-          'span.kind': 'producer',
-          'amqp.link.target.address': target,
-          'amqp.link.role': 'sender',
-          'out.host': address.host,
-          'out.port': address.port,
-          'service.name': this.config.service || `${this.tracer._service}-amqp`,
-          'amqp.link.name': link.name,
-          'amqp.link.handle': link.handle,
-          'amqp.connection.host': address.host,
-          'amqp.connection.port': address.port,
-          'amqp.connection.user': address.user
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:amqp10:send:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-
-    this.addSub(`apm:amqp10:send:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
-    })
-
-    this.addSub(`apm:amqp10:receive:start`, ({ link }) => {
-      const source = getShortName(link)
-      const address = getAddress(link)
-
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-
-      const span = this.tracer.startSpan('amqp.receive', {
-        childOf,
-        tags: {
-          'resource.name': ['receive', source].filter(v => v).join(' '),
-          'span.kind': 'consumer',
-          'span.type': 'worker',
-          'amqp.link.source.address': source,
-          'amqp.link.role': 'receiver',
-          'service.name': this.config.service || `${this.tracer._service}-amqp`,
-          'amqp.link.name': link.name,
-          'amqp.link.handle': link.handle,
-          'amqp.connection.host': address.host,
-          'amqp.connection.port': address.port,
-          'amqp.connection.user': address.user
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:amqp10:receive:finish`, () => {
-      storage.getStore().span.finish()
-    })
-
-    this.addSub(`apm:amqp10:receive:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-  }
-}
-
-function getShortName (link) {
-  if (!link || !link.name) return null
-
-  return link.name.split('_').slice(0, -1).join('_')
-}
-
-function getAddress (link) {
-  if (!link || !link.session || !link.session.connection) return {}
-
-  return link.session.connection.address || {}
 }
 
 module.exports = Amqp10Plugin

package/packages/datadog-plugin-amqp10/src/producer.js

@@ -0,0 +1,34 @@
+'use strict'
+
+const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
+const { getAddress, getShortName } = require('./util')
+
+class Amqp10ProducerPlugin extends ProducerPlugin {
+  static get name () { return 'amqp10' }
+  static get operation () { return 'send' }
+  static get system () { return 'amqp' }
+
+  start ({ link }) {
+    const address = getAddress(link)
+    const target = getShortName(link)
+
+    this.startSpan('amqp.send', {
+      service: this.config.service || `${this.tracer._service}-amqp`,
+      resource: ['send', target].filter(v => v).join(' '),
+      kind: 'producer',
+      meta: {
+        'amqp.link.target.address': target,
+        'amqp.link.role': 'sender',
+        'out.host': address.host,
+        'out.port': address.port,
+        'amqp.link.name': link.name,
+        'amqp.link.handle': link.handle,
+        'amqp.connection.host': address.host,
+        'amqp.connection.port': address.port,
+        'amqp.connection.user': address.user
+      }
+    })
+  }
+}
+
+module.exports = Amqp10ProducerPlugin

package/packages/datadog-plugin-amqp10/src/util.js

@@ -0,0 +1,15 @@
+'use strict'
+
+function getAddress (link) {
+  if (!link || !link.session || !link.session.connection) return {}
+
+  return link.session.connection.address || {}
+}
+
+function getShortName (link) {
+  if (!link || !link.name) return null
+
+  return link.name.split('_').slice(0, -1).join('_')
+}
+
+module.exports = { getAddress, getShortName }

package/packages/datadog-plugin-amqplib/src/client.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const { TEXT_MAP } = require('../../../ext/formats')
+const ClientPlugin = require('../../dd-trace/src/plugins/client')
+const { getResourceName } = require('./util')
+
+class AmqplibClientPlugin extends ClientPlugin {
+  static get name () { return 'amqplib' }
+  static get operation () { return 'command' }
+
+  start ({ channel = {}, method, fields }) {
+    if (method === 'basic.deliver' || method === 'basic.get') return
+    if (method === 'basic.publish') return
+
+    const stream = (channel.connection && channel.connection.stream) || {}
+    const span = this.startSpan('amqp.command', {
+      service: this.config.service || `${this.tracer._service}-amqp`,
+      resource: getResourceName(method, fields),
+      kind: 'client',
+      meta: {
+        'out.host': stream._host,
+        'out.port': stream.remotePort,
+        'amqp.queue': fields.queue,
+        'amqp.exchange': fields.exchange,
+        'amqp.routingKey': fields.routingKey,
+        'amqp.consumerTag': fields.consumerTag,
+        'amqp.source': fields.source,
+        'amqp.destination': fields.destination
+      }
+    })
+
+    fields.headers = fields.headers || {}
+
+    this.tracer.inject(span, TEXT_MAP, fields.headers)
+  }
+}
+
+module.exports = AmqplibClientPlugin

package/packages/datadog-plugin-amqplib/src/consumer.js

@@ -0,0 +1,40 @@
+'use strict'
+
+const { TEXT_MAP } = require('../../../ext/formats')
+const ConsumerPlugin = require('../../dd-trace/src/plugins/consumer')
+const { getResourceName } = require('./util')
+
+class AmqplibConsumerPlugin extends ConsumerPlugin {
+  static get name () { return 'amqplib' }
+  static get operation () { return 'command' }
+
+  start ({ method, fields, message }) {
+    if (method !== 'basic.deliver' && method !== 'basic.get') return
+
+    const childOf = extract(this.tracer, message)
+
+    this.startSpan('amqp.command', {
+      childOf,
+      service: this.config.service || `${this.tracer._service}-amqp`,
+      resource: getResourceName(method, fields),
+      kind: 'consumer',
+      type: 'worker',
+      meta: {
+        'amqp.queue': fields.queue,
+        'amqp.exchange': fields.exchange,
+        'amqp.routingKey': fields.routingKey,
+        'amqp.consumerTag': fields.consumerTag,
+        'amqp.source': fields.source,
+        'amqp.destination': fields.destination
+      }
+    })
+  }
+}
+
+function extract (tracer, message) {
+  return message
+    ? tracer.extract(TEXT_MAP, message.properties.headers)
+    : null
+}
+
+module.exports = AmqplibConsumerPlugin

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

@@ -1,108 +1,20 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const { TEXT_MAP } = require('../../../ext/formats')
-
-class AmqplibPlugin extends Plugin {
-  static get name () {
-    return 'amqplib'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:amqplib:command:start`, ({ channel, method, fields, message }) => {
-      const store = storage.getStore()
-      let childOf
-
-      if (method === 'basic.deliver') {
-        childOf = extract(this.tracer, message)
-      } else {
-        fields.headers = fields.headers || {}
-        childOf = store ? store.span : store
-      }
-
-      const span = this.tracer.startSpan('amqp.command', {
-        childOf,
-        tags: {
-          'service.name': this.config.service || `${this.tracer._service}-amqp`,
-          'resource.name': getResourceName(method, fields)
-        }
-      })
-
-      if (channel && channel.connection && channel.connection.stream) {
-        span.addTags({
-          'out.host': channel.connection.stream._host,
-          'out.port': channel.connection.stream.remotePort
-        })
-      }
-      const fieldNames = [
-        'queue',
-        'exchange',
-        'routingKey',
-        'consumerTag',
-        'source',
-        'destination'
-      ]
-
-      switch (method) {
-        case 'basic.publish':
-          span.setTag('span.kind', 'producer')
-          break
-        case 'basic.consume':
-        case 'basic.get':
-        case 'basic.deliver':
-          span.addTags({
-            'span.kind': 'consumer',
-            'span.type': 'worker'
-          })
-          break
-        default:
-          span.setTag('span.kind', 'client')
-      }
-
-      fieldNames.forEach(field => {
-        fields[field] !== undefined && span.setTag(`amqp.${field}`, fields[field])
-      })
-      if (method === 'basic.deliver') {
-        analyticsSampler.sample(span, this.config.measured, true)
-      } else {
-        this.tracer.inject(span, TEXT_MAP, fields.headers)
-        analyticsSampler.sample(span, this.config.measured)
-      }
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:amqplib:command:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
-    })
-
-    this.addSub(`apm:amqplib:command:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
+const ProducerPlugin = require('./producer')
+const ConsumerPlugin = require('./consumer')
+const ClientPlugin = require('./client')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+
+// TODO: Consider splitting channels for publish/receive in the instrumentation.
+class AmqplibPlugin extends CompositePlugin {
+  static get name () { return 'amqplib' }
+  static get plugins () {
+    return {
+      producer: ProducerPlugin,
+      consumer: ConsumerPlugin,
+      client: ClientPlugin
+    }
   }
 }
 
-function getResourceName (method, fields = {}) {
-  return [
-    method,
-    fields.exchange,
-    fields.routingKey,
-    fields.queue,
-    fields.source,
-    fields.destination
-  ].filter(val => val).join(' ')
-}
-
-function extract (tracer, message) {
-  return message
-    ? tracer.extract(TEXT_MAP, message.properties.headers)
-    : null
-}
-
 module.exports = AmqplibPlugin