dd-trace 2.37.0 → 2.39.0

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

@@ -7,12 +7,13 @@ const { addMetadataTags, getFilter, getMethodMetadata } = require('./util')
 class GrpcClientPlugin extends ClientPlugin {
   static get id () { return 'grpc' }
   static get operation () { return 'client:request' }
+  static get peerServicePrecursors () { return ['rpc.service'] }
 
   start ({ metadata, path, type }) {
     const metadataFilter = this.config.metadataFilter
     const method = getMethodMetadata(path, type)
-    const span = this.startSpan('grpc.request', {
-      service: this.config.service || `${this.tracer._service}-grpc-client`,
+    const span = this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: path,
       kind: 'client',
       type: 'http',
@@ -29,6 +30,11 @@ class GrpcClientPlugin extends ClientPlugin {
       }
     })
 
+    // needed as precursor for peer.service
+    if (method.service && method.package) {
+      span.setTag('rpc.service', method.package + '.' + method.service)
+    }
+
     if (metadata) {
       addMetadataTags(span, metadata, metadataFilter, 'request')
       inject(this.tracer, span, metadata)
@@ -57,7 +63,7 @@ class GrpcClientPlugin extends ClientPlugin {
       addMetadataTags(span, metadata, metadataFilter, 'response')
     }
 
-    span.finish()
+    super.finish()
   }
 
   configure (config) {

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

@@ -24,9 +24,9 @@ class GrpcServerPlugin extends ServerPlugin {
     const metadataFilter = this.config.metadataFilter
     const childOf = extract(this.tracer, metadata)
     const method = getMethodMetadata(name, type)
-    const span = this.startSpan('grpc.request', {
+    const span = this.startSpan(this.operationName(), {
       childOf,
-      service: this.config.service,
+      service: this.config.service || this.serviceName(),
       resource: name,
       kind: 'server',
       type: 'web',
@@ -68,7 +68,7 @@ class GrpcServerPlugin extends ServerPlugin {
       addMetadataTags(span, trailer, metadataFilter, 'response')
     }
 
-    span.finish()
+    super.finish()
   }
 
   configure (config) {

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

@@ -87,7 +87,7 @@ class HttpClientPlugin extends ClientPlugin {
     addRequestHeaders(req, span, this.config)
 
     this.config.hooks.request(span, req, res)
-    span.finish()
+    super.finish()
   }
 
   error (err) {

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

@@ -1,63 +1,67 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
 const { incomingHttpRequestStart, incomingHttpRequestEnd } = require('../../dd-trace/src/appsec/channels')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
-class HttpServerPlugin extends Plugin {
+class HttpServerPlugin extends ServerPlugin {
   static get id () {
     return 'http'
   }
 
   constructor (...args) {
     super(...args)
-
     this._parentStore = undefined
+    this.addTraceSub('exit', message => this.exit(message))
+  }
+
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:server:${this.operation}:${eventName}`, handler)
+  }
 
-    this.addSub('apm:http:server:request:start', ({ req, res, abortController }) => {
-      const store = storage.getStore()
-      const span = web.startSpan(this.tracer, this.config, req, res, 'http.request')
+  start ({ req, res, abortController }) {
+    const store = storage.getStore()
+    const span = web.startSpan(this.tracer, this.config, req, res, 'http.request') // v2.x branch uses wrong value
 
-      span.setTag(COMPONENT, this.constructor.id)
+    span.setTag(COMPONENT, this.constructor.id)
 
-      this._parentStore = store
-      this.enter(span, { ...store, req, res })
+    this._parentStore = store
+    this.enter(span, { ...store, req, res })
 
-      const context = web.getContext(req)
+    const context = web.getContext(req)
 
-      if (!context.instrumented) {
-        context.res.writeHead = web.wrapWriteHead(context)
-        context.instrumented = true
-      }
+    if (!context.instrumented) {
+      context.res.writeHead = web.wrapWriteHead(context)
+      context.instrumented = true
+    }
 
-      if (incomingHttpRequestStart.hasSubscribers) {
-        incomingHttpRequestStart.publish({ req, res, abortController }) // TODO: no need to make a new object here
-      }
-    })
+    if (incomingHttpRequestStart.hasSubscribers) {
+      incomingHttpRequestStart.publish({ req, res, abortController }) // TODO: no need to make a new object here
+    }
+  }
 
-    this.addSub('apm:http:server:request:error', (error) => {
-      web.addError(error)
-    })
+  error (error) {
+    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
-    })
+  finish ({ req }) {
+    const context = web.getContext(req)
 
-    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 (!context || !context.res) return // Not created by a http.Server instance.
+    if (incomingHttpRequestEnd.hasSubscribers) {
+      incomingHttpRequestEnd.publish({ req, res: context.res })
+    }
 
-      if (incomingHttpRequestEnd.hasSubscribers) {
-        incomingHttpRequestEnd.publish({ req, res: context.res })
-      }
+    web.finishAll(context)
+  }
 
-      web.finishAll(context)
-    })
+  exit ({ req }) {
+    const span = this._parentStore && this._parentStore.span
+    this.enter(span, this._parentStore)
+    this._parentStore = undefined
   }
 
   configure (config) {

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

@@ -93,11 +93,6 @@ class Http2ClientPlugin extends ClientPlugin {
     this.enter(span, store)
   }
 
-  finish () {
-    const span = storage.getStore().span
-    span.finish()
-  }
-
   configure (config) {
     return super.configure(normalizeConfig(config))
   }

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

@@ -2,46 +2,46 @@
 
 // Plugin temporarily disabled. See https://github.com/DataDog/dd-trace-js/issues/312
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
-class Http2ServerPlugin extends Plugin {
+class Http2ServerPlugin extends ServerPlugin {
   static get id () {
     return 'http2'
   }
 
-  constructor (...args) {
-    super(...args)
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:server:${this.operation}:${eventName}`, handler)
+  }
 
-    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')
+  start ({ req, res }) {
+    const store = storage.getStore()
+    const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
 
-      span.setTag(COMPONENT, this.constructor.id)
+    span.setTag(COMPONENT, this.constructor.id)
 
-      this.enter(span, { ...store, req, res })
+    this.enter(span, { ...store, req, res })
 
-      const context = web.getContext(req)
+    const context = web.getContext(req)
 
-      if (!context.instrumented) {
-        context.res.writeHead = web.wrapWriteHead(context)
-        context.instrumented = true
-      }
-    })
+    if (!context.instrumented) {
+      context.res.writeHead = web.wrapWriteHead(context)
+      context.instrumented = true
+    }
+  }
 
-    this.addSub('apm:http2:server:request:error', (error) => {
-      web.addError(error)
-    })
+  finish ({ req }) {
+    const context = web.getContext(req)
 
-    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.
 
-      if (!context || !context.res) return // Not created by a http.Server instance.
+    web.finishAll(context)
+  }
 
-      web.finishAll(context)
-    })
+  error (error) {
+    web.addError(error)
   }
 
   configure (config) {

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

@@ -6,7 +6,12 @@ class KafkajsConsumerPlugin extends ConsumerPlugin {
   static get id () { return 'kafkajs' }
   static get operation () { return 'consume' }
 
-  start ({ topic, partition, message }) {
+  start ({ topic, partition, message, groupId }) {
+    if (this.config.dsmEnabled) {
+      this.tracer.decodeDataStreamsContext(message.headers['dd-pathway-ctx'])
+      this.tracer
+        .setCheckpoint(['direction:in', `group:${groupId}`, `topic:${topic}`, 'type:kafka'])
+    }
     const childOf = extract(this.tracer, message.headers)
     this.startSpan({
       childOf,

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

@@ -1,12 +1,19 @@
 'use strict'
 
 const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
+const { encodePathwayContext } = require('../../dd-trace/src/datastreams/pathway')
 
 class KafkajsProducerPlugin extends ProducerPlugin {
   static get id () { return 'kafkajs' }
   static get operation () { return 'produce' }
 
   start ({ topic, messages }) {
+    let pathwayCtx
+    if (this.config.dsmEnabled) {
+      const dataStreamsContext = this.tracer
+        .setCheckpoint(['direction:out', `topic:${topic}`, 'type:kafka'])
+      pathwayCtx = encodePathwayContext(dataStreamsContext)
+    }
     const span = this.startSpan({
       resource: topic,
       meta: {
@@ -17,9 +24,9 @@ class KafkajsProducerPlugin extends ProducerPlugin {
         'kafka.batch_size': messages.length
       }
     })
-
     for (const message of messages) {
       if (typeof message === 'object') {
+        if (this.config.dsmEnabled) message.headers['dd-pathway-ctx'] = pathwayCtx
         this.tracer.inject(span, 'text_map', message.headers)
       }
     }

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

@@ -70,7 +70,7 @@ class MochaPlugin extends CiPlugin {
     this.addSub('ci:mocha:test-suite:finish', (status) => {
       const store = storage.getStore()
       if (store && store.span) {
-        const span = storage.getStore().span
+        const span = store.span
         // the test status of the suite may have been set in ci:mocha:test-suite:error already
         if (!span.context()._tags[TEST_STATUS]) {
           span.setTag(TEST_STATUS, status)
@@ -82,7 +82,7 @@ class MochaPlugin extends CiPlugin {
     this.addSub('ci:mocha:test-suite:error', (err) => {
       const store = storage.getStore()
       if (store && store.span) {
-        const span = storage.getStore().span
+        const span = store.span
         span.setTag('error', err)
         span.setTag(TEST_STATUS, 'fail')
       }
@@ -99,7 +99,7 @@ class MochaPlugin extends CiPlugin {
       const store = storage.getStore()
 
       if (store && store.span) {
-        const span = storage.getStore().span
+        const span = store.span
 
         span.setTag(TEST_STATUS, status)
 

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

@@ -8,8 +8,8 @@ class MoleculerClientPlugin extends ClientPlugin {
   static get operation () { return 'call' }
 
   start ({ actionName, opts }) {
-    const span = this.startSpan('moleculer.call', {
-      service: this.config.service,
+    const span = this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: actionName,
       kind: 'client'
     })
@@ -29,7 +29,7 @@ class MoleculerClientPlugin extends ClientPlugin {
       span.addTags(moleculerTags(broker, ctx, this.config))
     }
 
-    span.finish()
+    super.finish()
   }
 }
 

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

@@ -10,9 +10,9 @@ class MoleculerServerPlugin extends ServerPlugin {
   start ({ action, ctx, broker }) {
     const followsFrom = this.tracer.extract('text_map', ctx.meta)
 
-    this.startSpan('moleculer.action', {
+    this.startSpan(this.operationName(), {
       childOf: followsFrom || this.activeSpan,
-      service: this.config.service,
+      service: this.config.service || this.serviceName(),
       resource: action.name,
       kind: 'server',
       type: 'web',

package/packages/datadog-plugin-mongodb-core/src/index.js

@@ -5,17 +5,19 @@ const DatabasePlugin = require('../../dd-trace/src/plugins/database')
 class MongodbCorePlugin extends DatabasePlugin {
   static get id () { return 'mongodb-core' }
   static get component () { return 'mongodb' }
-
+  // avoid using db.name for peer.service since it includes the collection name
+  // should be removed if one day this will be fixed
+  static get peerServicePrecursors () { return [] }
   start ({ ns, ops, options = {}, name }) {
     const query = getQuery(ops)
     const resource = truncate(getResource(this, ns, query, name))
-
-    this.startSpan('mongodb.query', {
-      service: this.config.service,
+    this.startSpan(this.operationName(), {
+      service: this.serviceName(this.config),
       resource,
       type: 'mongodb',
       kind: 'client',
       meta: {
+        // this is not technically correct since it includes the collection but we changing will break customer stuff
         'db.name': ns,
         'mongodb.query': query,
         'out.host': options.host,
@@ -23,6 +25,15 @@ class MongodbCorePlugin extends DatabasePlugin {
       }
     })
   }
+
+  getPeerService (tags) {
+    const ns = tags['db.name']
+    if (ns && tags['peer.service'] === undefined) {
+      // the mongo ns is either dbName either dbName.collection. So we keep the first part
+      tags['peer.service'] = ns.split('.', 1)[0]
+    }
+    return super.getPeerService(tags)
+  }
 }
 
 function getQuery (cmd) {

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

@@ -1,84 +1,82 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { storage } = require('../../datadog-core')
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
-class NextPlugin extends Plugin {
+class NextPlugin extends ServerPlugin {
   static get id () {
     return 'next'
   }
 
   constructor (...args) {
     super(...args)
-
     this._requests = new WeakMap()
+    this.addSub('apm:next:page:load', message => this.pageLoad(message))
+  }
 
-    this.addSub('apm:next:request:start', ({ req, res }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('next.request', {
-        childOf,
-        tags: {
-          [COMPONENT]: this.constructor.id,
-          'service.name': this.config.service || this.tracer._service,
-          'resource.name': req.method,
-          'span.type': 'web',
-          'span.kind': 'server',
-          'http.method': req.method
-        }
-      })
-
-      analyticsSampler.sample(span, this.config.measured, true)
-
-      this.enter(span, store)
-
-      this._requests.set(span, req)
+  start ({ req, res }) {
+    const store = storage.getStore()
+    const childOf = store ? store.span : store
+    const span = this.tracer.startSpan('next.request', {
+      childOf,
+      tags: {
+        [COMPONENT]: this.constructor.id,
+        'service.name': this.config.service || this.tracer._service,
+        'resource.name': req.method,
+        'span.type': 'web',
+        'span.kind': 'server',
+        'http.method': req.method
+      }
     })
 
-    this.addSub('apm:next:request:error', this.addError)
+    analyticsSampler.sample(span, this.config.measured, true)
 
-    this.addSub('apm:next:request:finish', ({ req, res }) => {
-      const store = storage.getStore()
+    this.enter(span, store)
 
-      if (!store) return
+    this._requests.set(span, req)
+  }
 
-      const span = store.span
-      const error = span.context()._tags['error']
+  finish ({ req, res }) {
+    const store = storage.getStore()
 
-      if (!this.config.validateStatus(res.statusCode) && !error) {
-        span.setTag('error', true)
-      }
+    if (!store) return
 
-      span.addTags({
-        'http.status_code': res.statusCode
-      })
+    const span = store.span
+    const error = span.context()._tags['error']
 
-      this.config.hooks.request(span, req, res)
+    if (!this.config.validateStatus(res.statusCode) && !error) {
+      span.setTag('error', true)
+    }
 
-      span.finish()
+    span.addTags({
+      'http.status_code': res.statusCode
     })
 
-    this.addSub('apm:next:page:load', ({ page }) => {
-      const store = storage.getStore()
+    this.config.hooks.request(span, req, res)
 
-      if (!store) return
+    span.finish()
+  }
 
-      const span = store.span
-      const req = this._requests.get(span)
+  pageLoad ({ page }) {
+    const store = storage.getStore()
 
-      // Only use error page names if there's not already a name
-      const current = span.context()._tags['next.page']
-      if (current && (page === '/404' || page === '/500' || page === '/_error')) {
-        return
-      }
+    if (!store) return
 
-      span.addTags({
-        [COMPONENT]: this.constructor.id,
-        'resource.name': `${req.method} ${page}`.trim(),
-        'next.page': page
-      })
+    const span = store.span
+    const req = this._requests.get(span)
+
+    // Only use error page names if there's not already a name
+    const current = span.context()._tags['next.page']
+    if (current && (page === '/404' || page === '/500' || page === '/_error')) {
+      return
+    }
+
+    span.addTags({
+      [COMPONENT]: this.constructor.id,
+      'resource.name': `${req.method} ${page}`.trim(),
+      'next.page': page
     })
   }