dd-trace 3.3.1 → 3.12.1

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

@@ -1,72 +1,63 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const Tags = require('../../../ext/tags')
+const ClientPlugin = require('../../dd-trace/src/plugins/client')
 const { TEXT_MAP } = require('../../../ext/formats')
-const { addMethodTags, addMetadataTags, getFilter } = require('./util')
-
-class GrpcClientPlugin extends Plugin {
-  static get name () {
-    return 'grpc'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub('apm:grpc:client:request:start', ({ metadata, path, type }) => {
-      const metadataFilter = this.config.metadataFilter
-      const store = storage.getStore()
-      const childOf = store && store.span
-      const span = this.tracer.startSpan('grpc.client', {
-        childOf,
-        tags: {
-          [Tags.SPAN_KIND]: 'client',
-          'span.type': 'http',
-          'resource.name': path,
-          'service.name': this.config.service || this.tracer._service,
-          'component': 'grpc'
-        }
-      })
-
-      addMethodTags(span, path, type)
-
-      if (metadata) {
-        addMetadataTags(span, metadata, metadataFilter, 'request')
-        inject(this.tracer, span, metadata)
+const { addMetadataTags, getFilter, getMethodMetadata } = require('./util')
+
+class GrpcClientPlugin extends ClientPlugin {
+  static get name () { return 'grpc' }
+  static get operation () { return 'client:request' }
+
+  start ({ metadata, path, type }) {
+    const metadataFilter = this.config.metadataFilter
+    const method = getMethodMetadata(path, type)
+    const span = this.startSpan('grpc.client', {
+      service: this.config.service,
+      resource: path,
+      kind: 'client',
+      type: 'http',
+      meta: {
+        'component': 'grpc',
+        'grpc.method.kind': method.kind,
+        'grpc.method.path': method.path,
+        'grpc.method.name': method.name,
+        'grpc.method.service': method.service,
+        'grpc.method.package': method.package
+      },
+      metrics: {
+        'grpc.status.code': 0
       }
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      this.enter(span, store)
     })
 
-    this.addSub('apm:grpc:client:request:error', error => {
-      const store = storage.getStore()
+    if (metadata) {
+      addMetadataTags(span, metadata, metadataFilter, 'request')
+      inject(this.tracer, span, metadata)
+    }
+  }
 
-      if (!store || !store.span) return
+  error (error) {
+    const span = this.activeSpan
 
-      this.addCode(store.span, error.code)
-      this.addError(error)
-    })
+    if (!span) return
 
-    this.addSub('apm:grpc:client:request:finish', ({ code, metadata }) => {
-      const store = storage.getStore()
+    this.addCode(span, error.code)
+    this.addError(error)
+  }
 
-      if (!store || !store.span) return
+  finish ({ code, metadata }) {
+    const span = this.activeSpan
 
-      const span = store.span
-      const metadataFilter = this.config.metadataFilter
+    if (!span) return
 
-      this.addCode(span, code)
+    const metadataFilter = this.config.metadataFilter
 
-      if (metadata && metadataFilter) {
-        addMetadataTags(span, metadata, metadataFilter, 'response')
-      }
+    this.addCode(span, code)
 
-      store.span.finish()
-    })
+    if (metadata && metadataFilter) {
+      addMetadataTags(span, metadata, metadataFilter, 'response')
+    }
+
+    span.finish()
   }
 
   configure (config) {

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

@@ -1,33 +1,16 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
 const GrpcServerPlugin = require('./server')
 const GrpcClientPlugin = require('./client')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
 
-class GrpcPlugin extends Plugin {
-  static get name () {
-    return 'grpc'
-  }
-
-  constructor (...args) {
-    super(...args)
-    this.server = new GrpcServerPlugin(...args)
-    this.client = new GrpcClientPlugin(...args)
-  }
-
-  configure (config) {
-    const clientConfig = config.client === false ? false : {
-      ...config,
-      ...config.client
+class GrpcPlugin extends CompositePlugin {
+  static get name () { return 'grpc' }
+  static get plugins () {
+    return {
+      server: GrpcServerPlugin,
+      client: GrpcClientPlugin
     }
-
-    const serverConfig = config.server === false ? false : {
-      ...config,
-      ...config.server
-    }
-
-    this.server.configure(serverConfig)
-    this.client.configure(clientConfig)
   }
 }
 

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

@@ -1,76 +1,74 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const Tags = require('../../../ext/tags')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { TEXT_MAP } = require('../../../ext/formats')
-const { addMethodTags, addMetadataTags, getFilter } = require('./util')
+const { addMetadataTags, getFilter, getMethodMetadata } = require('./util')
 
-class GrpcServerPlugin extends Plugin {
-  static get name () {
-    return 'http'
-  }
+class GrpcServerPlugin extends ServerPlugin {
+  static get name () { return 'grpc' }
+  static get operation () { return 'server:request' }
 
   constructor (...args) {
     super(...args)
 
-    this.addSub('apm:grpc:server:request:start', ({ name, metadata, type }) => {
-      const metadataFilter = this.config.metadataFilter
-      const store = storage.getStore()
-      const childOf = extract(this.tracer, metadata)
-      const span = this.tracer.startSpan('grpc.server', {
-        childOf,
-        tags: {
-          [Tags.SPAN_KIND]: 'server',
-          'span.type': 'web',
-          'resource.name': name,
-          'service.name': this.config.service || this.tracer._service,
-          'component': 'grpc'
-        }
-      })
-
-      addMethodTags(span, name, type)
-      addMetadataTags(span, metadata, metadataFilter, 'request')
-
-      analyticsSampler.sample(span, this.config.measured, true)
-
-      this.enter(span, store)
-    })
+    this.addTraceSub('update', ({ code }) => {
+      const span = this.activeSpan
 
-    this.addSub('apm:grpc:server:request:error', error => {
-      const store = storage.getStore()
+      if (!span) return
 
-      if (!store || !store.span) return
+      this.addCode(span, code)
+    })
+  }
 
-      this.addCode(store.span, error.code)
-      this.addError(error)
+  start ({ name, metadata, type }) {
+    const metadataFilter = this.config.metadataFilter
+    const childOf = extract(this.tracer, metadata)
+    const method = getMethodMetadata(name, type)
+    const span = this.startSpan('grpc.server', {
+      childOf,
+      service: this.config.service,
+      resource: name,
+      kind: 'server',
+      type: 'web',
+      meta: {
+        'component': 'grpc',
+        'grpc.method.kind': method.kind,
+        'grpc.method.path': method.path,
+        'grpc.method.name': method.name,
+        'grpc.method.service': method.service,
+        'grpc.method.package': method.package
+      },
+      metrics: {
+        'grpc.status.code': 0
+      }
     })
 
-    this.addSub('apm:grpc:server:request:update', ({ code }) => {
-      const store = storage.getStore()
+    addMetadataTags(span, metadata, metadataFilter, 'request')
+  }
+
+  error (error) {
+    const span = this.activeSpan
 
-      if (!store || !store.span) return
+    if (!span) return
 
-      this.addCode(store.span, code)
-    })
+    this.addCode(span, error.code)
+    this.addError(error)
+  }
 
-    this.addSub('apm:grpc:server:request:finish', ({ code, trailer } = {}) => {
-      const store = storage.getStore()
+  finish ({ code, trailer } = {}) {
+    const span = this.activeSpan
 
-      if (!store || !store.span) return
+    if (!span) return
 
-      const span = store.span
-      const metadataFilter = this.config.metadataFilter
+    const metadataFilter = this.config.metadataFilter
 
-      this.addCode(span, code)
+    this.addCode(span, code)
 
-      if (trailer && metadataFilter) {
-        addMetadataTags(span, trailer, metadataFilter, 'response')
-      }
+    if (trailer && metadataFilter) {
+      addMetadataTags(span, trailer, metadataFilter, 'response')
+    }
 
-      store.span.finish()
-    })
+    span.finish()
   }
 
   configure (config) {

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

@@ -4,13 +4,16 @@ const pick = require('lodash.pick')
 const log = require('../../dd-trace/src/log')
 
 module.exports = {
-  addMethodTags (span, path, kind) {
-    if (typeof path !== 'string') return
+  getMethodMetadata (path, kind) {
+    const tags = {
+      path,
+      kind,
+      name: '',
+      service: '',
+      package: ''
+    }
 
-    span.addTags({
-      'grpc.method.path': path,
-      'grpc.method.kind': kind
-    })
+    if (typeof path !== 'string') return tags
 
     const methodParts = path.split('/')
 
@@ -20,16 +23,14 @@ module.exports = {
       const service = serviceParts.pop()
       const pkg = serviceParts.join('.')
 
-      span.addTags({
-        'grpc.method.name': name,
-        'grpc.method.service': service,
-        'grpc.method.package': pkg
-      })
+      tags.name = name
+      tags.service = service
+      tags.package = pkg
     } else {
-      span.addTags({
-        'grpc.method.name': methodParts[methodParts.length - 1]
-      })
+      tags.name = methodParts[methodParts.length - 1]
     }
+
+    return tags
   },
 
   addMetadataTags (span, metadata, filter, type) {

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

@@ -9,6 +9,7 @@ const HTTP_HEADERS = formats.HTTP_HEADERS
 const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 const log = require('../../dd-trace/src/log')
 const url = require('url')
+const { COMPONENT, ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
 
 const HTTP_STATUS_CODE = tags.HTTP_STATUS_CODE
 const HTTP_REQUEST_HEADERS = tags.HTTP_REQUEST_HEADERS
@@ -31,12 +32,14 @@ class HttpClientPlugin extends Plugin {
       const host = options.port ? `${hostname}:${options.port}` : hostname
       const path = options.path ? options.path.split(/[?#]/)[0] : '/'
       const uri = `${protocol}//${host}${path}`
+      const allowed = this.config.filter(uri)
 
       const method = (options.method || 'GET').toUpperCase()
-      const childOf = store ? store.span : store
+      const childOf = store && allowed ? store.span : null
       const span = this.tracer.startSpan('http.request', {
         childOf,
         tags: {
+          [COMPONENT]: this.constructor.name,
           'span.kind': 'client',
           'service.name': getServiceName(this.tracer, this.config, options),
           'resource.name': method,
@@ -46,6 +49,11 @@ class HttpClientPlugin extends Plugin {
         }
       })
 
+      // TODO: Figure out a better way to do this for any span.
+      if (!allowed) {
+        span._spanContext._trace.record = false
+      }
+
       if (!(hasAmazonSignature(options) || !this.config.propagationFilter(uri))) {
         this.tracer.inject(span, HTTP_HEADERS, options.headers)
       }
@@ -85,9 +93,9 @@ function errorHandler (err) {
 
   if (err) {
     span.addTags({
-      'error.type': err.name,
-      'error.msg': err.message,
-      'error.stack': err.stack
+      [ERROR_TYPE]: err.name,
+      [ERROR_MESSAGE]: err.message,
+      [ERROR_STACK]: err.stack
     })
   } else {
     span.setTag('error', 1)
@@ -109,19 +117,21 @@ function addRequestHeaders (req, span, config) {
     const value = req.getHeader(key)
 
     if (value) {
-      span.setTag(`${HTTP_REQUEST_HEADERS}.${key}`, value)
+      span.setTag(`${HTTP_REQUEST_HEADERS}.${key}`, Array.isArray(value) ? value.toString() : value)
     }
   })
 }
 
 function normalizeClientConfig (config) {
   const validateStatus = getStatusValidator(config)
+  const filter = getFilter(config)
   const propagationFilter = getFilter({ blocklist: config.propagationBlocklist })
   const headers = getHeaders(config)
   const hooks = getHooks(config)
 
   return Object.assign({}, config, {
     validateStatus,
+    filter,
     propagationFilter,
     headers,
     hooks

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

@@ -1,31 +1,16 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
 const HttpServerPlugin = require('./server')
 const HttpClientPlugin = require('./client')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
 
-class HttpPlugin extends Plugin {
-  static get name () {
-    return 'http'
-  }
-  constructor (...args) {
-    super(...args)
-    this.server = new HttpServerPlugin(...args)
-    this.client = new HttpClientPlugin(...args)
-  }
-  configure (config) {
-    const clientConfig = config.client === false ? false : {
-      ...config,
-      ...config.client
+class HttpPlugin extends CompositePlugin {
+  static get name () { return 'http' }
+  static get plugins () {
+    return {
+      server: HttpServerPlugin,
+      client: HttpClientPlugin
     }
-
-    const serverConfig = config.server === false ? false : {
-      ...config,
-      ...config.server
-    }
-
-    this.server.configure(serverConfig)
-    this.client.configure(clientConfig)
   }
 }
 

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

@@ -3,7 +3,8 @@
 const Plugin = require('../../dd-trace/src/plugins/plugin')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
-const { incomingHttpRequestStart } = require('../../dd-trace/src/appsec/gateway/channels')
+const { incomingHttpRequestStart, incomingHttpRequestEnd } = require('../../dd-trace/src/appsec/gateway/channels')
+const { COMPONENT } = require('../../dd-trace/src/constants')
 
 class HttpServerPlugin extends Plugin {
   static get name () {
@@ -13,10 +14,15 @@ class HttpServerPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
-    this.addSub('apm:http:server:request:start', ({ req, res }) => {
+    this._parentStore = undefined
+
+    this.addSub('apm:http:server:request:start', ({ req, res, abortController }) => {
       const store = storage.getStore()
       const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
 
+      span.setTag(COMPONENT, this.constructor.name)
+
+      this._parentStore = store
       this.enter(span, { ...store, req })
 
       const context = web.getContext(req)
@@ -27,7 +33,7 @@ class HttpServerPlugin extends Plugin {
       }
 
       if (incomingHttpRequestStart.hasSubscribers) {
-        incomingHttpRequestStart.publish({ req, res })
+        incomingHttpRequestStart.publish({ req, res, abortController })
       }
     })
 
@@ -35,11 +41,21 @@ class HttpServerPlugin extends Plugin {
       web.addError(error)
     })
 
+    this.addSub('apm:http:server:request:exit', ({ req }) => {
+      const span = this._parentStore && this._parentStore.span
+      this.enter(span, this._parentStore)
+      this._parentStore = undefined
+    })
+
     this.addSub('apm:http:server:request:finish', ({ req }) => {
       const context = web.getContext(req)
 
       if (!context || !context.res) return // Not created by a http.Server instance.
 
+      if (incomingHttpRequestEnd.hasSubscribers) {
+        incomingHttpRequestEnd.publish({ req, res: context.res })
+      }
+
       web.finishAll(context)
     })
   }

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

@@ -9,6 +9,8 @@ const tags = require('../../../ext/tags')
 const kinds = require('../../../ext/kinds')
 const formats = require('../../../ext/formats')
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const { COMPONENT } = require('../../dd-trace/src/constants')
+const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 
 const HTTP_HEADERS = formats.HTTP_HEADERS
 const HTTP_STATUS_CODE = tags.HTTP_STATUS_CODE
@@ -36,12 +38,14 @@ class Http2ClientPlugin extends Plugin {
       const pathname = path.split(/[?#]/)[0]
       const method = headers[HTTP2_HEADER_METHOD] || HTTP2_METHOD_GET
       const uri = `${sessionDetails.protocol}//${sessionDetails.host}:${sessionDetails.port}${pathname}`
+      const allowed = this.config.filter(uri)
 
       const store = storage.getStore()
-      const childOf = store ? store.span : store
+      const childOf = store && allowed ? store.span : null
       const span = this.tracer.startSpan('http.request', {
         childOf,
         tags: {
+          [COMPONENT]: this.constructor.name,
           [SPAN_KIND]: CLIENT,
           'service.name': getServiceName(this.tracer, this.config, sessionDetails),
           'resource.name': method,
@@ -51,6 +55,11 @@ class Http2ClientPlugin extends Plugin {
         }
       })
 
+      // TODO: Figure out a better way to do this for any span.
+      if (!allowed) {
+        span._spanContext._trace.record = false
+      }
+
       addHeaderTags(span, headers, HTTP_REQUEST_HEADERS, this.config)
 
       if (!hasAmazonSignature(headers, path)) {
@@ -155,14 +164,24 @@ function getStatusValidator (config) {
 
 function normalizeConfig (config) {
   const validateStatus = getStatusValidator(config)
+  const filter = getFilter(config)
   const headers = getHeaders(config)
 
   return Object.assign({}, config, {
     validateStatus,
+    filter,
     headers
   })
 }
 
+function getFilter (config) {
+  config = Object.assign({}, config, {
+    blocklist: config.blocklist || []
+  })
+
+  return urlFilter.getFilter(config)
+}
+
 function addHeaderTags (span, headers, prefix, config) {
   if (!headers) return
 

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

@@ -1,34 +1,16 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
 const Http2ServerPlugin = require('./server')
 const Http2ClientPlugin = require('./client')
-
-class Http2Plugin extends Plugin {
-  static get name () {
-    return 'http2'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.server = new Http2ServerPlugin(...args)
-    this.client = new Http2ClientPlugin(...args)
-  }
-
-  configure (config) {
-    const clientConfig = config.client === false ? false : {
-      ...config,
-      ...config.client
-    }
-
-    const serverConfig = config.server === false ? false : {
-      ...config,
-      ...config.server
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+
+class Http2Plugin extends CompositePlugin {
+  static get name () { return 'http2' }
+  static get plugins () {
+    return {
+      server: Http2ServerPlugin,
+      client: Http2ClientPlugin
     }
-
-    this.server.configure(serverConfig)
-    this.client.configure(clientConfig)
   }
 }
 

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

@@ -3,11 +3,55 @@
 // Plugin temporarily disabled. See https://github.com/DataDog/dd-trace-js/issues/312
 
 const Plugin = require('../../dd-trace/src/plugins/plugin')
+const { storage } = require('../../datadog-core')
+const web = require('../../dd-trace/src/plugins/util/web')
+const { incomingHttpRequestStart } = require('../../dd-trace/src/appsec/gateway/channels')
+const { COMPONENT } = require('../../dd-trace/src/constants')
 
 class Http2ServerPlugin extends Plugin {
   static get name () {
     return 'http2'
   }
+
+  constructor (...args) {
+    super(...args)
+
+    this.addSub('apm:http2:server:request:start', ({ req, res }) => {
+      const store = storage.getStore()
+      const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
+
+      span.setTag(COMPONENT, this.constructor.name)
+
+      this.enter(span, { ...store, req })
+
+      const context = web.getContext(req)
+
+      if (!context.instrumented) {
+        context.res.writeHead = web.wrapWriteHead(context)
+        context.instrumented = true
+      }
+
+      if (incomingHttpRequestStart.hasSubscribers) {
+        incomingHttpRequestStart.publish({ req, res })
+      }
+    })
+
+    this.addSub('apm:http2:server:request:error', (error) => {
+      web.addError(error)
+    })
+
+    this.addSub('apm:http2:server:request:finish', ({ req }) => {
+      const context = web.getContext(req)
+
+      if (!context || !context.res) return // Not created by a http.Server instance.
+
+      web.finishAll(context)
+    })
+  }
+
+  configure (config) {
+    return super.configure(web.normalizeConfig(config))
+  }
 }
 
 module.exports = Http2ServerPlugin