dd-trace 4.30.0 → 4.32.0

package/packages/dd-trace/src/opentracing/propagation/text_map.js

@@ -171,6 +171,14 @@ class TextMapPropagator {
     carrier[traceparentKey] = spanContext.toTraceparent()
 
     ts.forVendor('dd', state => {
+      if (!spanContext._isRemote) {
+        // SpanContext was created by a ddtrace span.
+        // Last datadog span id should be set to the current span.
+        state.set('p', spanContext._spanId)
+      } else if (spanContext._trace.tags['_dd.parent_id']) {
+        // Propagate the last Datadog span id set on the remote span.
+        state.set('p', spanContext._trace.tags['_dd.parent_id'])
+      }
       state.set('s', priority)
       if (mechanism) {
         state.set('t.dm', `-${mechanism}`)
@@ -279,7 +287,8 @@ class TextMapPropagator {
         return new DatadogSpanContext({
           traceId: id(),
           spanId: null,
-          sampling: { priority }
+          sampling: { priority },
+          isRemote: true
         })
       }
 
@@ -327,6 +336,7 @@ class TextMapPropagator {
       const spanContext = new DatadogSpanContext({
         traceId: id(traceId, 16),
         spanId: id(spanId, 16),
+        isRemote: true,
         sampling: { priority: parseInt(flags, 10) & 1 ? 1 : 0 },
         traceparent,
         tracestate
@@ -337,6 +347,10 @@ class TextMapPropagator {
       tracestate.forVendor('dd', state => {
         for (const [key, value] of state.entries()) {
           switch (key) {
+            case 'p': {
+              spanContext._trace.tags['_dd.parent_id'] = value
+              break
+            }
             case 's': {
               const priority = parseInt(value, 10)
               if (!Number.isInteger(priority)) continue
@@ -367,6 +381,10 @@ class TextMapPropagator {
         }
       })
 
+      if (!spanContext._trace.tags['_dd.parent_id']) {
+        spanContext._trace.tags['_dd.parent_id'] = '0000000000000000'
+      }
+
       this._extractBaggageItems(carrier, spanContext)
       return spanContext
     }
@@ -379,7 +397,8 @@ class TextMapPropagator {
 
       return new DatadogSpanContext({
         traceId: id(carrier[traceKey], radix),
-        spanId: id(carrier[spanKey], radix)
+        spanId: id(carrier[spanKey], radix),
+        isRemote: true
       })
     }
 

package/packages/dd-trace/src/opentracing/span.js

@@ -266,6 +266,8 @@ class DatadogSpan {
     if (startTime) {
       spanContext._trace.startTime = startTime
     }
+    // SpanContext was NOT propagated from a remote parent
+    spanContext._isRemote = false
 
     return spanContext
   }

package/packages/dd-trace/src/opentracing/span_context.js

@@ -11,6 +11,7 @@ class DatadogSpanContext {
 
     this._traceId = props.traceId
     this._spanId = props.spanId
+    this._isRemote = props.isRemote ?? true
     this._parentId = props.parentId || null
     this._name = props.name
     this._isFinished = props.isFinished || false

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

@@ -4,7 +4,6 @@ const { channel } = require('dc-polyfill')
 const { isFalse } = require('./util')
 const plugins = require('./plugins')
 const log = require('./log')
-const Nomenclature = require('./service-naming')
 
 const loadChannel = channel('dd-trace:instrumentation:load')
 
@@ -102,7 +101,7 @@ module.exports = class PluginManager {
   // like instrumenter.enable()
   configure (config = {}) {
     this._tracerConfig = config
-    Nomenclature.configure(config)
+    this._tracer._nomenclature.configure(config)
 
     for (const name in pluginClasses) {
       this.loadPlugin(name)

package/packages/dd-trace/src/plugins/apollo.js

@@ -0,0 +1,50 @@
+const TracingPlugin = require('./tracing')
+const { storage } = require('../../../datadog-core')
+
+class ApolloBasePlugin extends TracingPlugin {
+  static get id () { return 'apollo.gateway' }
+  static get type () { return 'web' }
+  static get kind () { return 'server' }
+
+  bindStart (ctx) {
+    const store = storage.getStore()
+    const childOf = store ? store.span : null
+
+    const span = this.startSpan(this.getOperationName(), {
+      childOf,
+      service: this.getServiceName(),
+      type: this.constructor.type,
+      kind: this.constructor.kind,
+      meta: {}
+    }, false)
+
+    ctx.parentStore = store
+    ctx.currentStore = { ...store, span }
+
+    return ctx.currentStore
+  }
+
+  end (ctx) {
+    ctx?.currentStore?.span.finish()
+  }
+
+  asyncStart (ctx) {
+    ctx?.currentStore?.span.finish()
+    return ctx.parentStore
+  }
+
+  getServiceName () {
+    return this.serviceName({
+      id: `${this.constructor.id}.${this.constructor.operation}`,
+      pluginConfig: this.config
+    })
+  }
+
+  getOperationName () {
+    return this.operationName({
+      id: `${this.constructor.id}.${this.constructor.operation}`
+    })
+  }
+}
+
+module.exports = ApolloBasePlugin

package/packages/dd-trace/src/plugins/composite.js

@@ -12,6 +12,7 @@ class CompositePlugin extends Plugin {
   }
 
   configure (config) {
+    super.configure(config)
     for (const name in this.constructor.plugins) {
       const pluginConfig = config[name] === false ? false : {
         ...config,

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

@@ -1,6 +1,7 @@
 'use strict'
 
 module.exports = {
+  get '@apollo/gateway' () { return require('../../../datadog-plugin-apollo/src') },
   get '@aws-sdk/smithy-client' () { return require('../../../datadog-plugin-aws-sdk/src') },
   get '@cucumber/cucumber' () { return require('../../../datadog-plugin-cucumber/src') },
   get '@playwright/test' () { return require('../../../datadog-plugin-playwright/src') },

package/packages/dd-trace/src/plugins/tracing.js

@@ -4,7 +4,6 @@ const Plugin = require('./plugin')
 const { storage } = require('../../../datadog-core')
 const analyticsSampler = require('../analytics_sampler')
 const { COMPONENT } = require('../constants')
-const Nomenclature = require('../service-naming')
 
 class TracingPlugin extends Plugin {
   constructor (...args) {
@@ -29,7 +28,7 @@ class TracingPlugin extends Plugin {
       kind = this.constructor.kind
     } = opts
 
-    return Nomenclature.serviceName(type, kind, id, opts)
+    return this._tracer._nomenclature.serviceName(type, kind, id, opts)
   }
 
   operationName (opts = {}) {
@@ -39,7 +38,7 @@ class TracingPlugin extends Plugin {
       kind = this.constructor.kind
     } = opts
 
-    return Nomenclature.opName(type, kind, id, opts)
+    return this._tracer._nomenclature.opName(type, kind, id, opts)
   }
 
   configure (config) {
@@ -58,8 +57,12 @@ class TracingPlugin extends Plugin {
     this.activeSpan?.finish()
   }
 
-  error (error) {
-    this.addError(error)
+  error (ctxOrError) {
+    if (ctxOrError?.currentStore) {
+      ctxOrError.currentStore?.span.setTag('error', ctxOrError?.error)
+      return
+    }
+    this.addError(ctxOrError)
   }
 
   addTraceSubs () {

package/packages/dd-trace/src/plugins/util/test.js

@@ -52,7 +52,7 @@ const TEST_SKIPPED_BY_ITR = 'test.skipped_by_itr'
 const TEST_CONFIGURATION_BROWSER_NAME = 'test.configuration.browser_name'
 // Early flake detection
 const TEST_IS_NEW = 'test.is_new'
-const TEST_EARLY_FLAKE_IS_RETRY = 'test.early_flake.is_retry'
+const TEST_IS_RETRY = 'test.is_retry'
 const TEST_EARLY_FLAKE_IS_ENABLED = 'test.early_flake.is_enabled'
 
 const CI_APP_ORIGIN = 'ciapp-test'
@@ -101,7 +101,7 @@ module.exports = {
   TEST_SKIPPED_BY_ITR,
   TEST_CONFIGURATION_BROWSER_NAME,
   TEST_IS_NEW,
-  TEST_EARLY_FLAKE_IS_RETRY,
+  TEST_IS_RETRY,
   TEST_EARLY_FLAKE_IS_ENABLED,
   getTestEnvironmentMetadata,
   getTestParametersString,

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

@@ -1,5 +1,6 @@
 'use strict'
 
+const RateLimiter = require('./rate_limiter')
 const Sampler = require('./sampler')
 const { setSamplingRules } = require('./startup-log')
 const SamplingRule = require('./sampling_rule')
@@ -43,6 +44,7 @@ class PrioritySampler {
   configure (env, { sampleRate, rateLimit = 100, rules = [] } = {}) {
     this._env = env
     this._rules = this._normalizeRules(rules, sampleRate, rateLimit)
+    this._limiter = new RateLimiter(rateLimit)
 
     setSamplingRules(this._rules)
   }
@@ -136,14 +138,17 @@ class PrioritySampler {
     context._trace[SAMPLING_RULE_DECISION] = rule.sampleRate
     context._sampling.mechanism = SAMPLING_MECHANISM_RULE
 
-    const sampled = rule.sample()
-    const priority = sampled ? USER_KEEP : USER_REJECT
+    return rule.sample() && this._isSampledByRateLimit(context)
+      ? USER_KEEP
+      : USER_REJECT
+  }
 
-    if (sampled) {
-      context._trace[SAMPLING_LIMIT_DECISION] = rule.effectiveRate
-    }
+  _isSampledByRateLimit (context) {
+    const allowed = this._limiter.isAllowed()
+
+    context._trace[SAMPLING_LIMIT_DECISION] = this._limiter.effectiveRate()
 
-    return priority
+    return allowed
   }
 
   _getPriorityByAgent (context) {

package/packages/dd-trace/src/profiling/profilers/events.js

@@ -15,6 +15,8 @@ const MS_TO_NS = 1000000
 const pprofValueType = 'timeline'
 const pprofValueUnit = 'nanoseconds'
 
+const dateOffset = BigInt(Math.round(performance.timeOrigin * MS_TO_NS))
+
 function labelFromStr (stringTable, key, valStr) {
   return new Label({ key, str: stringTable.dedup(valStr) })
 }
@@ -146,6 +148,76 @@ if (node16) {
   decoratorTypes.net = NetDecorator
 }
 
+// Translates performance entries into pprof samples.
+class EventSerializer {
+  constructor () {
+    this.stringTable = new StringTable()
+    this.samples = []
+    this.locations = []
+    this.functions = []
+    this.decorators = {}
+
+    // A synthetic single-frame location to serve as the location for timeline
+    // samples. We need these as the profiling backend (mimicking official pprof
+    // tool's behavior) ignores these.
+    const fn = new Function({ id: this.functions.length + 1, name: this.stringTable.dedup('') })
+    this.functions.push(fn)
+    const line = new Line({ functionId: fn.id })
+    const location = new Location({ id: this.locations.length + 1, line: [line] })
+    this.locations.push(location)
+    this.locationId = [location.id]
+
+    this.timestampLabelKey = this.stringTable.dedup(END_TIMESTAMP_LABEL)
+  }
+
+  addEvent (item) {
+    const { entryType, startTime, duration } = item
+    let decorator = this.decorators[entryType]
+    if (!decorator) {
+      const DecoratorCtor = decoratorTypes[entryType]
+      if (DecoratorCtor) {
+        decorator = new DecoratorCtor(this.stringTable)
+        decorator.eventTypeLabel = labelFromStrStr(this.stringTable, 'event', entryType)
+        this.decorators[entryType] = decorator
+      } else {
+        // Shouldn't happen but it's better to not rely on observer only getting
+        // requested event types.
+        return
+      }
+    }
+    const endTime = startTime + duration
+    const sampleInput = {
+      value: [Math.round(duration * MS_TO_NS)],
+      locationId: this.locationId,
+      label: [
+        decorator.eventTypeLabel,
+        new Label({ key: this.timestampLabelKey, num: dateOffset + BigInt(Math.round(endTime * MS_TO_NS)) })
+      ]
+    }
+    decorator.decorateSample(sampleInput, item)
+    this.samples.push(new Sample(sampleInput))
+  }
+
+  createProfile (startDate, endDate) {
+    const timeValueType = new ValueType({
+      type: this.stringTable.dedup(pprofValueType),
+      unit: this.stringTable.dedup(pprofValueUnit)
+    })
+
+    return new Profile({
+      sampleType: [timeValueType],
+      timeNanos: endDate.getTime() * MS_TO_NS,
+      periodType: timeValueType,
+      period: 1,
+      durationNanos: (endDate.getTime() - startDate.getTime()) * MS_TO_NS,
+      sample: this.samples,
+      location: this.locations,
+      function: this.functions,
+      stringTable: this.stringTable
+    })
+  }
+}
+
 /**
  * This class generates pprof files with timeline events sourced from Node.js
  * performance measurement APIs.
@@ -155,7 +227,7 @@ class EventsProfiler {
     this.type = 'events'
     this._flushIntervalNanos = (options.flushInterval || 60000) * 1e6 // 60 sec
     this._observer = undefined
-    this.entries = []
+    this.eventSerializer = new EventSerializer()
   }
 
   start () {
@@ -163,7 +235,9 @@ class EventsProfiler {
     if (this._observer) return
 
     function add (items) {
-      this.entries.push(...items.getEntries())
+      for (const item of items.getEntries()) {
+        this.eventSerializer.addEvent(item)
+      }
     }
     this._observer = new PerformanceObserver(add.bind(this))
     this._observer.observe({ entryTypes: Object.keys(decoratorTypes) })
@@ -177,89 +251,12 @@ class EventsProfiler {
   }
 
   profile (restart, startDate, endDate) {
-    if (this.entries.length === 0) {
-      // No events in the period; don't produce a profile
-      return null
-    }
-
-    const stringTable = new StringTable()
-    const locations = []
-    const functions = []
-
-    // A synthetic single-frame location to serve as the location for timeline
-    // samples. We need these as the profiling backend (mimicking official pprof
-    // tool's behavior) ignores these.
-    const locationId = (() => {
-      const fn = new Function({ id: functions.length + 1, name: stringTable.dedup('') })
-      functions.push(fn)
-      const line = new Line({ functionId: fn.id })
-      const location = new Location({ id: locations.length + 1, line: [line] })
-      locations.push(location)
-      return [location.id]
-    })()
-
-    const decorators = {}
-    for (const [eventType, DecoratorCtor] of Object.entries(decoratorTypes)) {
-      const decorator = new DecoratorCtor(stringTable)
-      decorator.eventTypeLabel = labelFromStrStr(stringTable, 'event', eventType)
-      decorators[eventType] = decorator
-    }
-    const timestampLabelKey = stringTable.dedup(END_TIMESTAMP_LABEL)
-
-    const dateOffset = BigInt(Math.round(performance.timeOrigin * MS_TO_NS))
-    const lateEntries = []
-    const perfEndDate = endDate.getTime() - performance.timeOrigin
-    const samples = this.entries.map((item) => {
-      const decorator = decorators[item.entryType]
-      if (!decorator) {
-        // Shouldn't happen but it's better to not rely on observer only getting
-        // requested event types.
-        return null
-      }
-      const { startTime, duration } = item
-      if (startTime >= perfEndDate) {
-        // An event past the current recording end date; save it for the next
-        // profile. Not supposed to happen as long as there's no async activity
-        // between capture of the endDate value in profiler.js _collect() and
-        // here, but better be safe than sorry.
-        lateEntries.push(item)
-        return null
-      }
-      const endTime = startTime + duration
-      const sampleInput = {
-        value: [Math.round(duration * MS_TO_NS)],
-        locationId,
-        label: [
-          decorator.eventTypeLabel,
-          new Label({ key: timestampLabelKey, num: dateOffset + BigInt(Math.round(endTime * MS_TO_NS)) })
-        ]
-      }
-      decorator.decorateSample(sampleInput, item)
-      return new Sample(sampleInput)
-    }).filter(v => v)
-
-    this.entries = lateEntries
-
-    const timeValueType = new ValueType({
-      type: stringTable.dedup(pprofValueType),
-      unit: stringTable.dedup(pprofValueUnit)
-    })
-
     if (!restart) {
       this.stop()
     }
-
-    return new Profile({
-      sampleType: [timeValueType],
-      timeNanos: endDate.getTime() * MS_TO_NS,
-      periodType: timeValueType,
-      period: 1,
-      durationNanos: (endDate.getTime() - startDate.getTime()) * MS_TO_NS,
-      sample: samples,
-      location: locations,
-      function: functions,
-      stringTable: stringTable
-    })
+    const profile = this.eventSerializer.createProfile(startDate, endDate)
+    this.eventSerializer = new EventSerializer()
+    return profile
   }
 
   encode (profile) {

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

@@ -6,6 +6,7 @@ const runtimeMetrics = require('./runtime_metrics')
 const log = require('./log')
 const { setStartupLogPluginManager } = require('./startup-log')
 const telemetry = require('./telemetry')
+const nomenclature = require('./service-naming')
 const PluginManager = require('./plugin_manager')
 const remoteConfig = require('./appsec/remote_config')
 const AppsecSdk = require('./appsec/sdk')
@@ -17,6 +18,7 @@ class Tracer extends NoopProxy {
     super()
 
     this._initialized = false
+    this._nomenclature = nomenclature
     this._pluginManager = new PluginManager(this)
     this.dogstatsd = new dogstatsd.NoopDogStatsDClient()
     this._tracingInitialized = false

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

@@ -33,6 +33,30 @@ const web = {
     }
   },
   server: {
+    'apollo.gateway.request': {
+      opName: () => 'apollo.gateway.request',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.plan': {
+      opName: () => 'apollo.gateway.plan',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.validate': {
+      opName: () => 'apollo.gateway.validate',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.execute': {
+      opName: () => 'apollo.gateway.execute',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.fetch': {
+      opName: () => 'apollo.gateway.fetch',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.postprocessing': {
+      opName: () => 'apollo.gateway.postprocessing',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
     grpc: {
       opName: () => DD_MAJOR <= 2 ? 'grpc.request' : 'grpc.server',
       serviceName: identityService

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

@@ -32,6 +32,30 @@ const web = {
     }
   },
   server: {
+    'apollo.gateway.request': {
+      opName: () => 'apollo.gateway.request',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.plan': {
+      opName: () => 'apollo.gateway.plan',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.validate': {
+      opName: () => 'apollo.gateway.validate',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.execute': {
+      opName: () => 'apollo.gateway.execute',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.fetch': {
+      opName: () => 'apollo.gateway.fetch',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
+    'apollo.gateway.postprocessing': {
+      opName: () => 'apollo.gateway.postprocessing',
+      serviceName: ({ pluginConfig, tracerService }) => pluginConfig.service || tracerService
+    },
     grpc: {
       opName: () => 'grpc.server.request',
       serviceName: identityService

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

@@ -304,30 +304,41 @@ function updateConfig (changes, config) {
   const application = createAppObject(config)
   const host = createHostObject()
 
-  const names = {
+  const nameMapping = {
     sampleRate: 'DD_TRACE_SAMPLE_RATE',
     logInjection: 'DD_LOG_INJECTION',
     headerTags: 'DD_TRACE_HEADER_TAGS',
     tags: 'DD_TAGS'
   }
 
+  const namesNeedFormatting = new Set(['DD_TAGS', 'peerServiceMapping'])
+
   const configuration = []
+  const names = [] // list of config names whose values have been changed
 
   for (const change of changes) {
-    const name = names[change.name] || change.name
+    const name = nameMapping[change.name] || change.name
+    names.push(name)
     const { origin, value } = change
     const entry = { name, value, origin }
 
     if (Array.isArray(value)) entry.value = value.join(',')
-    if (entry.name === 'DD_TAGS') entry.value = formatMapForTelemetry(entry.value)
+    if (namesNeedFormatting.has(entry.name)) entry.value = formatMapForTelemetry(entry.value)
     if (entry.name === 'url' && entry.value) entry.value = entry.value.toString()
-    if (entry.name === 'peerServiceMapping' || entry.name === 'tags') entry.value = formatMapForTelemetry(entry.value)
 
     configuration.push(entry)
   }
+
+  function isNotModified (entry) {
+    return !names.includes(entry.name)
+  }
+
   if (!configWithOrigin.length) {
     configWithOrigin = configuration
   } else {
+    // update configWithOrigin to contain up-to-date full list of config values for app-extended-heartbeat
+    configWithOrigin = configWithOrigin.filter(isNotModified)
+    configWithOrigin = configWithOrigin.concat(configuration)
     const { reqType, payload } = createPayload('app-client-configuration-change', { configuration })
     sendData(config, application, host, reqType, payload, updateRetryData)
   }