dd-trace 3.3.1 → 3.12.1

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

@@ -1,65 +1,41 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class PGPlugin extends Plugin {
-  static get name () {
-    return 'pg'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:pg:query:start`, ({ params, statement }) => {
-      const service = getServiceName(this.tracer, this.config, params)
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('pg.query', {
-        childOf,
-        tags: {
-          'service.name': service,
-          'span.type': 'sql',
-          'span.kind': 'client',
-          'db.type': 'postgres',
-          'resource.name': statement
-        }
-      })
-
-      if (params) {
-        span.addTags({
-          'db.name': params.database,
-          'db.user': params.user,
-          'out.host': params.host,
-          'out.port': params.port
-        })
+const DatabasePlugin = require('../../dd-trace/src/plugins/database')
+
+class PGPlugin extends DatabasePlugin {
+  static get name () { return 'pg' }
+  static get operation () { return 'query' }
+  static get system () { return 'postgres' }
+
+  start ({ params = {}, query, processId }) {
+    const service = getServiceName(this.config, params)
+    const originalStatement = query.text
+
+    this.startSpan('pg.query', {
+      service,
+      resource: originalStatement,
+      type: 'sql',
+      kind: 'client',
+      meta: {
+        'db.type': 'postgres',
+        'db.pid': processId,
+        'db.name': params.database,
+        'db.user': params.user,
+        'out.host': params.host,
+        'out.port': params.port
       }
-
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:pg:query:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
     })
 
-    this.addSub(`apm:pg:query:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
-    })
+    query.text = this.injectDbmQuery(query.text, service)
   }
 }
 
-function getServiceName (tracer, config, params) {
+function getServiceName (config, params) {
   if (typeof config.service === 'function') {
     return config.service(params)
-  } else if (config.service) {
-    return config.service
-  } else {
-    return `${tracer._service}-postgres`
   }
+
+  return config.service
 }
 
 module.exports = PGPlugin

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

@@ -1,68 +1,27 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const CachePlugin = require('../../dd-trace/src/plugins/cache')
 const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 
-class RedisPlugin extends Plugin {
-  static get name () {
-    return 'redis'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:${this.constructor.name}:command:start`, (
-      { db, command, args, connectionOptions, connectionName }
-    ) => {
-      if (!this.config.filter(command)) {
-        return this.skip()
-      }
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('redis.command', {
-        childOf,
-        tags: {
-          'span.kind': 'client',
-          'resource.name': command,
-          'span.type': 'redis',
-          'db.type': 'redis',
-          'db.name': db || '0',
-          'redis.raw_command': formatCommand(command, args)
-        }
-      })
-
-      span.setTag('service.name', this.config.service || `${span.context()._tags['service.name']}-redis`)
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      if (connectionOptions) {
-        span.addTags({
-          'out.host': connectionOptions.host,
-          'out.port': connectionOptions.port
-        })
+class RedisPlugin extends CachePlugin {
+  static get name () { return 'redis' }
+  static get system () { return 'redis' }
+
+  start ({ db, command, args, connectionOptions = {}, connectionName }) {
+    if (!this.config.filter(command)) return this.skip()
+
+    this.startSpan('redis.command', {
+      service: getService(this.config, connectionName),
+      resource: command,
+      type: 'redis',
+      kind: 'client',
+      meta: {
+        'db.type': 'redis',
+        'db.name': db || '0',
+        'redis.raw_command': formatCommand(command, args),
+        'out.host': connectionOptions.host,
+        'out.port': connectionOptions.port
       }
-
-      if (this.config.splitByInstance && connectionName) {
-        const service = this.config.service
-          ? `${this.config.service}-${connectionName}`
-          : connectionName
-
-        span.setTag('service.name', service)
-      }
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:${this.constructor.name}:command:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-
-    this.addSub(`apm:${this.constructor.name}:command:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
     })
   }
 
@@ -71,6 +30,16 @@ class RedisPlugin extends Plugin {
   }
 }
 
+function getService (config, connectionName) {
+  if (config.splitByInstance && connectionName) {
+    return config.service
+      ? `${config.service}-${connectionName}`
+      : connectionName
+  }
+
+  return config.service
+}
+
 function formatCommand (command, args) {
   command = command.toUpperCase()
 

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

@@ -0,0 +1,55 @@
+'use strict'
+
+const ConsumerPlugin = require('../../dd-trace/src/plugins/consumer')
+const { storage } = require('../../datadog-core')
+
+class RheaConsumerPlugin extends ConsumerPlugin {
+  static get name () { return 'rhea' }
+
+  constructor (...args) {
+    super(...args)
+
+    this.addTraceSub('dispatch', ({ state }) => {
+      const span = storage.getStore().span
+      span.setTag('amqp.delivery.state', state)
+    })
+  }
+
+  start ({ msgObj }) {
+    const name = getResourceNameFromMessage(msgObj)
+    const childOf = extractTextMap(msgObj, this.tracer)
+
+    this.startSpan('amqp.receive', {
+      childOf,
+      service: this.config.service,
+      resource: name,
+      type: 'worker',
+      kind: 'consumer',
+      meta: {
+        'component': 'rhea',
+        'amqp.link.source.address': name,
+        'amqp.link.role': 'receiver'
+      }
+    })
+  }
+}
+
+function getResourceNameFromMessage (msgObj) {
+  let resourceName = 'amq.topic'
+  let options = {}
+  if (msgObj.receiver && msgObj.receiver.options) {
+    options = msgObj.receiver.options
+  }
+  if (options.source && options.source.address) {
+    resourceName = options.source.address
+  }
+  return resourceName
+}
+
+function extractTextMap (msgObj, tracer) {
+  if (msgObj.message) {
+    return tracer.extract('text_map', msgObj.message.delivery_annotations)
+  }
+}
+
+module.exports = RheaConsumerPlugin

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

@@ -1,101 +1,16 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class RheaPlugin extends Plugin {
-  static get name () {
-    return 'rhea'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:rhea:send:start`, ({ targetAddress, host, port, msg }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const name = targetAddress || 'amq.topic'
-      const span = this.tracer.startSpan('amqp.send', {
-        childOf,
-        tags: {
-          'component': 'rhea',
-          'resource.name': name,
-          'service.name': this.config.service || `${this.tracer._service}-amqp-producer`,
-          'span.kind': 'producer',
-          'amqp.link.target.address': name,
-          'amqp.link.role': 'sender',
-          'out.host': host,
-          'out.port': port
-        }
-      })
-      analyticsSampler.sample(span, this.config.measured)
-      addDeliveryAnnotations(msg, this.tracer, span)
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:rhea:receive:start`, ({ msgObj, connection }) => {
-      const name = getResourceNameFromMessage(msgObj)
-
-      const store = storage.getStore()
-      const childOf = extractTextMap(msgObj, this.tracer)
-      const span = this.tracer.startSpan('amqp.receive', {
-        childOf,
-        tags: {
-          'span.type': 'worker',
-          'component': 'rhea',
-          'resource.name': name,
-          'service.name': this.config.service || this.tracer._service,
-          'span.kind': 'consumer',
-          'amqp.link.source.address': name,
-          'amqp.link.role': 'receiver'
-        }
-      })
-      analyticsSampler.sample(span, this.config.measured, true)
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:rhea:error`, error => {
-      storage.getStore().span.setTag('error', error)
-    })
-
-    this.addSub(`apm:rhea:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
-    })
-
-    this.addSub(`apm:rhea:dispatch`, ({ state }) => {
-      const span = storage.getStore().span
-      span.setTag('amqp.delivery.state', state)
-    })
-  }
-}
-
-function getResourceNameFromMessage (msgObj) {
-  let resourceName = 'amq.topic'
-  let options = {}
-  if (msgObj.receiver && msgObj.receiver.options) {
-    options = msgObj.receiver.options
-  }
-  if (options.source && options.source.address) {
-    resourceName = options.source.address
-  }
-  return resourceName
-}
-
-function extractTextMap (msgObj, tracer) {
-  if (msgObj.message) {
-    return tracer.extract('text_map', msgObj.message.delivery_annotations)
-  }
-}
-
-function addDeliveryAnnotations (msg, tracer, span) {
-  if (msg) {
-    msg.delivery_annotations = msg.delivery_annotations || {}
-
-    tracer.inject(span, 'text_map', msg.delivery_annotations)
+const ProducerPlugin = require('./producer')
+const ConsumerPlugin = require('./consumer')
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+
+class RheaPlugin extends CompositePlugin {
+  static get name () { return 'rhea' }
+  static get plugins () {
+    return {
+      producer: ProducerPlugin,
+      consumer: ConsumerPlugin
+    }
   }
 }
 

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

@@ -0,0 +1,45 @@
+'use strict'
+
+const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
+
+class RheaProducerPlugin extends ProducerPlugin {
+  static get name () { return 'rhea' }
+  static get operation () { return 'send' }
+
+  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`,
+      resource: name,
+      kind: 'producer',
+      meta: {
+        'component': 'rhea',
+        'amqp.link.target.address': name,
+        'amqp.link.role': 'sender',
+        'out.host': host,
+        'out.port': port
+      }
+    })
+  }
+
+  encode (msg) {
+    addDeliveryAnnotations(msg, this.tracer, this.activeSpan)
+  }
+}
+
+function addDeliveryAnnotations (msg, tracer, span) {
+  if (msg) {
+    msg.delivery_annotations = msg.delivery_annotations || {}
+
+    tracer.inject(span, 'text_map', msg.delivery_annotations)
+  }
+}
+
+module.exports = RheaProducerPlugin

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

@@ -4,6 +4,7 @@ const web = require('../../dd-trace/src/plugins/util/web')
 const WebPlugin = require('../../datadog-plugin-web/src')
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
 const { storage } = require('../../datadog-core')
+const { COMPONENT } = require('../../dd-trace/src/constants')
 
 class RouterPlugin extends WebPlugin {
   static get name () {
@@ -13,6 +14,7 @@ class RouterPlugin extends WebPlugin {
   constructor (...args) {
     super(...args)
 
+    this._storeStack = []
     this._contexts = new WeakMap()
 
     this.addSub(`apm:${this.constructor.name}:middleware:enter`, ({ req, name, route }) => {
@@ -27,7 +29,9 @@ class RouterPlugin extends WebPlugin {
         context.middleware.push(span)
       }
 
-      this.enter(span)
+      const store = storage.getStore()
+      this._storeStack.push(store)
+      this.enter(span, store)
 
       web.patch(req)
       web.setRoute(req, context.route)
@@ -41,7 +45,7 @@ class RouterPlugin extends WebPlugin {
       context.stack.pop()
     })
 
-    this.addSub(`apm:${this.constructor.name}:middleware:exit`, ({ req }) => {
+    this.addSub(`apm:${this.constructor.name}:middleware:finish`, ({ req }) => {
       const context = this._contexts.get(req)
 
       if (!context || context.middleware.length === 0) return
@@ -49,6 +53,12 @@ class RouterPlugin extends WebPlugin {
       context.middleware.pop().finish()
     })
 
+    this.addSub(`apm:${this.constructor.name}:middleware:exit`, ({ req }) => {
+      const savedStore = this._storeStack.pop()
+      const span = savedStore && savedStore.span
+      this.enter(span, savedStore)
+    })
+
     this.addSub(`apm:${this.constructor.name}:middleware:error`, ({ req, error }) => {
       web.addError(req, error)
 
@@ -97,6 +107,7 @@ class RouterPlugin extends WebPlugin {
     const span = this.tracer.startSpan(`${this.constructor.name}.middleware`, {
       childOf,
       tags: {
+        [COMPONENT]: this.constructor.name,
         'resource.name': name || '<anonymous>'
       }
     })

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

@@ -1,48 +1,31 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-
-class SharedbPlugin extends Plugin {
-  static get name () {
-    return 'sharedb'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:sharedb:request:start`, ({ actionName, request }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('sharedb.request', {
-        childOf,
-        tags: {
-          'service.name': this.config.service || this.tracer._service,
-          'span.kind': 'server',
-          'sharedb.action': actionName,
-          'resource.name': getReadableResourceName(actionName, request.c, request.q)
-        }
-      })
-
-      if (this.config.hooks && this.config.hooks.receive) {
-        this.config.hooks.receive(span, request)
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
+
+class SharedbPlugin extends ServerPlugin {
+  static get name () { return 'sharedb' }
+
+  start ({ actionName, request }) {
+    const span = this.startSpan('sharedb.request', {
+      service: this.config.service,
+      resource: getReadableResourceName(actionName, request.c, request.q),
+      kind: 'server',
+      meta: {
+        'sharedb.action': actionName
       }
-
-      this.enter(span, store)
     })
 
-    this.addSub(`apm:sharedb:request:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
+    if (this.config.hooks && this.config.hooks.receive) {
+      this.config.hooks.receive(span, request)
+    }
+  }
 
-    this.addSub(`apm:sharedb:request:finish`, ({ request, res }) => {
-      const span = storage.getStore().span
-      if (this.config.hooks && this.config.hooks.reply) {
-        this.config.hooks.reply(span, request, res)
-      }
-      span.finish()
-    })
+  finish ({ request, res }) {
+    const span = this.activeSpan
+    if (this.config.hooks && this.config.hooks.reply) {
+      this.config.hooks.reply(span, request, res)
+    }
+    span.finish()
   }
 }
 

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

@@ -1,48 +1,27 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const DatabasePlugin = require('../../dd-trace/src/plugins/database')
 
-class TediousPlugin extends Plugin {
-  static get name () {
-    return 'tedious'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:tedious:request:start`, ({ queryOrProcedure, connectionConfig }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('tedious.request', {
-        childOf,
-        tags: {
-          'span.kind': 'client',
-          'db.type': 'mssql',
-          'span.type': 'sql',
-          'component': 'tedious',
-          'service.name': this.config.service || `${this.tracer._service}-mssql`,
-          'resource.name': queryOrProcedure,
-          'out.host': connectionConfig.server,
-          'out.port': connectionConfig.options.port,
-          'db.user': connectionConfig.userName || connectionConfig.authentication.options.userName,
-          'db.name': connectionConfig.options.database,
-          'db.instance': connectionConfig.options.instanceName
-        }
-      })
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:tedious:request:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
+class TediousPlugin extends DatabasePlugin {
+  static get name () { return 'tedious' }
+  static get operation () { return 'request' } // TODO: change to match other database plugins
+  static get system () { return 'mssql' }
 
-    this.addSub(`apm:tedious:request:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
+  start ({ queryOrProcedure, connectionConfig }) {
+    this.startSpan('tedious.request', {
+      service: this.config.service,
+      resource: queryOrProcedure,
+      type: 'sql',
+      kind: 'client',
+      meta: {
+        'db.type': 'mssql',
+        'component': 'tedious',
+        'out.host': connectionConfig.server,
+        'out.port': connectionConfig.options.port,
+        'db.user': connectionConfig.userName || connectionConfig.authentication.options.userName,
+        'db.name': connectionConfig.options.database,
+        'db.instance': connectionConfig.options.instanceName
+      }
     })
   }
 }

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

@@ -14,5 +14,7 @@ module.exports = {
   HTTP_INCOMING_RESPONSE_HEADERS: 'server.response.headers.no_cookies',
   // TODO: 'server.response.trailers',
   HTTP_INCOMING_REMOTE_IP: 'server.request.client_ip',
-  HTTP_INCOMING_REMOTE_PORT: 'server.request.client_port'
+  HTTP_INCOMING_REMOTE_PORT: 'server.request.client_port',
+
+  HTTP_CLIENT_IP: 'http.client_ip'
 }

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

@@ -0,0 +1,44 @@
+'use strict'
+
+const fs = require('fs')
+let templateHtml, templateJson
+function block (req, res, topSpan, abortController) {
+  let type
+  let body
+
+  // parse the Accept header, ex: Accept: text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8
+  const accept = req.headers.accept && req.headers.accept.split(',').map((str) => str.split(';', 1)[0].trim())
+
+  if (accept && accept.includes('text/html') && !accept.includes('application/json')) {
+    type = 'text/html'
+    body = templateHtml
+  } else {
+    type = 'application/json'
+    body = templateJson
+  }
+
+  topSpan.addTags({
+    'appsec.blocked': 'true'
+  })
+
+  res.statusCode = 403
+  res.setHeader('Content-Type', type)
+  res.setHeader('Content-Length', Buffer.byteLength(body))
+  res.end(body)
+
+  abortController.abort()
+}
+
+function loadTemplates (config) {
+  templateHtml = fs.readFileSync(config.appsec.blockedTemplateHtml)
+  templateJson = fs.readFileSync(config.appsec.blockedTemplateJson)
+}
+
+async function loadTemplatesAsync (config) {
+  templateHtml = await fs.promises.readFile(config.appsec.blockedTemplateHtml)
+  templateJson = await fs.promises.readFile(config.appsec.blockedTemplateJson)
+}
+
+module.exports = {
+  block, loadTemplates, loadTemplatesAsync
+}