dd-trace 2.30.1 → 2.32.0

package/packages/dd-trace/src/service-naming/index.js

@@ -0,0 +1,41 @@
+const { schemaDefinitions } = require('./schemas')
+
+const kindMap = {
+  messaging: {
+    client: 'controlPlane',
+    consumer: 'inbound',
+    producer: 'outbound'
+  }
+}
+
+class SchemaManager {
+  constructor () {
+    this.schemas = schemaDefinitions
+    this.config = { spanAttributeSchema: 'v0' }
+  }
+
+  get schema () {
+    return this.schemas[this.version]
+  }
+
+  get version () {
+    return this.config.spanAttributeSchema
+  }
+
+  opName (type, kind, plugin, opNameArgs) {
+    return this.schema.getOpName(type, kindMap[type][kind], plugin, opNameArgs)
+  }
+
+  serviceName (type, kind, plugin, serviceNameArgs) {
+    return this.schema.getServiceName(type, kindMap[type][kind], plugin, serviceNameArgs)
+  }
+
+  configure (config = {}) {
+    this.config = config
+    Object.values(this.schemas).forEach(schemaDef => {
+      schemaDef.configure(config)
+    })
+  }
+}
+
+module.exports = new SchemaManager()

package/packages/dd-trace/src/service-naming/schemas/definition.js

@@ -0,0 +1,28 @@
+class SchemaDefinition {
+  constructor (schema) {
+    this.schema = schema
+  }
+
+  getSchemaItem (type, subType, plugin) {
+    const schema = this.schema
+    if (schema && schema[type] && schema[type][subType] && schema[type][subType][plugin]) {
+      return schema[type][subType][plugin]
+    }
+  }
+
+  getOpName (type, subType, plugin, opNameArgs) {
+    const item = this.getSchemaItem(type, subType, plugin)
+    return item.opName(opNameArgs)
+  }
+
+  getServiceName (type, subType, plugin, serviceNameArgs) {
+    const item = this.getSchemaItem(type, subType, plugin)
+    return item.serviceName(this.service, serviceNameArgs)
+  }
+
+  configure ({ service }) {
+    this.service = service
+  }
+}
+
+module.exports = SchemaDefinition

package/packages/dd-trace/src/service-naming/schemas/index.js

@@ -0,0 +1,6 @@
+const v0 = require('./v0')
+const v1 = require('./v1')
+
+module.exports = {
+  schemaDefinitions: { v0, v1 }
+}

package/packages/dd-trace/src/service-naming/schemas/v0.js

@@ -0,0 +1,66 @@
+const SchemaDefinition = require('./definition')
+
+function amqpServiceName (service) {
+  return `${service}-amqp`
+}
+
+const schema = {
+  messaging: {
+    outbound: {
+      amqplib: {
+        opName: () => 'amqp.command',
+        serviceName: amqpServiceName
+      },
+      amqp10: {
+        opName: () => 'amqp.send',
+        serviceName: amqpServiceName
+      },
+      'google-cloud-pubsub': {
+        opName: () => 'pubsub.request',
+        serviceName: service => `${service}-pubsub`
+      },
+      kafkajs: {
+        opName: () => 'kafka.produce',
+        serviceName: service => `${service}-kafka`
+      },
+      rhea: {
+        opName: () => 'amqp.send',
+        serviceName: service => `${service}-amqp-producer`
+      }
+    },
+    inbound: {
+      amqplib: {
+        opName: () => 'amqp.command',
+        serviceName: amqpServiceName
+      },
+      amqp10: {
+        opName: () => 'amqp.receive',
+        serviceName: amqpServiceName
+      },
+      'google-cloud-pubsub': {
+        opName: () => 'pubsub.receive',
+        serviceName: service => service
+      },
+      kafkajs: {
+        opName: () => 'kafka.consume',
+        serviceName: service => `${service}-kafka`
+      },
+      rhea: {
+        opName: () => 'amqp.receive',
+        serviceName: service => service
+      }
+    },
+    controlPlane: {
+      amqplib: {
+        opName: () => 'amqp.command',
+        serviceName: amqpServiceName
+      },
+      'google-cloud-pubsub': {
+        opName: () => 'pubsub.request',
+        serviceName: service => `${service}-pubsub`
+      }
+    }
+  }
+}
+
+module.exports = new SchemaDefinition(schema)

package/packages/dd-trace/src/service-naming/schemas/v1.js

@@ -0,0 +1,58 @@
+const SchemaDefinition = require('./definition')
+
+function identityService (service) {
+  return service
+}
+
+const amqpInbound = {
+  opName: () => 'amqp.process',
+  serviceName: identityService
+}
+
+const amqpOutbound = {
+  opName: () => 'amqp.send',
+  serviceName: identityService
+}
+
+const schema = {
+  messaging: {
+    outbound: {
+      amqplib: amqpOutbound,
+      amqp10: amqpOutbound,
+      'google-cloud-pubsub': {
+        opName: () => 'gcp.pubsub.send',
+        serviceName: identityService
+      },
+      kafkajs: {
+        opName: () => 'kafka.send',
+        serviceName: identityService
+      },
+      rhea: amqpOutbound
+    },
+    inbound: {
+      amqplib: amqpInbound,
+      amqp10: amqpInbound,
+      'google-cloud-pubsub': {
+        opName: () => 'gcp.pubsub.process',
+        serviceName: identityService
+      },
+      kafkajs: {
+        opName: () => 'kafka.process',
+        serviceName: identityService
+      },
+      rhea: amqpInbound
+    },
+    controlPlane: {
+      amqplib: {
+        opName: () => 'amqp.command',
+        serviceName: identityService
+      },
+      'google-cloud-pubsub': {
+        opName: () => 'gcp.pubsub.request',
+        serviceName: identityService
+      }
+    }
+  }
+}
+
+module.exports = new SchemaDefinition(schema)

package/packages/dd-trace/src/span_stats.js

@@ -28,7 +28,7 @@ class SpanAggStats {
   }
 
   record (span) {
-    const durationNs = span._duration * 1e6
+    const durationNs = span.duration
     this.hits++
     this.duration += durationNs
 

package/packages/dd-trace/src/telemetry/dependencies.js

@@ -4,7 +4,7 @@ const path = require('path')
 const parse = require('module-details-from-path')
 const requirePackageJson = require('../require-package-json')
 const { sendData } = require('./send-data')
-const dc = require('diagnostics_channel')
+const dc = require('../../../diagnostics_channel')
 const { fileURLToPath } = require('url')
 
 const savedDependencies = new Set()

package/packages/dd-trace/src/telemetry/index.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const tracerVersion = require('../../../../package.json').version
-const dc = require('diagnostics_channel')
+const dc = require('../../../diagnostics_channel')
 const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')

package/packages/diagnostics_channel/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./src')

package/packages/diagnostics_channel/src/index.js

@@ -0,0 +1,57 @@
+'use strict'
+
+const {
+  Channel,
+  channel
+} = require('diagnostics_channel') // eslint-disable-line n/no-restricted-require
+
+const [major, minor] = process.versions.node.split('.')
+const channels = new WeakSet()
+
+// Our own DC with a limited subset of functionality stable across Node versions.
+// TODO: Move the rest of the polyfill here.
+// TODO: Switch to using global subscribe/unsubscribe/hasSubscribers.
+const dc = { channel }
+
+// Prevent going to 0 subscribers to avoid bug in Node.
+// See https://github.com/nodejs/node/pull/47520
+if (major === '19' && minor === '9') {
+  dc.channel = function () {
+    const ch = channel.apply(this, arguments)
+
+    if (!channels.has(ch)) {
+      const subscribe = ch.subscribe
+      const unsubscribe = ch.unsubscribe
+
+      ch.subscribe = function () {
+        delete ch.subscribe
+        delete ch.unsubscribe
+
+        const result = subscribe.apply(this, arguments)
+
+        this.subscribe(() => {}) // Keep it active forever.
+
+        return result
+      }
+
+      if (ch.unsubscribe === Channel.prototype.unsubscribe) {
+        // Needed because another subscriber could have subscribed to something
+        // that we unsubscribe to before the library is loaded.
+        ch.unsubscribe = function () {
+          delete ch.subscribe
+          delete ch.unsubscribe
+
+          this.subscribe(() => {}) // Keep it active forever.
+
+          return unsubscribe.apply(this, arguments)
+        }
+      }
+
+      channels.add(ch)
+    }
+
+    return ch
+  }
+}
+
+module.exports = dc

package/packages/dd-trace/src/appsec/callbacks/ddwaf.js

@@ -1,137 +0,0 @@
-'use strict'
-
-const log = require('../../log')
-const addresses = require('../addresses')
-const Gateway = require('../gateway/engine')
-const Reporter = require('../reporter')
-
-const validAddressSet = new Set(Object.values(addresses))
-
-// TODO: put reusable code in a base class
-class WAFCallback {
-  static loadDDWAF (rules, config) {
-    try {
-      // require in `try/catch` because this can throw at require time
-      const { DDWAF } = require('@datadog/native-appsec')
-
-      return new DDWAF(rules, config)
-    } catch (err) {
-      log.error('AppSec could not load native package. In-app WAF features will not be available.')
-
-      throw err
-    }
-  }
-
-  constructor (rules, config) {
-    const { wafTimeout, obfuscatorKeyRegex, obfuscatorValueRegex } = config
-
-    this.ddwaf = WAFCallback.loadDDWAF(rules, { obfuscatorKeyRegex, obfuscatorValueRegex })
-
-    this.wafTimeout = wafTimeout
-
-    Reporter.metricsQueue.set('_dd.appsec.waf.version', this.ddwaf.constructor.version())
-
-    const { loaded, failed, errors } = this.ddwaf.rulesInfo
-
-    Reporter.metricsQueue.set('_dd.appsec.event_rules.loaded', loaded)
-    Reporter.metricsQueue.set('_dd.appsec.event_rules.error_count', failed)
-    if (failed) Reporter.metricsQueue.set('_dd.appsec.event_rules.errors', JSON.stringify(errors))
-
-    Reporter.metricsQueue.set('manual.keep', 'true')
-
-    this.wafContextCache = new WeakMap()
-
-    // closures are faster than binds
-    const self = this
-    const method = (params, store) => {
-      return self.action(params, store)
-    }
-
-    // might be its own class with more info later
-    const callback = { method }
-
-    const subscribedAddresses = new Set()
-
-    for (const rule of rules.rules) {
-      for (const condition of rule.conditions) {
-        for (const input of condition.parameters.inputs) {
-          const address = input.address.split(':', 2)[0]
-
-          if (!validAddressSet.has(address) || subscribedAddresses.has(address)) continue
-
-          subscribedAddresses.add(address)
-
-          Gateway.manager.addSubscription({ addresses: [address], callback })
-        }
-      }
-    }
-  }
-
-  action (params, store) {
-    let wafContext
-
-    if (store) {
-      const key = store.get('context')
-
-      if (key) {
-        if (this.wafContextCache.has(key)) {
-          wafContext = this.wafContextCache.get(key)
-        } else {
-          wafContext = this.ddwaf.createContext()
-          this.wafContextCache.set(key, wafContext)
-        }
-      }
-    }
-
-    if (!wafContext || wafContext.disposed) {
-      wafContext = this.ddwaf.createContext()
-    }
-
-    // cast status code to string
-    if (params[addresses.HTTP_INCOMING_RESPONSE_CODE]) {
-      params[addresses.HTTP_INCOMING_RESPONSE_CODE] = params[addresses.HTTP_INCOMING_RESPONSE_CODE] + ''
-    }
-
-    try {
-      // TODO: possible optimizaion: only send params that haven't already been sent to this wafContext
-      const start = process.hrtime.bigint()
-
-      const result = wafContext.run(params, this.wafTimeout)
-
-      result.durationExt = parseInt(process.hrtime.bigint() - start)
-
-      return this.applyResult(result, store)
-    } catch (err) {
-      log.error('Error while running the AppSec WAF')
-      log.error(err)
-    } finally {
-      wafContext.dispose()
-    }
-  }
-
-  applyResult (result, store) {
-    Reporter.reportMetrics({
-      duration: result.totalRuntime / 1e3,
-      durationExt: result.durationExt / 1e3,
-      rulesVersion: this.ddwaf.rulesInfo.version
-    }, store)
-
-    if (result.data && result.data !== '[]') {
-      Reporter.reportAttack(result.data, store)
-    }
-
-    return result.actions
-  }
-
-  updateRuleData (ruleData) {
-    this.ddwaf.updateRuleData(ruleData)
-  }
-
-  clear () {
-    this.ddwaf.dispose()
-
-    this.wafContextCache = new WeakMap()
-  }
-}
-
-module.exports = WAFCallback

package/packages/dd-trace/src/appsec/callbacks/index.js

@@ -1,7 +0,0 @@
-'use strict'
-
-// lazy loading
-// TODO: cache the returned value
-module.exports = {
-  get DDWAF () { return require('./ddwaf') }
-}

package/packages/dd-trace/src/appsec/gateway/als.js

@@ -1,6 +0,0 @@
-'use strict'
-
-// TODO: use datadog-core storage instead
-const { AsyncLocalStorage } = require('async_hooks')
-
-module.exports = new AsyncLocalStorage()

package/packages/dd-trace/src/appsec/gateway/engine/engine.js

@@ -1,140 +0,0 @@
-'use strict'
-
-const Runner = require('./runner')
-
-const MAX_CONTEXT_SIZE = 1024
-
-class SubscriptionManager {
-  constructor () {
-    this.addressToSubscriptions = new Map()
-    this.addresses = new Set()
-    this.subscriptions = new Set()
-  }
-
-  clear () {
-    this.addressToSubscriptions = new Map()
-    this.addresses = new Set()
-    this.subscriptions = new Set()
-  }
-
-  addSubscription (subscription) {
-    if (!subscription.addresses.length || this.subscriptions.has(subscription)) return
-
-    for (let i = 0; i < subscription.addresses.length; ++i) {
-      const address = subscription.addresses[i]
-
-      this.addresses.add(address)
-
-      const list = this.addressToSubscriptions.get(address)
-
-      if (list === undefined) {
-        this.addressToSubscriptions.set(address, [subscription])
-      } else {
-        list.push(subscription)
-      }
-    }
-
-    this.subscriptions.add(subscription)
-  }
-
-  matchSubscriptions (newAddresses, allAddresses) {
-    const addresses = new Set()
-    const subscriptions = new Set()
-    const knownSubscriptions = new Set()
-
-    // TODO: possible optimization: collect matchedSubscriptions on the fly in Context#setValue
-    newAddresses.forEach((newAddress) => {
-      const matchedSubscriptions = this.addressToSubscriptions.get(newAddress)
-
-      if (matchedSubscriptions === undefined) return
-
-      for (let j = 0; j < matchedSubscriptions.length; ++j) {
-        const subscription = matchedSubscriptions[j]
-
-        if (knownSubscriptions.has(subscription) === true) continue
-        knownSubscriptions.add(subscription)
-
-        const isFulfilled = subscription.addresses.every(allAddresses.has, allAddresses)
-
-        if (isFulfilled === true) {
-          for (let k = 0; k < subscription.addresses.length; ++k) {
-            addresses.add(subscription.addresses[k])
-          }
-
-          subscriptions.add(subscription)
-        }
-      }
-    })
-
-    return { addresses, subscriptions }
-  }
-
-  dispatch (newAddresses, allAddresses, context) {
-    const matches = this.matchSubscriptions(newAddresses, allAddresses)
-
-    // TODO: possible optimization
-    // check if matches.subscriptions is empty here instead of in runner.js
-
-    const params = {}
-
-    matches.addresses.forEach((address) => {
-      params[address] = context.resolve(address)
-    })
-
-    return Runner.runSubscriptions(matches.subscriptions, params)
-  }
-}
-
-class Context {
-  static setManager (manager) {
-    this.manager = manager
-  }
-
-  constructor () {
-    // TODO: this probably don't need to be a Map()
-    this.store = new Map()
-    this.allAddresses = new Set()
-    this.newAddresses = new Set()
-  }
-
-  clear () {
-    this.store = new Map()
-    this.allAddresses = new Set()
-    this.newAddresses = new Set()
-  }
-
-  setValue (address, value) {
-    if (this.allAddresses.size >= MAX_CONTEXT_SIZE) return this
-
-    // cannot optimize for objects because they're pointers
-    if (typeof value !== 'object') {
-      const oldValue = this.store.get(address)
-      if (oldValue === value) return this
-    }
-
-    this.store.set(address, value)
-    this.allAddresses.add(address)
-    this.newAddresses.add(address)
-
-    return this
-  }
-
-  dispatch () {
-    if (this.newAddresses.size === 0) return []
-
-    const result = Context.manager.dispatch(this.newAddresses, this.allAddresses, this)
-
-    this.newAddresses.clear()
-
-    return result
-  }
-
-  resolve (address) {
-    return this.store.get(address)
-  }
-}
-
-module.exports = {
-  SubscriptionManager,
-  Context
-}

package/packages/dd-trace/src/appsec/gateway/engine/index.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const { SubscriptionManager, Context } = require('./engine')
-const als = require('../als')
-
-const manager = new SubscriptionManager()
-Context.setManager(manager)
-
-function startContext () {
-  const store = new Map()
-
-  store.set('context', new Context())
-
-  als.enterWith(store)
-
-  return store
-}
-
-function getContext () {
-  const store = als.getStore()
-
-  return store && store.get('context')
-}
-
-function needsAddress (address) {
-  return manager.addresses.has(address)
-}
-
-function propagate (data, context = getContext()) {
-  if (!context) return
-
-  const keys = Object.keys(data)
-
-  for (let i = 0; i < keys.length; ++i) {
-    const key = keys[i]
-
-    if (needsAddress(key)) {
-      context.setValue(key, data[key])
-    }
-  }
-
-  return context.dispatch()
-}
-
-module.exports = {
-  manager,
-  startContext,
-  getContext,
-  needsAddress,
-  propagate
-}

package/packages/dd-trace/src/appsec/gateway/engine/runner.js

@@ -1,42 +0,0 @@
-'use strict'
-
-const als = require('../als')
-const log = require('../../../log')
-
-let lock = false // lock to prevent recursive calls to runSubscriptions
-
-function runSubscriptions (subscriptions, params) {
-  const results = []
-
-  if (lock || !subscriptions.size) return results
-  lock = true
-
-  const store = als.getStore()
-
-  // TODO: possible optimization
-  // can we deduplicate those before ?
-  const executedCallbacks = new Set()
-
-  for (const subscription of subscriptions) {
-    if (executedCallbacks.has(subscription.callback)) continue
-    executedCallbacks.add(subscription.callback)
-
-    let result
-
-    try {
-      result = subscription.callback.method(params, store)
-    } catch (err) {
-      log.warn(`Error running subscription ${err}`)
-    }
-
-    results.push(result)
-  }
-
-  lock = false
-
-  return results
-}
-
-module.exports = {
-  runSubscriptions
-}