dd-trace 2.0.0 → 2.2.0

package/index.d.ts

@@ -406,6 +406,28 @@ export declare interface TracerOptions {
    * @default true
    */
   orphanable?: boolean
+
+  /**
+   * Configuration of the AppSec protection. Can be a boolean as an alias to `appsec.enabled`.
+   */
+  appsec?: boolean | {
+    /**
+     * Whether to enable AppSec.
+     * @default false
+     */
+    enabled?: boolean,
+
+    /**
+     * Specifies a path to a custom rules file.
+     */
+    rules?: string,
+
+    /**
+     * Controls the maximum amount of traces sampled by AppSec attacks, per second.
+     * @default 100
+     */
+    rateLimit?: number
+  };
 }
 
 /** @hidden */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -61,7 +61,7 @@
     "node": ">=12"
   },
   "dependencies": {
-    "@datadog/native-appsec": "^0.8.0",
+    "@datadog/native-appsec": "^0.8.1",
     "@datadog/native-metrics": "^1.1.0",
     "@datadog/pprof": "^0.3.0",
     "@datadog/sketches-js": "^1.0.4",

package/packages/datadog-instrumentations/index.js

@@ -1,10 +1,13 @@
 'use strict'
 
+require('./src/bluebird')
+require('./src/couchbase')
 require('./src/dns')
+require('./src/elasticsearch')
 require('./src/memcached')
 require('./src/mysql')
-require('./src/bluebird')
-require('./src/when')
+require('./src/mysql2')
 require('./src/promise')
-require('./src/q')
 require('./src/promise-js')
+require('./src/q')
+require('./src/when')

package/packages/datadog-instrumentations/src/couchbase.js

@@ -0,0 +1,143 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+addHook({ name: 'couchbase', file: 'lib/bucket.js', versions: ['^2.6.5'] }, Bucket => {
+  const startCh = channel('apm:couchbase:query:start')
+  const asyncEndCh = channel('apm:couchbase:query:async-end')
+  const endCh = channel('apm:couchbase:query:end')
+  const errorCh = channel('apm:couchbase:query:error')
+
+  Bucket.prototype._maybeInvoke = wrapMaybeInvoke(Bucket.prototype._maybeInvoke)
+  Bucket.prototype.query = wrapQuery(Bucket.prototype.query)
+
+  shimmer.wrap(Bucket.prototype, '_n1qlReq', _n1qlReq => function (host, q, adhoc, emitter) {
+    if (!startCh.hasSubscribers) {
+      return _n1qlReq.apply(this, arguments)
+    }
+
+    if (!emitter || !emitter.once) return _n1qlReq.apply(this, arguments)
+
+    const n1qlQuery = q && q.statement
+
+    startCh.publish({ resource: n1qlQuery, bucket: this })
+
+    emitter.once('rows', AsyncResource.bind(() => {
+      asyncEndCh.publish(undefined)
+    }))
+
+    emitter.once('error', AsyncResource.bind((error) => {
+      errorCh.publish(error)
+      asyncEndCh.publish(undefined)
+    }))
+
+    try {
+      return _n1qlReq.apply(this, arguments)
+    } catch (err) {
+      err.stack // trigger getting the stack at the original throwing point
+      errorCh.publish(err)
+
+      throw err
+    } finally {
+      endCh.publish(undefined)
+    }
+  })
+
+  Bucket.prototype.upsert = wrap('apm:couchbase:upsert', Bucket.prototype.upsert)
+  Bucket.prototype.insert = wrap('apm:couchbase:insert', Bucket.prototype.insert)
+  Bucket.prototype.replace = wrap('apm:couchbase:replace', Bucket.prototype.replace)
+  Bucket.prototype.append = wrap('apm:couchbase:append', Bucket.prototype.append)
+  Bucket.prototype.prepend = wrap('apm:couchbase:prepend', Bucket.prototype.prepend)
+
+  return Bucket
+})
+
+addHook({ name: 'couchbase', file: 'lib/cluster.js', versions: ['^2.6.5'] }, Cluster => {
+  Cluster.prototype._maybeInvoke = wrapMaybeInvoke(Cluster.prototype._maybeInvoke)
+  Cluster.prototype.query = wrapQuery(Cluster.prototype.query)
+
+  return Cluster
+})
+
+function findCallbackIndex (args) {
+  for (let i = args.length - 1; i >= 2; i--) {
+    if (typeof args[i] === 'function') return i
+  }
+  return -1
+}
+
+function wrapMaybeInvoke (_maybeInvoke) {
+  const wrapped = function (fn, args) {
+    if (!Array.isArray(args)) return _maybeInvoke.apply(this, arguments)
+
+    const callbackIndex = args.length - 1
+    const callback = args[callbackIndex]
+
+    if (callback instanceof Function) {
+      args[callbackIndex] = AsyncResource.bind(callback)
+    }
+
+    return _maybeInvoke.apply(this, arguments)
+  }
+  return shimmer.wrap(_maybeInvoke, wrapped)
+}
+
+function wrapQuery (query) {
+  const wrapped = function (q, params, callback) {
+    callback = AsyncResource.bind(arguments[arguments.length - 1])
+
+    if (typeof callback === 'function') {
+      arguments[arguments.length - 1] = callback
+    }
+
+    const res = query.apply(this, arguments)
+    return res
+  }
+  return shimmer.wrap(query, wrapped)
+}
+
+function wrap (prefix, fn) {
+  const startCh = channel(prefix + ':start')
+  const endCh = channel(prefix + ':end')
+  const asyncEndCh = channel(prefix + ':async-end')
+  const errorCh = channel(prefix + ':error')
+
+  const wrapped = function (key, value, options, callback) {
+    if (!startCh.hasSubscribers) {
+      return fn.apply(this, arguments)
+    }
+
+    const callbackIndex = findCallbackIndex(arguments)
+
+    if (callbackIndex < 0) return fn.apply(this, arguments)
+
+    const cb = arguments[callbackIndex]
+
+    startCh.publish({ bucket: this })
+
+    arguments[callbackIndex] = function (error, result) {
+      if (error) {
+        errorCh.publish(error)
+      }
+      asyncEndCh.publish(result)
+      return cb.apply(this, arguments)
+    }
+
+    try {
+      return fn.apply(this, arguments)
+    } catch (error) {
+      error.stack // trigger getting the stack at the original throwing point
+      errorCh.publish(error)
+
+      throw error
+    } finally {
+      endCh.publish(undefined)
+    }
+  }
+  return shimmer.wrap(fn, wrapped)
+}

package/packages/datadog-instrumentations/src/elasticsearch.js

@@ -0,0 +1,74 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const startCh = channel('apm:elasticsearch:query:start')
+const asyncEndCh = channel('apm:elasticsearch:query:async-end')
+const endCh = channel('apm:elasticsearch:query:end')
+const errorCh = channel('apm:elasticsearch:query:error')
+
+addHook({ name: '@elastic/elasticsearch', file: 'lib/Transport.js', versions: ['>=5.6.16'] }, Transport => {
+  shimmer.wrap(Transport.prototype, 'request', wrapRequest)
+  return Transport
+})
+
+addHook({ name: 'elasticsearch', file: 'src/lib/transport.js', versions: ['>=10'] }, Transport => {
+  shimmer.wrap(Transport.prototype, 'request', wrapRequest)
+  return Transport
+})
+
+function wrapRequest (request) {
+  return function (params, options, cb) {
+    if (!startCh.hasSubscribers) {
+      return request.apply(this, arguments)
+    }
+
+    if (!params) return request.apply(this, arguments)
+
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+
+    startCh.publish({ params })
+
+    try {
+      const lastIndex = arguments.length - 1
+      cb = arguments[lastIndex]
+
+      if (typeof cb === 'function') {
+        cb = asyncResource.bind(cb)
+
+        arguments[lastIndex] = AsyncResource.bind(function (error) {
+          finish(params, error)
+          return cb.apply(null, arguments)
+        })
+        return request.apply(this, arguments)
+      } else {
+        const promise = request.apply(this, arguments)
+        if (promise && typeof promise.then === 'function') {
+          promise.then(() => finish(params), e => finish(params, e))
+        } else {
+          finish(params)
+        }
+        return promise
+      }
+    } catch (err) {
+      err.stack // trigger getting the stack at the original throwing point
+      errorCh.publish(err)
+
+      throw err
+    } finally {
+      endCh.publish(undefined)
+    }
+  }
+}
+
+function finish (params, error) {
+  if (error) {
+    errorCh.publish(error)
+  }
+  asyncEndCh.publish({ params })
+}

package/packages/datadog-instrumentations/src/mysql.js

@@ -20,9 +20,9 @@ addHook({ name: 'mysql', file: 'lib/Connection.js', versions: ['>=2'] }, Connect
     }
 
     const sql = arguments[0].sql ? arguments[0].sql : arguments[0]
-    const startArgs = [sql, this.config]
+    const conf = this.config
 
-    startCh.publish(startArgs)
+    startCh.publish({ sql, conf })
 
     try {
       const res = query.apply(this, arguments)

package/packages/datadog-instrumentations/src/mysql2.js

@@ -0,0 +1,76 @@
+'use strict'
+
+const {
+  channel,
+  addHook,
+  AsyncResource
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+addHook({ name: 'mysql2', file: 'lib/connection.js', versions: ['>=1'] }, Connection => {
+  const startCh = channel('apm:mysql2:query:start')
+  const asyncEndCh = channel('apm:mysql2:query:async-end')
+  const endCh = channel('apm:mysql2:query:end')
+  const errorCh = channel('apm:mysql2:query:error')
+
+  shimmer.wrap(Connection.prototype, 'addCommand', addCommand => function (cmd) {
+    if (!startCh.hasSubscribers) return addCommand.apply(this, arguments)
+
+    const asyncResource = new AsyncResource('bound-anonymous-fn')
+    const name = cmd && cmd.constructor && cmd.constructor.name
+    const isCommand = typeof cmd.execute === 'function'
+    const isQuery = isCommand && (name === 'Execute' || name === 'Query')
+
+    // TODO: consider supporting all commands and not just queries
+    cmd.execute = isQuery
+      ? wrapExecute(cmd, cmd.execute, asyncResource, this.config)
+      : bindExecute(cmd, cmd.execute, asyncResource)
+
+    return asyncResource.bind(addCommand, this).apply(this, arguments)
+  })
+
+  return Connection
+
+  function bindExecute (cmd, execute, asyncResource) {
+    return asyncResource.bind(function executeWithTrace (packet, connection) {
+      if (this.onResult) {
+        this.onResult = asyncResource.bind(this.onResult)
+      }
+
+      return execute.apply(this, arguments)
+    }, cmd)
+  }
+
+  function wrapExecute (cmd, execute, asyncResource, config) {
+    return asyncResource.bind(function executeWithTrace (packet, connection) {
+      const sql = cmd.statement ? cmd.statement.query : cmd.sql
+
+      startCh.publish({ sql, conf: config })
+
+      if (this.onResult) {
+        const onResult = asyncResource.bind(this.onResult)
+
+        this.onResult = AsyncResource.bind(function (error) {
+          if (error) {
+            errorCh.publish(error)
+          }
+          asyncEndCh.publish(undefined)
+          onResult.apply(this, arguments)
+        }, 'bound-anonymous-fn', this)
+      } else {
+        this.on('error', AsyncResource.bind(error => errorCh.publish(error)))
+        this.on('end', AsyncResource.bind(() => asyncEndCh.publish(undefined)))
+      }
+
+      this.execute = execute
+
+      try {
+        return execute.apply(this, arguments)
+      } catch (err) {
+        errorCh.publish(err)
+      } finally {
+        endCh.publish(undefined)
+      }
+    }, cmd)
+  }
+})

package/packages/datadog-instrumentations/src/q.js

@@ -6,8 +6,16 @@ const shimmer = require('../../datadog-shimmer')
 
 addHook({
   name: 'q',
-  versions: ['>=1']
+  versions: ['1']
 }, Q => {
   shimmer.wrap(Q.makePromise.prototype, 'then', wrapThen)
   return Q
 })
+
+addHook({
+  name: 'q',
+  versions: ['>=2']
+}, Q => {
+  shimmer.wrap(Q.Promise.prototype, 'then', wrapThen)
+  return Q
+})

package/packages/datadog-plugin-aws-sdk/src/helpers.js

@@ -10,7 +10,8 @@ const services = {
   s3: getService(require('./services/s3')),
   redshift: getService(require('./services/redshift')),
   sns: getService(require('./services/sns')),
-  sqs: getService(require('./services/sqs'))
+  sqs: getService(require('./services/sqs')),
+  eventbridge: getService(require('./services/eventbridge'))
 }
 
 function getService (Service) {
@@ -78,8 +79,8 @@ const helpers = {
   requestInject (span, request, serviceName, tracer) {
     if (!span) return
 
-    const inject = services[serviceName] && services[serviceName].requestInject
-    if (inject) inject(span, request, tracer)
+    const service = services[serviceName] && services[serviceName]
+    if (service && service.requestInject) service.requestInject(span, request, tracer)
   },
 
   wrapCb (cb, serviceName, tags, request, tracer, childOf) {

package/packages/datadog-plugin-aws-sdk/src/services/eventbridge.js

@@ -0,0 +1,48 @@
+'use strict'
+const log = require('../../../dd-trace/src/log')
+class EventBridge {
+  generateTags (params, operation, response) {
+    if (!params || !params.source) return {}
+
+    return {
+      'resource.name': `${operation} ${params.source}`,
+      'aws.eventbridge.source': params.source
+    }
+  }
+
+  /**
+   * requestInject
+   * @param {*} span
+   * @param {*} request
+   * @param {*} tracer
+   *
+   * Docs: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html
+   * We cannot use the traceHeader field as that's reserved for X-Ray.
+   * Detail must be a valid JSON string
+   * Max size per event is 256kb (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html)
+   */
+  requestInject (span, request, tracer) {
+    const operation = request.operation
+    if (operation === 'putEvents' &&
+      request.params &&
+      request.params.Entries &&
+      request.params.Entries.length > 0 &&
+      request.params.Entries[0].Detail) {
+      try {
+        const details = JSON.parse(request.params.Entries[0].Detail)
+        details._datadog = {}
+        tracer.inject(span, 'text_map', details._datadog)
+        const finalData = JSON.stringify(details)
+        const byteSize = Buffer.byteLength(finalData)
+        if (byteSize >= (1024 * 256)) {
+          log.info('Payload size too large to pass context')
+          return
+        }
+        request.params.Entries[0].Detail = finalData
+      } catch (e) {
+        log.error(e)
+      }
+    }
+  }
+}
+module.exports = EventBridge

package/packages/datadog-plugin-aws-sdk/src/services/kinesis.js

@@ -1,15 +1,65 @@
 'use strict'
-
+const log = require('../../../dd-trace/src/log')
 class Kinesis {
   generateTags (params, operation, response) {
-    const tags = {}
-
-    if (!params || !params.StreamName) return tags
+    if (!params || !params.StreamName) return {}
 
-    return Object.assign(tags, {
+    return {
       'resource.name': `${operation} ${params.StreamName}`,
       'aws.kinesis.stream_name': params.StreamName
-    })
+    }
+  }
+
+  // AWS-SDK will b64 kinesis payloads
+  // or will accept an already b64 encoded payload
+  // This method handles both
+  _tryParse (body) {
+    try {
+      return JSON.parse(body)
+    } catch (e) {
+      log.info('Not JSON string. Trying Base64 encoded JSON string')
+    }
+    try {
+      return JSON.parse(Buffer.from(body, 'base64').toString('ascii'), true)
+    } catch (e) {
+      return null
+    }
+  }
+
+  requestInject (span, request, tracer) {
+    const operation = request.operation
+    if (operation === 'putRecord' || operation === 'putRecords') {
+      if (!request.params) {
+        return
+      }
+
+      const traceData = {}
+      tracer.inject(span, 'text_map', traceData)
+      let injectPath
+      if (request.params.Records && request.params.Records.length > 0) {
+        injectPath = request.params.Records[0]
+      } else if (request.params.Data) {
+        injectPath = request.params
+      } else {
+        log.error('No valid payload passed, unable to pass trace context')
+        return
+      }
+      const parsedData = this._tryParse(injectPath.Data)
+      if (parsedData) {
+        parsedData._datadog = traceData
+        const finalData = JSON.stringify(parsedData)
+        const byteSize = Buffer.byteLength(finalData, 'ascii')
+        // Kinesis max payload size is 1MB
+        // So we must ensure adding DD context won't go over that (512b is an estimate)
+        if (byteSize >= 1048576) {
+          log.info('Payload size too large to pass context')
+          return
+        }
+        injectPath.Data = finalData
+      } else {
+        log.error('Unable to parse payload, unable to pass trace context')
+      }
+    }
   }
 }
 

package/packages/datadog-plugin-aws-sdk/src/services/sns.js

@@ -1,21 +1,48 @@
 'use strict'
+const log = require('../../../dd-trace/src/log')
 
 class Sns {
   generateTags (params, operation, response) {
-    const tags = {}
+    if (!params) return {}
 
-    if (!params) return tags
+    if (!params.TopicArn && !(response.data && response.data.TopicArn)) return {}
 
-    if (!params.TopicArn && !(response.data && response.data.TopicArn)) return tags
-
-    return Object.assign(tags, {
+    return {
       'resource.name': `${operation} ${params.TopicArn || response.data.TopicArn}`,
       'aws.sns.topic_arn': params.TopicArn || response.data.TopicArn
-    })
+    }
 
     // TODO: should arn be sanitized or quantized in some way here,
     // for example if it contains a phone number?
   }
+
+  requestInject (span, request, tracer) {
+    const operation = request.operation
+    if (operation === 'publish' || operation === 'publishBatch') {
+      if (!request.params) {
+        request.params = {}
+      }
+      let injectPath
+      if (request.params.PublishBatchRequestEntries && request.params.PublishBatchRequestEntries.length > 0) {
+        injectPath = request.params.PublishBatchRequestEntries[0]
+      } else if (request.params.Message) {
+        injectPath = request.params
+      }
+      if (!injectPath.MessageAttributes) {
+        injectPath.MessageAttributes = {}
+      }
+      if (Object.keys(injectPath.MessageAttributes).length >= 10) { // SNS quota
+        log.info('Message attributes full, skipping trace context injection')
+        return
+      }
+      const ddInfo = {}
+      tracer.inject(span, 'text_map', ddInfo)
+      injectPath.MessageAttributes._datadog = {
+        DataType: 'String',
+        StringValue: JSON.stringify(ddInfo)
+      }
+    }
+  }
 }
 
 module.exports = Sns