dd-trace 3.21.0 → 3.22.1

package/packages/datadog-plugin-google-cloud-pubsub/src/client.js

@@ -4,15 +4,16 @@ const ClientPlugin = require('../../dd-trace/src/plugins/client')
 
 class GoogleCloudPubsubClientPlugin extends ClientPlugin {
   static get id () { return 'google-cloud-pubsub' }
+  static get type () { return 'messaging' }
   static get operation () { return 'request' }
 
   start ({ request, api, projectId }) {
     if (api === 'publish') return
 
-    this.startSpan('pubsub.request', {
-      service: this.config.service || `${this.tracer._service}-pubsub`,
+    this.startSpan(this.operationName(), {
+      service: this.config.service || this.serviceName(),
       resource: [api, request.name].filter(x => x).join(' '),
-      kind: 'client',
+      kind: this.constructor.kind,
       meta: {
         'pubsub.method': api,
         'gcloud.project_id': projectId

package/packages/datadog-plugin-google-cloud-pubsub/src/consumer.js

@@ -11,11 +11,9 @@ class GoogleCloudPubsubConsumerPlugin extends ConsumerPlugin {
     const topic = subscription.metadata && subscription.metadata.topic
     const childOf = this.tracer.extract('text_map', message.attributes) || null
 
-    this.startSpan('pubsub.receive', {
+    this.startSpan({
       childOf,
-      service: this.config.service,
       resource: topic,
-      kind: 'consumer',
       type: 'worker',
       meta: {
         'gcloud.project_id': subscription.pubsub.projectId,

package/packages/datadog-plugin-google-cloud-pubsub/src/producer.js

@@ -11,10 +11,8 @@ class GoogleCloudPubsubProducerPlugin extends ProducerPlugin {
 
     const messages = request.messages || []
     const topic = request.topic
-    const span = this.startSpan('pubsub.request', { // TODO: rename
-      service: this.config.service || `${this.tracer._service}-pubsub`,
+    const span = this.startSpan({ // TODO: rename
       resource: `${api} ${topic}`,
-      kind: 'producer',
       meta: {
         'gcloud.project_id': projectId,
         'pubsub.method': api, // TODO: remove

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ClientPlugin = require('../../dd-trace/src/plugins/client')
 const { storage } = require('../../datadog-core')
 const tags = require('../../../ext/tags')
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
@@ -9,97 +9,99 @@ 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 { CLIENT_PORT_KEY, 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
 const HTTP_RESPONSE_HEADERS = tags.HTTP_RESPONSE_HEADERS
 
-class HttpClientPlugin extends Plugin {
+class HttpClientPlugin extends ClientPlugin {
   static get id () {
     return 'http'
   }
 
-  constructor (...args) {
-    super(...args)
-
-    this.addSub('apm:http:client:request:start', ({ args, http }) => {
-      const store = storage.getStore()
-      const options = args.options
-      const agent = options.agent || options._defaultAgent || http.globalAgent
-      const protocol = options.protocol || agent.protocol || 'http:'
-      const hostname = options.hostname || options.host || 'localhost'
-      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 && allowed ? store.span : null
-      const span = this.tracer.startSpan('http.request', {
-        childOf,
-        tags: {
-          [COMPONENT]: this.constructor.id,
-          'span.kind': 'client',
-          'service.name': getServiceName(this.tracer, this.config, options),
-          'resource.name': method,
-          'span.type': 'http',
-          'http.method': method,
-          'http.url': uri,
-          'out.host': hostname
-        }
-      })
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:client:${this.operation}:${eventName}`, handler)
+  }
 
-      // TODO: Figure out a better way to do this for any span.
-      if (!allowed) {
-        span._spanContext._trace.record = false
+  start ({ args, http }) {
+    const store = storage.getStore()
+    const options = args.options
+    const agent = options.agent || options._defaultAgent || http.globalAgent
+    const protocol = options.protocol || agent.protocol || 'http:'
+    const hostname = options.hostname || options.host || 'localhost'
+    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 && allowed ? store.span : null
+    // TODO delegate to super.startspan
+    const span = this.startSpan('http.request', {
+      childOf,
+      meta: {
+        [COMPONENT]: this.constructor.id,
+        'span.kind': 'client',
+        'service.name': getServiceName(this.tracer, this.config, options),
+        'resource.name': method,
+        'span.type': 'http',
+        'http.method': method,
+        'http.url': uri,
+        'out.host': hostname
+      },
+      metrics: {
+        [CLIENT_PORT_KEY]: parseInt(options.port)
       }
+    })
 
-      if (!(hasAmazonSignature(options) || !this.config.propagationFilter(uri))) {
-        this.tracer.inject(span, HTTP_HEADERS, options.headers)
-      }
+    // TODO: Figure out a better way to do this for any span.
+    if (!allowed) {
+      span._spanContext._trace.record = false
+    }
 
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
+    if (!(hasAmazonSignature(options) || !this.config.propagationFilter(uri))) {
+      this.tracer.inject(span, HTTP_HEADERS, options.headers)
+    }
 
-    this.addSub('apm:http:client:request:finish', ({ req, res }) => {
-      const span = storage.getStore().span
-      if (res) {
-        span.setTag(HTTP_STATUS_CODE, res.statusCode)
+    analyticsSampler.sample(span, this.config.measured)
+    this.enter(span, store)
+  }
 
-        if (!this.config.validateStatus(res.statusCode)) {
-          span.setTag('error', 1)
-        }
+  finish ({ req, res }) {
+    const span = storage.getStore().span
+    if (res) {
+      span.setTag(HTTP_STATUS_CODE, res.statusCode)
 
-        addResponseHeaders(res, span, this.config)
+      if (!this.config.validateStatus(res.statusCode)) {
+        span.setTag('error', 1)
       }
 
-      addRequestHeaders(req, span, this.config)
+      addResponseHeaders(res, span, this.config)
+    }
 
-      this.config.hooks.request(span, req, res)
-      span.finish()
-    })
+    addRequestHeaders(req, span, this.config)
 
-    this.addSub('apm:http:client:request:error', errorHandler)
+    this.config.hooks.request(span, req, res)
+    span.finish()
   }
 
-  configure (config) {
-    return super.configure(normalizeClientConfig(config))
-  }
-}
+  error (err) {
+    const span = storage.getStore().span
 
-function errorHandler (err) {
-  const span = storage.getStore().span
+    if (err) {
+      span.addTags({
+        [ERROR_TYPE]: err.name,
+        [ERROR_MESSAGE]: err.message || err.code,
+        [ERROR_STACK]: err.stack
+      })
+    } else {
+      span.setTag('error', 1)
+    }
+  }
 
-  if (err) {
-    span.addTags({
-      [ERROR_TYPE]: err.name,
-      [ERROR_MESSAGE]: err.message || err.code,
-      [ERROR_STACK]: err.stack
-    })
-  } else {
-    span.setTag('error', 1)
+  configure (config) {
+    return super.configure(normalizeClientConfig(config))
   }
 }
 

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

@@ -1,7 +1,7 @@
 'use strict'
 
 const { storage } = require('../../datadog-core')
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ClientPlugin = require('../../dd-trace/src/plugins/client')
 
 const URL = require('url').URL
 const log = require('../../dd-trace/src/log')
@@ -24,7 +24,7 @@ const HTTP2_HEADER_PATH = ':path'
 const HTTP2_HEADER_STATUS = ':status'
 const HTTP2_METHOD_GET = 'GET'
 
-class Http2ClientPlugin extends Plugin {
+class Http2ClientPlugin extends ClientPlugin {
   static get id () {
     return 'http2'
   }
@@ -32,47 +32,6 @@ class Http2ClientPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
-    this.addSub('apm:http2:client:request:start', ({ authority, options, headers = {} }) => {
-      const sessionDetails = extractSessionDetails(authority, options)
-      const path = headers[HTTP2_HEADER_PATH] || '/'
-      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 && allowed ? store.span : null
-      const span = this.tracer.startSpan('http.request', {
-        childOf,
-        tags: {
-          [COMPONENT]: this.constructor.id,
-          [CLIENT_PORT_KEY]: parseInt(sessionDetails.port),
-          [SPAN_KIND]: CLIENT,
-          'service.name': getServiceName(this.tracer, this.config, sessionDetails),
-          'resource.name': method,
-          'span.type': 'http',
-          'http.method': method,
-          'http.url': uri,
-          'out.host': sessionDetails.host
-        }
-      })
-
-      // 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)) {
-        this.tracer.inject(span, HTTP_HEADERS, headers)
-      }
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      this.enter(span, store)
-    })
-
     this.addSub('apm:http2:client:response', (headers) => {
       const span = storage.getStore().span
       const status = headers && headers[HTTP2_HEADER_STATUS]
@@ -85,14 +44,58 @@ class Http2ClientPlugin extends Plugin {
 
       addHeaderTags(span, headers, HTTP_RESPONSE_HEADERS, this.config)
     })
+  }
 
-    this.addSub('apm:http2:client:request:finish', () => {
-      const span = storage.getStore().span
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:client:${this.operation}:${eventName}`, handler)
+  }
 
-      span.finish()
+  start ({ authority, options, headers = {} }) {
+    const sessionDetails = extractSessionDetails(authority, options)
+    const path = headers[HTTP2_HEADER_PATH] || '/'
+    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 && allowed ? store.span : null
+    const span = this.startSpan('http.request', {
+      childOf,
+      meta: {
+        [COMPONENT]: this.constructor.id,
+        [SPAN_KIND]: CLIENT,
+        'service.name': getServiceName(this.tracer, this.config, sessionDetails),
+        'resource.name': method,
+        'span.type': 'http',
+        'http.method': method,
+        'http.url': uri,
+        'out.host': sessionDetails.host
+      },
+      metrics: {
+        [CLIENT_PORT_KEY]: parseInt(sessionDetails.port)
+      }
     })
 
-    this.addSub('apm:http2:client:request:error', this.addError)
+    // 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)) {
+      this.tracer.inject(span, HTTP_HEADERS, headers)
+    }
+
+    analyticsSampler.sample(span, this.config.measured)
+
+    this.enter(span, store)
+  }
+
+  finish () {
+    const span = storage.getStore().span
+    span.finish()
   }
 
   configure (config) {

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

@@ -118,8 +118,8 @@ class JestPlugin extends CiPlugin {
 
     this.addSub('ci:jest:worker-report:coverage', data => {
       const formattedCoverages = JSON.parse(data).map(coverage => ({
-        traceId: id(coverage.traceId),
-        spanId: id(coverage.spanId),
+        sessionId: id(coverage.sessionId),
+        suiteId: id(coverage.suiteId),
         files: coverage.files
       }))
       formattedCoverages.forEach(formattedCoverage => {
@@ -150,9 +150,10 @@ class JestPlugin extends CiPlugin {
      * fetching the ITR config.
      */
     this.addSub('ci:jest:test-suite:code-coverage', (coverageFiles) => {
+      const { _traceId, _spanId } = this.testSuiteSpan.context()
       const formattedCoverage = {
-        traceId: this.testSuiteSpan.context()._traceId,
-        spanId: this.testSuiteSpan.context()._spanId,
+        sessionId: _traceId,
+        suiteId: _spanId,
         files: coverageFiles
       }
       this.tracer._exporter.exportCoverage(formattedCoverage)

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

@@ -8,12 +8,9 @@ class KafkajsConsumerPlugin extends ConsumerPlugin {
 
   start ({ topic, partition, message }) {
     const childOf = extract(this.tracer, message.headers)
-
-    this.startSpan('kafka.consume', {
+    this.startSpan({
       childOf,
-      service: this.config.service || `${this.tracer._service}-kafka`,
       resource: topic,
-      kind: 'consumer',
       type: 'worker',
       meta: {
         'component': 'kafkajs',

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

@@ -7,10 +7,8 @@ class KafkajsProducerPlugin extends ProducerPlugin {
   static get operation () { return 'produce' }
 
   start ({ topic, messages }) {
-    const span = this.startSpan('kafka.produce', {
-      service: this.config.service || `${this.tracer._service}-kafka`,
+    const span = this.startSpan({
       resource: topic,
-      kind: 'producer',
       meta: {
         'component': 'kafkajs',
         'kafka.topic': topic

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

@@ -9,11 +9,10 @@ class MemcachedPlugin extends CachePlugin {
   start ({ client, server, query }) {
     const address = getAddress(client, server, query)
 
-    this.startSpan('memcached.command', {
-      service: this.config.service,
+    this.startSpan({
+      service: this.serviceName(this.config, this.system),
       resource: query.type,
       type: 'memcached',
-      kind: 'client',
       meta: {
         'memcached.command': query.command,
         'out.host': address[0],

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

@@ -36,9 +36,11 @@ class MochaPlugin extends CiPlugin {
       const relativeCoverageFiles = [...coverageFiles, suiteFile]
         .map(filename => getTestSuitePath(filename, this.sourceRoot))
 
+      const { _traceId, _spanId } = testSuiteSpan.context()
+
       const formattedCoverage = {
-        traceId: testSuiteSpan.context()._traceId,
-        spanId: testSuiteSpan.context()._spanId,
+        sessionId: _traceId,
+        suiteId: _spanId,
         files: relativeCoverageFiles
       }
 

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

@@ -27,7 +27,7 @@ class PGPlugin extends DatabasePlugin {
       }
     })
 
-    query.text = this.injectDbmQuery(query.text, service)
+    query.text = this.injectDbmQuery(query.text, service, !!query.name)
   }
 }
 

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

@@ -13,11 +13,10 @@ class RedisPlugin extends CachePlugin {
     const normalizedCommand = command.toUpperCase()
     if (!this.config.filter(normalizedCommand)) return this.skip()
 
-    this.startSpan('redis.command', {
-      service: getService(this.config, connectionName),
+    this.startSpan({
       resource,
+      service: this.serviceName(this.config, this.system, connectionName),
       type: 'redis',
-      kind: 'client',
       meta: {
         'db.type': 'redis',
         'db.name': db || '0',
@@ -33,16 +32,6 @@ class RedisPlugin extends CachePlugin {
   }
 }
 
-function getService (config, connectionName) {
-  if (config.splitByInstance && connectionName) {
-    return config.service
-      ? `${config.service}-${connectionName}`
-      : connectionName
-  }
-
-  return config.service
-}
-
 function formatCommand (command, args) {
   if (!args || command === 'AUTH') return command
 

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

@@ -19,12 +19,10 @@ class RheaConsumerPlugin extends ConsumerPlugin {
     const name = getResourceNameFromMessage(msgObj)
     const childOf = extractTextMap(msgObj, this.tracer)
 
-    this.startSpan('amqp.receive', {
+    this.startSpan({
       childOf,
-      service: this.config.service,
       resource: name,
       type: 'worker',
-      kind: 'consumer',
       meta: {
         'component': 'rhea',
         'amqp.link.source.address': name,

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

@@ -9,17 +9,13 @@ class RheaProducerPlugin extends ProducerPlugin {
 
   constructor (...args) {
     super(...args)
-
     this.addTraceSub('encode', this.encode.bind(this))
   }
 
   start ({ targetAddress, host, port }) {
     const name = targetAddress || 'amq.topic'
-
-    this.startSpan('amqp.send', {
-      service: this.config.service || `${this.tracer._service}-amqp-producer`,
+    this.startSpan({
       resource: name,
-      kind: 'producer',
       meta: {
         'component': 'rhea',
         'amqp.link.target.address': name,

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

@@ -130,7 +130,7 @@ class RouterPlugin extends WebPlugin {
       route = context.stack.join('')
 
       // Longer route is more likely to be the actual route handler route.
-      if (route.length > context.route.length) {
+      if (isMoreSpecificThan(route, context.route)) {
         context.route = route
       }
     } else {
@@ -148,4 +148,15 @@ class RouterPlugin extends WebPlugin {
   }
 }
 
+function isMoreSpecificThan (routeA, routeB) {
+  if (!routeIsRegex(routeA) && routeIsRegex(routeB)) {
+    return true
+  }
+  return routeA.length > routeB.length
+}
+
+function routeIsRegex (route) {
+  return route.includes('(/') && route.includes('/)')
+}
+
 module.exports = RouterPlugin

package/packages/dd-trace/src/appsec/blocked_templates.js

@@ -1,108 +1,9 @@
 /* eslint-disable max-len */
 'use strict'
 
-const html = `<!-- Sorry, you’ve been blocked -->
-<!DOCTYPE html>
-<html lang="en">
+const html = `<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>You've been blocked</title><style>a,body,div,html,span{margin:0;padding:0;border:0;font-size:100%;font:inherit;vertical-align:baseline}body{background:-webkit-radial-gradient(26% 19%,circle,#fff,#f4f7f9);background:radial-gradient(circle at 26% 19%,#fff,#f4f7f9);display:-webkit-box;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-ms-flex-line-pack:center;align-content:center;width:100%;min-height:100vh;line-height:1;flex-direction:column}p{display:block}main{text-align:center;flex:1;display:-webkit-box;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-ms-flex-line-pack:center;align-content:center;flex-direction:column}p{font-size:18px;line-height:normal;color:#646464;font-family:sans-serif;font-weight:400}a{color:#4842b7}footer{width:100%;text-align:center}footer p{font-size:16px}</style></head><body><main><p>Sorry, you cannot access this page. Please contact the customer service team.</p></main><footer><p>Security provided by <a href="https://www.datadoghq.com/product/security-platform/application-security-monitoring/" target="_blank">Datadog</a></p></footer></body></html>`
 
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>You've been blocked</title>
-    <style>
-        a,
-        body,
-        div,
-        html,
-        span {
-            margin: 0;
-            padding: 0;
-            border: 0;
-            font-size: 100%;
-            font: inherit;
-            vertical-align: baseline
-        }
-
-        body {
-            background: -webkit-radial-gradient(26% 19%, circle, #fff, #f4f7f9);
-            background: radial-gradient(circle at 26% 19%, #fff, #f4f7f9);
-            display: -webkit-box;
-            display: -ms-flexbox;
-            display: flex;
-            -webkit-box-pack: center;
-            -ms-flex-pack: center;
-            justify-content: center;
-            -webkit-box-align: center;
-            -ms-flex-align: center;
-            align-items: center;
-            -ms-flex-line-pack: center;
-            align-content: center;
-            width: 100%;
-            min-height: 100vh;
-            line-height: 1;
-            flex-direction: column
-        }
-
-        p {
-            display: block
-        }
-
-
-        main {
-            text-align: center;
-            flex: 1;
-            display: -webkit-box;
-            display: -ms-flexbox;
-            display: flex;
-            -webkit-box-pack: center;
-            -ms-flex-pack: center;
-            justify-content: center;
-            -webkit-box-align: center;
-            -ms-flex-align: center;
-            align-items: center;
-            -ms-flex-line-pack: center;
-            align-content: center;
-            flex-direction: column
-        }
-
-        p {
-            font-size: 18px;
-            line-height: normal;
-            color: #646464;
-            font-family: sans-serif;
-            font-weight: 400
-        }
-
-        a {
-            color: #4842b7
-        }
-
-        footer {
-            width: 100%;
-            text-align: center
-        }
-
-        footer p {
-            font-size: 16px
-        }
-    </style>
-</head>
-
-<body>
-    <main>
-        <p>Sorry, you cannot access this page. Please contact the customer service team.</p>
-    </main>
-    <footer>
-        <p>Security provided by <a
-                href="https://www.datadoghq.com/product/security-platform/application-security-monitoring/"
-                target="_blank">Datadog</a></p>
-    </footer>
-</body>
-
-</html>
-`
-
-const json = `{"errors": [{"title": "You've been blocked", "detail": "Sorry, you cannot access this page. Please contact the customer service team. Security provided by Datadog."}]}`
+const json = `{"errors":[{"title":"You've been blocked","detail":"Sorry, you cannot access this page. Please contact the customer service team. Security provided by Datadog."}]}`
 
 module.exports = {
   html,