dd-trace 2.7.0 → 2.9.0

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

@@ -1,118 +1,28 @@
 'use strict'
 
-const Tags = require('opentracing').Tags
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const awsHelpers = require('./helpers')
+const Plugin = require('../../dd-trace/src/plugins/plugin')
 
-function createWrapRequest (tracer, config) {
-  config = normalizeConfig(config)
-  return function wrapRequest (send) {
-    return function requestWithTrace (cb) {
-      if (!this.service) return send.apply(this, arguments)
+const services = require('./services')
 
-      const serviceIdentifier = this.service.serviceIdentifier
-
-      if (!awsHelpers.isEnabled(serviceIdentifier, config[serviceIdentifier], this)) {
-        return send.apply(this, arguments)
-      }
-
-      const serviceName = getServiceName(serviceIdentifier, tracer, config)
-      const childOf = tracer.scope().active()
-      const tags = {
-        [Tags.SPAN_KIND]: 'client',
-        'service.name': serviceName,
-        'aws.operation': this.operation,
-        'aws.region': this.service.config && this.service.config.region,
-        'aws.service': this.service.api && this.service.api.className,
-        'component': 'aws-sdk'
-      }
-
-      const span = tracer.startSpan('aws.request', {
-        childOf,
-        tags
-      })
-
-      this.on('complete', response => {
-        if (!span) return
-
-        awsHelpers.addResponseTags(span, response, serviceIdentifier, config, tracer)
-        awsHelpers.finish(config, span, response, response.error)
-      })
-
-      analyticsSampler.sample(span, config.measured)
-
-      awsHelpers.requestInject(span, this, serviceIdentifier, tracer)
-
-      const request = this
+class AwsSdkPlugin extends Plugin {
+  static get name () {
+    return 'aws-sdk'
+  }
 
-      return tracer.scope().activate(span, () => {
-        if (typeof cb === 'function') {
-          arguments[0] = awsHelpers.wrapCb(cb, serviceIdentifier, tags, request, tracer, childOf)
-        }
-        return send.apply(this, arguments)
-      })
+  constructor (...args) {
+    super(...args)
+    this.services = {}
+    for (const name in services) {
+      const ServicePlugin = services[name]
+      this.services[name] = new ServicePlugin(...args)
     }
   }
-}
-
-function createWrapSetPromisesDependency (tracer, config, instrumenter, AWS) {
-  return function wrapSetPromisesDependency (setPromisesDependency) {
-    return function setPromisesDependencyWithTrace (dep) {
-      const result = setPromisesDependency.apply(this, arguments)
-
-      instrumenter.wrap(AWS.Request.prototype, 'promise', createWrapRequest(tracer, config))
 
-      return result
+  configure (config) {
+    for (const service of Object.values(this.services)) {
+      service.configure(config)
     }
   }
 }
 
-function normalizeConfig (config) {
-  const hooks = getHooks(config)
-
-  return Object.assign({}, config, {
-    splitByAwsService: config.splitByAwsService !== false,
-    hooks
-  })
-}
-
-function getHooks (config) {
-  const noop = () => {}
-  const request = (config.hooks && config.hooks.request) || noop
-
-  return { request }
-}
-
-// TODO: test splitByAwsService when the test suite is fixed
-function getServiceName (serviceIdentifier, tracer, config) {
-  return config.service
-    ? config.service
-    : `${tracer._service}-aws-${serviceIdentifier}`
-}
-
-// <2.1.35 has breaking changes for instrumentation
-// https://github.com/aws/aws-sdk-js/pull/629
-module.exports = [
-  {
-    name: 'aws-sdk',
-    versions: ['>=2.3.0'],
-    patch (AWS, tracer, config) {
-      this.wrap(AWS.Request.prototype, 'promise', createWrapRequest(tracer, config))
-      this.wrap(AWS.config, 'setPromisesDependency', createWrapSetPromisesDependency(tracer, config, this, AWS))
-    },
-    unpatch (AWS) {
-      this.unwrap(AWS.Request.prototype, 'promise')
-      this.unwrap(AWS.config, 'setPromisesDependency')
-    }
-  },
-  {
-    name: 'aws-sdk',
-    versions: ['>=2.1.35'],
-    patch (AWS, tracer, config) {
-      this.wrap(AWS.Request.prototype, 'send', createWrapRequest(tracer, config))
-    },
-    unpatch (AWS) {
-      this.unwrap(AWS.Request.prototype, 'send')
-    }
-  }
-]
+module.exports = AwsSdkPlugin

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

@@ -1,7 +1,9 @@
 'use strict'
 
-class CloudwatchLogs {
-  generateTags (params, operation, response) {
+const BaseAwsSdkPlugin = require('../base')
+
+class CloudwatchLogs extends BaseAwsSdkPlugin {
+  generateTags (params, operation) {
     const tags = {}
 
     if (!params || !params.logGroupName) return tags

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

@@ -0,0 +1,7 @@
+'use strict'
+
+const BaseAwsSdkPlugin = require('../base')
+
+class Default extends BaseAwsSdkPlugin {}
+
+module.exports = Default

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

@@ -1,6 +1,8 @@
 'use strict'
 
-class DynamoDb {
+const BaseAwsSdkPlugin = require('../base')
+
+class DynamoDb extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     const tags = {}
 

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

@@ -1,6 +1,8 @@
 'use strict'
 const log = require('../../../dd-trace/src/log')
-class EventBridge {
+const BaseAwsSdkPlugin = require('../base')
+
+class EventBridge extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     if (!params || !params.source) return {}
 
@@ -14,14 +16,13 @@ class EventBridge {
    * requestInject
    * @param {*} span
    * @param {*} request
-   * @param {*} tracer
    *
    * Docs: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html
    * We cannot use the traceHeader field as that's reserved for X-Ray.
    * Detail must be a valid JSON string
    * Max size per event is 256kb (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html)
    */
-  requestInject (span, request, tracer) {
+  requestInject (span, request) {
     const operation = request.operation
     if (operation === 'putEvents' &&
       request.params &&
@@ -31,7 +32,7 @@ class EventBridge {
       try {
         const details = JSON.parse(request.params.Entries[0].Detail)
         details._datadog = {}
-        tracer.inject(span, 'text_map', details._datadog)
+        this.tracer.inject(span, 'text_map', details._datadog)
         const finalData = JSON.stringify(details)
         const byteSize = Buffer.byteLength(finalData)
         if (byteSize >= (1024 * 256)) {

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

@@ -0,0 +1,12 @@
+'use strict'
+
+exports.cloudwatchlogs = require('./cloudwatchlogs')
+exports.dynamodb = require('./dynamodb')
+exports.eventbridge = require('./eventbridge')
+exports.kinesis = require('./kinesis')
+exports.lambda = require('./lambda')
+exports.redshift = require('./redshift')
+exports.s3 = require('./s3')
+exports.sns = require('./sns')
+exports.sqs = require('./sqs')
+exports.default = require('./default')

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

@@ -1,6 +1,7 @@
 'use strict'
 const log = require('../../../dd-trace/src/log')
-class Kinesis {
+const BaseAwsSdkPlugin = require('../base')
+class Kinesis extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     if (!params || !params.StreamName) return {}
 
@@ -26,7 +27,7 @@ class Kinesis {
     }
   }
 
-  requestInject (span, request, tracer) {
+  requestInject (span, request) {
     const operation = request.operation
     if (operation === 'putRecord' || operation === 'putRecords') {
       if (!request.params) {
@@ -34,7 +35,7 @@ class Kinesis {
       }
 
       const traceData = {}
-      tracer.inject(span, 'text_map', traceData)
+      this.tracer.inject(span, 'text_map', traceData)
       let injectPath
       if (request.params.Records && request.params.Records.length > 0) {
         injectPath = request.params.Records[0]

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

@@ -1,8 +1,9 @@
 'use strict'
 
 const log = require('../../../dd-trace/src/log')
+const BaseAwsSdkPlugin = require('../base')
 
-class Lambda {
+class Lambda extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     const tags = {}
 
@@ -14,7 +15,7 @@ class Lambda {
     })
   }
 
-  requestInject (span, request, tracer) {
+  requestInject (span, request) {
     const operation = request.operation
     if (operation === 'invoke') {
       if (!request.params) {
@@ -35,7 +36,7 @@ class Lambda {
           if (!clientContext.custom) {
             clientContext.custom = {}
           }
-          tracer.inject(span, 'text_map', clientContext.custom)
+          this.tracer.inject(span, 'text_map', clientContext.custom)
           const newContextBase64 = Buffer.from(JSON.stringify(clientContext)).toString('base64')
           request.params.ClientContext = newContextBase64
         } catch (err) {

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

@@ -1,6 +1,8 @@
 'use strict'
 
-class Redshift {
+const BaseAwsSdkPlugin = require('../base')
+
+class Redshift extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     const tags = {}
 

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

@@ -1,6 +1,8 @@
 'use strict'
 
-class S3 {
+const BaseAwsSdkPlugin = require('../base')
+
+class S3 extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     const tags = {}
 

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

@@ -1,7 +1,8 @@
 'use strict'
 const log = require('../../../dd-trace/src/log')
+const BaseAwsSdkPlugin = require('../base')
 
-class Sns {
+class Sns extends BaseAwsSdkPlugin {
   generateTags (params, operation, response) {
     if (!params) return {}
 
@@ -16,7 +17,7 @@ class Sns {
     // for example if it contains a phone number?
   }
 
-  requestInject (span, request, tracer) {
+  requestInject (span, request) {
     const operation = request.operation
     if (operation === 'publish' || operation === 'publishBatch') {
       if (!request.params) {
@@ -36,7 +37,7 @@ class Sns {
         return
       }
       const ddInfo = {}
-      tracer.inject(span, 'text_map', ddInfo)
+      this.tracer.inject(span, 'text_map', ddInfo)
       injectPath.MessageAttributes._datadog = {
         DataType: 'Binary',
         BinaryValue: JSON.stringify(ddInfo) // BINARY types are automatically base64 encoded

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

@@ -1,9 +1,48 @@
 'use strict'
 
+const Tags = require('opentracing').Tags
 const log = require('../../../dd-trace/src/log')
+const BaseAwsSdkPlugin = require('../base')
+const { storage } = require('../../../datadog-core')
 
-class Sqs {
-  isEnabled (config, request) {
+class Sqs extends BaseAwsSdkPlugin {
+  constructor (...args) {
+    super(...args)
+    //
+    // TODO(bengl) Find a way to create the response span tags without this WeakMap being populated
+    // in the base class
+    this.requestTags = new WeakMap()
+
+    this.addSub('apm:aws:response:start:sqs', obj => {
+      const { request, response } = obj
+      const store = storage.getStore()
+      const plugin = this
+      const maybeChildOf = this.responseExtract(request.params, request.operation, response)
+      if (maybeChildOf) {
+        obj.needsFinish = true
+        const options = {
+          childOf: maybeChildOf,
+          tags: Object.assign(
+            {},
+            this.requestTags.get(request) || {},
+            { [Tags.SPAN_KIND]: 'server' }
+          )
+        }
+        const span = plugin.tracer.startSpan('aws.response', options)
+        this.enter(span, store)
+      }
+    })
+
+    this.addSub('apm:aws:response:finish:sqs', err => {
+      const { span } = storage.getStore()
+      this.finish(span, null, err)
+    })
+  }
+
+  isEnabled (request) {
+    // TODO(bengl) Figure out a way to make separate plugins for consumer and producer so that
+    // config can be isolated to `.configure()` instead of this whole isEnabled() thing.
+    const config = this.config
     switch (request.operation) {
       case 'receiveMessage':
         return config.consumer !== false
@@ -39,7 +78,7 @@ class Sqs {
     return tags
   }
 
-  responseExtract (params, operation, response, tracer) {
+  responseExtract (params, operation, response) {
     if (operation === 'receiveMessage') {
       if (
         (!params.MaxNumberOfMessages || params.MaxNumberOfMessages === 1) &&
@@ -52,7 +91,7 @@ class Sqs {
       ) {
         const textMap = response.Messages[0].MessageAttributes._datadog.StringValue
         try {
-          return tracer.extract('text_map', JSON.parse(textMap))
+          return this.tracer.extract('text_map', JSON.parse(textMap))
         } catch (err) {
           log.error(err)
           return undefined
@@ -61,7 +100,7 @@ class Sqs {
     }
   }
 
-  requestInject (span, request, tracer) {
+  requestInject (span, request) {
     const operation = request.operation
     if (operation === 'sendMessage') {
       if (!request.params) {
@@ -74,7 +113,7 @@ class Sqs {
         return
       }
       const ddInfo = {}
-      tracer.inject(span, 'text_map', ddInfo)
+      this.tracer.inject(span, 'text_map', ddInfo)
       request.params.MessageAttributes._datadog = {
         DataType: 'String',
         StringValue: JSON.stringify(ddInfo)

package/packages/datadog-plugin-cassandra-driver/src/index.js

@@ -43,15 +43,11 @@ class CassandraDriverPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub(`apm:cassandra:query:end`, () => {
-      this.exit()
-    })
-
     this.addSub(`apm:cassandra:query:error`, err => {
       storage.getStore().span.setTag('error', err)
     })
 
-    this.addSub(`apm:cassandra:query:async-end`, () => {
+    this.addSub(`apm:cassandra:query:finish`, () => {
       storage.getStore().span.finish()
     })
 

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

@@ -9,11 +9,10 @@ class CouchBasePlugin extends Plugin {
     return 'couchbase'
   }
 
-  addSubs (func, start, asyncEnd = defaultAsyncEnd) {
+  addSubs (func, start, finish = defaultFinish) {
     this.addSub(`apm:couchbase:${func}:start`, start)
-    this.addSub(`apm:couchbase:${func}:end`, this.exit.bind(this))
     this.addSub(`apm:couchbase:${func}:error`, errorHandler)
-    this.addSub(`apm:couchbase:${func}:async-end`, asyncEnd)
+    this.addSub(`apm:couchbase:${func}:finish`, finish)
   }
 
   startSpan (operation, customTags, store, bucket) {
@@ -63,7 +62,7 @@ class CouchBasePlugin extends Plugin {
   }
 }
 
-function defaultAsyncEnd () {
+function defaultFinish () {
   storage.getStore().span.finish()
 }
 

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

@@ -54,10 +54,6 @@ class CucumberPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('ci:cucumber:run:end', () => {
-      this.exit()
-    })
-
     this.addSub('ci:cucumber:run-step:start', ({ resource }) => {
       const store = storage.getStore()
       const childOf = store ? store.span : store
@@ -71,11 +67,7 @@ class CucumberPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('ci:cucumber:run-step:end', () => {
-      this.exit()
-    })
-
-    this.addSub('ci:cucumber:run:async-end', ({ isStep, status, skipReason, errorMessage }) => {
+    this.addSub('ci:cucumber:run:finish', ({ isStep, status, skipReason, errorMessage }) => {
       const span = storage.getStore().span
       const statusTag = isStep ? 'step.status' : TEST_STATUS
 

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

@@ -9,11 +9,10 @@ class DNSPlugin extends Plugin {
     return 'dns'
   }
 
-  addSubs (func, start, asyncEnd = defaultAsyncEnd) {
+  addSubs (func, start, finish = defaultFinish) {
     this.addSub(`apm:dns:${func}:start`, start)
-    this.addSub(`apm:dns:${func}:end`, this.exit.bind(this))
     this.addSub(`apm:dns:${func}:error`, errorHandler)
-    this.addSub(`apm:dns:${func}:async-end`, asyncEnd)
+    this.addSub(`apm:dns:${func}:finish`, finish)
   }
 
   startSpan (name, customTags, store) {
@@ -88,7 +87,7 @@ class DNSPlugin extends Plugin {
   }
 }
 
-function defaultAsyncEnd () {
+function defaultFinish () {
   storage.getStore().span.finish()
 }
 

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

@@ -34,16 +34,12 @@ class ElasticsearchPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('apm:elasticsearch:query:end', () => {
-      this.exit()
-    })
-
     this.addSub('apm:elasticsearch:query:error', err => {
       const span = storage.getStore().span
       span.setTag('error', err)
     })
 
-    this.addSub('apm:elasticsearch:query:async-end', ({ params }) => {
+    this.addSub('apm:elasticsearch:query:finish', ({ params }) => {
       const span = storage.getStore().span
       this.config.hooks.query(span, params)
       span.finish()

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

@@ -1,6 +1,37 @@
 'use strict'
 
-const route = require('./route')
-const server = require('./server')
+const { storage } = require('../../datadog-core')
+const RouterPlugin = require('../../datadog-plugin-router/src')
+const web = require('../../dd-trace/src/plugins/util/web')
 
-module.exports = [].concat(route, server)
+class HapiPlugin extends RouterPlugin {
+  static get name () {
+    return 'hapi'
+  }
+
+  constructor (...args) {
+    super(...args)
+
+    this._requestSpans = new WeakMap()
+
+    this.addSub('apm:hapi:request:handle', ({ req }) => {
+      const store = storage.getStore()
+      const span = store && store.span
+
+      this.setFramework(req, 'hapi', this.config)
+      this._requestSpans.set(req, span)
+    })
+
+    this.addSub('apm:hapi:request:route', ({ req, route }) => {
+      web.setRoute(req, route)
+    })
+
+    this.addSub(`apm:hapi:request:error`, this.addError)
+
+    this.addSub('apm:hapi:extension:enter', ({ req }) => {
+      this.enter(this._requestSpans.get(req))
+    })
+  }
+}
+
+module.exports = HapiPlugin

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

@@ -54,9 +54,7 @@ class HttpClientPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('apm:http:client:request:end', this.exit.bind(this))
-
-    this.addSub('apm:http:client:request:async-end', ({ req, res }) => {
+    this.addSub('apm:http:client:request:finish', ({ req, res }) => {
       const span = storage.getStore().span
       if (res) {
         span.setTag(HTTP_STATUS_CODE, res.statusCode)

package/packages/datadog-plugin-http/src/server.js

@@ -31,10 +31,6 @@ class HttpServerPlugin extends Plugin {
       }
     })
 
-    this.addSub('apm:http:server:request:end', () => {
-      this.exit()
-    })
-
     this.addSub('apm:http:server:request:error', (error) => {
       const span = storage.getStore().span
       span.addTags({

package/packages/datadog-plugin-http2/src/server.js

@@ -22,6 +22,7 @@ const HTTP_STATUS_CODE = tags.HTTP_STATUS_CODE
 const HTTP_ROUTE = tags.HTTP_ROUTE
 const HTTP_REQUEST_HEADERS = tags.HTTP_REQUEST_HEADERS
 const HTTP_RESPONSE_HEADERS = tags.HTTP_RESPONSE_HEADERS
+const HTTP_USERAGENT = tags.HTTP_USERAGENT
 const MANUAL_DROP = tags.MANUAL_DROP
 
 const HTTP_STATUS_OK = 200
@@ -141,7 +142,8 @@ function addRequestTags (stream, headers) {
     [HTTP_METHOD]: headers[HTTP2_HEADER_METHOD],
     [HTTP_URL]: url.split('?')[0],
     [SPAN_KIND]: SERVER,
-    [SPAN_TYPE]: WEB
+    [SPAN_TYPE]: WEB,
+    [HTTP_USERAGENT]: headers['user-agent']
   })
 }
 

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

@@ -48,15 +48,14 @@ class JestPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('ci:jest:test:end', (status) => {
+    this.addSub('ci:jest:test:finish', (status) => {
       const span = storage.getStore().span
       span.setTag(TEST_STATUS, status)
       span.finish()
       finishAllTraceSpans(span)
-      this.exit()
     })
 
-    this.addSub('ci:jest:test-suite:end', () => {
+    this.addSub('ci:jest:test-suite:finish', () => {
       this.tracer._exporter._writer.flush()
     })
 

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

@@ -60,10 +60,6 @@ class KafkajsPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub(`apm:kafkajs:end`, () => {
-      this.exit()
-    })
-
     this.addSub(`apm:kafkajs:consume:error`, errorHandler)
 
     this.addSub(`apm:kafkajs:consume:finish`, finishHandler)

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

@@ -28,10 +28,6 @@ class MemcachedPlugin extends Plugin {
       this.enter(span, store)
     })
 
-    this.addSub('apm:memcached:command:end', () => {
-      this.exit()
-    })
-
     this.addSub('apm:memcached:command:start:with-args', ({ client, server, query }) => {
       const span = storage.getStore().span
       span.addTags({
@@ -54,7 +50,7 @@ class MemcachedPlugin extends Plugin {
       span.setTag('error', err)
     })
 
-    this.addSub('apm:memcached:command:async-end', () => {
+    this.addSub('apm:memcached:command:finish', () => {
       const span = storage.getStore().span
       span.finish()
     })