dd-trace 3.5.0 → 3.6.0

package/packages/datadog-plugin-graphql/src/resolve.js

@@ -1,98 +1,92 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const TracingPlugin = require('../../dd-trace/src/plugins/tracing')
 
 const collapsedPathSym = Symbol('collapsedPaths')
 
-class GraphQLResolvePlugin extends Plugin {
-  static get name () {
-    return 'graphql'
+class GraphQLResolvePlugin extends TracingPlugin {
+  static get name () { return 'graphql' }
+  static get operation () { return 'resolve' }
+
+  start ({ info, context }) {
+    const path = getPath(info, this.config)
+
+    if (!shouldInstrument(this.config, path)) return
+
+    const computedPathString = path.join('.')
+
+    if (this.config.collapse) {
+      if (!context[collapsedPathSym]) {
+        context[collapsedPathSym] = {}
+      }
+
+      if (context.fields[computedPathString]) return
+      if (context[collapsedPathSym][computedPathString]) return
+
+      context[collapsedPathSym][computedPathString] = true
+    }
+
+    const document = context.source
+    const fieldNode = info.fieldNodes.find(fieldNode => fieldNode.kind === 'Field')
+    const loc = this.config.source && document && fieldNode && fieldNode.loc
+    const source = loc && document.substring(loc.start, loc.end)
+
+    const span = this.startSpan('graphql.resolve', {
+      service: this.config.service,
+      resource: `${info.fieldName}:${info.returnType}`,
+      type: 'graphql',
+      meta: {
+        'graphql.field.name': info.fieldName,
+        'graphql.field.path': computedPathString,
+        'graphql.field.type': info.returnType.name,
+        'graphql.source': source
+      }
+    })
+
+    if (fieldNode && this.config.variables && fieldNode.arguments) {
+      const variables = this.config.variables(info.variableValues)
+
+      fieldNode.arguments
+        .filter(arg => arg.value && arg.value.kind === 'Variable')
+        .filter(arg => arg.value.name && variables[arg.value.name.value])
+        .map(arg => arg.value.name.value)
+        .forEach(name => {
+          span.setTag(`graphql.variables.${name}`, variables[name])
+        })
+    }
+  }
+
+  finish (finishTime) {
+    const span = this.activeSpan
+    span.finish(finishTime)
   }
 
   constructor (...args) {
     super(...args)
 
-    this.addSub('apm:graphql:resolve:start', ({ info, context }) => {
-      const store = storage.getStore()
-      depthPredicate(info, this.config, (computedPath) => {
-        const computedPathString = computedPath.join('.')
-        if ((!this.config.collapse && !context.fields[computedPathString]) ||
-             (!context[collapsedPathSym] || !context[collapsedPathSym][computedPathString])) {
-          // cache the collapsed string here
-          if (this.config.collapse) {
-            if (!context[collapsedPathSym]) context[collapsedPathSym] = {}
-            context[collapsedPathSym][computedPathString] = true
-          }
-
-          const service = this.config.service || this.tracer._service
-          const childOf = store ? store.span : store
-          const span = this.tracer.startSpan(`graphql.resolve`, {
-            childOf: childOf,
-            tags: {
-              'service.name': service,
-              'span.type': 'graphql'
-            }
-          })
-          const document = context.source
-          const fieldNode = info.fieldNodes.find(fieldNode => fieldNode.kind === 'Field')
-
-          analyticsSampler.sample(span, this.config.measured)
-
-          span.addTags({
-            'resource.name': `${info.fieldName}:${info.returnType}`,
-            'graphql.field.name': info.fieldName,
-            'graphql.field.path': computedPathString,
-            'graphql.field.type': info.returnType.name
-          })
-
-          if (fieldNode) {
-            if (this.config.source && document && fieldNode.loc) {
-              span.setTag('graphql.source', document.substring(fieldNode.loc.start, fieldNode.loc.end))
-            }
-
-            if (this.config.variables && fieldNode.arguments) {
-              const variables = this.config.variables(info.variableValues)
-
-              fieldNode.arguments
-                .filter(arg => arg.value && arg.value.kind === 'Variable')
-                .filter(arg => arg.value.name && variables[arg.value.name.value])
-                .map(arg => arg.value.name.value)
-                .forEach(name => {
-                  span.setTag(`graphql.variables.${name}`, variables[name])
-                })
-            }
-          }
-          this.enter(span, store)
-        }
-      })
-    })
+    this.addTraceSub('updateField', ({ field, info, err }) => {
+      const path = getPath(info, this.config)
 
-    this.addSub('apm:graphql:resolve:updateField', ({ field, info, err }) => {
-      depthPredicate(info, this.config, () => {
-        const span = storage.getStore().span
-        field.finishTime = span._getTime ? span._getTime() : 0
-        field.error = field.error || err
-      })
-    })
+      if (!shouldInstrument(this.config, path)) return
 
-    this.addSub('apm:graphql:resolve:error', this.addError)
-
-    this.addSub('apm:graphql:resolve:finish', finishTime => {
-      const span = storage.getStore().span
-      span.finish(finishTime)
+      const span = this.activeSpan
+      field.finishTime = span._getTime ? span._getTime() : 0
+      field.error = field.error || err
     })
   }
+
+  configure (config) {
+    // this will disable resolve subscribers if `config.depth` is set to 0
+    super.configure(config.depth === 0 ? false : config)
+  }
 }
 
 // helpers
 
-function depthPredicate (info, config, func) {
-  func = func || (() => {})
-  const path = getPath(info, config)
+function shouldInstrument (config, path) {
   const depth = path.filter(item => typeof item === 'string').length
-  if (config.depth < 0 || config.depth >= depth) func(path)
+
+  return config.depth < 0 || config.depth >= depth
 }
 
 function getPath (info, config) {

package/packages/datadog-plugin-graphql/src/validate.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const TracingPlugin = require('../../dd-trace/src/plugins/tracing')
+
+class GraphQLValidatePlugin extends TracingPlugin {
+  static get name () { return 'graphql' }
+  static get operation () { return 'validate' }
+
+  start ({ docSource, document }) {
+    const source = this.config.source && document && docSource
+
+    this.startSpan('graphql.validate', {
+      service: this.config.service,
+      type: 'graphql',
+      meta: {
+        'graphql.source': source
+      }
+    })
+  }
+
+  finish ({ document, errors }) {
+    const span = this.activeSpan
+    this.config.hooks.validate(span, document, errors)
+    span.finish()
+  }
+}
+
+module.exports = GraphQLValidatePlugin

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/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-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-jest/src/index.js

@@ -237,6 +237,9 @@ class JestPlugin extends Plugin {
         testSuiteSpan.setTag('error', new Error(errorMessage))
       }
       testSuiteSpan.finish()
+      // Suites potentially run in a different process than the session,
+      // so calling finishAllTraceSpans on the session span is not enough
+      finishAllTraceSpans(testSuiteSpan)
     })
 
     this.addSub('ci:jest:test-suite:code-coverage', (coverageFiles) => {

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

@@ -0,0 +1,42 @@
+'use strict'
+
+const ConsumerPlugin = require('../../dd-trace/src/plugins/consumer')
+
+class KafkajsConsumerPlugin extends ConsumerPlugin {
+  static get name () { return 'kafkajs' }
+  static get operation () { return 'consume' }
+
+  start ({ topic, partition, message }) {
+    const childOf = extract(this.tracer, message.headers)
+
+    this.startSpan('kafka.consume', {
+      childOf,
+      service: this.config.service || `${this.tracer._service}-kafka`,
+      resource: topic,
+      kind: 'consumer',
+      type: 'worker',
+      meta: {
+        'component': 'kafkajs',
+        'kafka.topic': topic,
+        'kafka.message.offset': message.offset
+      },
+      metrics: {
+        'kafka.partition': partition
+      }
+    })
+  }
+}
+
+function extract (tracer, bufferMap) {
+  if (!bufferMap) return null
+
+  const textMap = {}
+
+  for (const key of Object.keys(bufferMap)) {
+    textMap[key] = bufferMap[key].toString()
+  }
+
+  return tracer.extract('text_map', textMap)
+}
+
+module.exports = KafkajsConsumerPlugin