dd-trace 4.18.0 → 4.19.0

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

@@ -0,0 +1,161 @@
+const { performance, constants, PerformanceObserver } = require('node:perf_hooks')
+const { END_TIMESTAMP, THREAD_NAME, threadNamePrefix } = require('./shared')
+const semver = require('semver')
+const { Function, Label, Line, Location, Profile, Sample, StringTable, ValueType } = require('pprof-format')
+const pprof = require('@datadog/pprof/')
+
+// Format of perf_hooks events changed with Node 16, we need to be mindful of it.
+const node16 = semver.gte(process.version, '16.0.0')
+
+// perf_hooks uses millis, with fractional part representing nanos. We emit nanos into the pprof file.
+const MS_TO_NS = 1000000
+
+// While this is an "events profiler", meaning it emits a pprof file based on events observed as
+// perf_hooks events, the emitted pprof file uses the type "timeline".
+const pprofValueType = 'timeline'
+const pprofValueUnit = 'nanoseconds'
+const threadName = `${threadNamePrefix} GC`
+
+/**
+ * This class generates pprof files with timeline events sourced from Node.js
+ * performance measurement APIs.
+ */
+class EventsProfiler {
+  constructor (options = {}) {
+    this.type = 'events'
+    this._flushIntervalNanos = (options.flushInterval || 60000) * 1e6 // 60 sec
+    this._observer = undefined
+    this.entries = []
+  }
+
+  start () {
+    function add (items) {
+      this.entries.push(...items.getEntries())
+    }
+    if (!this._observer) {
+      this._observer = new PerformanceObserver(add.bind(this))
+    }
+    // Currently only support GC
+    this._observer.observe({ type: 'gc' })
+  }
+
+  stop () {
+    if (this._observer) {
+      this._observer.disconnect()
+    }
+  }
+
+  profile () {
+    const stringTable = new StringTable()
+    const timestampLabelKey = stringTable.dedup(END_TIMESTAMP)
+    const kindLabelKey = stringTable.dedup('gc type')
+    const reasonLabelKey = stringTable.dedup('gc reason')
+    const kindLabels = []
+    const reasonLabels = []
+    const locations = []
+    const functions = []
+    const locationsPerKind = []
+    const flagObj = {}
+
+    function labelFromStr (key, valStr) {
+      return new Label({ key, str: stringTable.dedup(valStr) })
+    }
+
+    function labelFromStrStr (keyStr, valStr) {
+      return labelFromStr(stringTable.dedup(keyStr), valStr)
+    }
+
+    // Create labels for all GC performance flags and kinds of GC
+    for (const [key, value] of Object.entries(constants)) {
+      if (key.startsWith('NODE_PERFORMANCE_GC_FLAGS_')) {
+        flagObj[key.substring(26).toLowerCase()] = value
+      } else if (key.startsWith('NODE_PERFORMANCE_GC_')) {
+        // It's a constant for a kind of GC
+        const kind = key.substring(20).toLowerCase()
+        kindLabels[value] = labelFromStr(kindLabelKey, kind)
+        // Construct a single-frame "location" too
+        const fn = new Function({ id: functions.length + 1, name: stringTable.dedup(`${kind} GC`) })
+        functions.push(fn)
+        const line = new Line({ functionId: fn.id })
+        const location = new Location({ id: locations.length + 1, line: [line] })
+        locations.push(location)
+        locationsPerKind[value] = [location.id]
+      }
+    }
+
+    const gcEventLabel = labelFromStrStr('event', 'gc')
+    const threadLabel = labelFromStrStr(THREAD_NAME, threadName)
+
+    function getReasonLabel (flags) {
+      if (flags === 0) {
+        return null
+      }
+      let reasonLabel = reasonLabels[flags]
+      if (!reasonLabel) {
+        const reasons = []
+        for (const [key, value] of Object.entries(flagObj)) {
+          if (value & flags) {
+            reasons.push(key)
+          }
+        }
+        const reasonStr = reasons.join(',')
+        reasonLabel = labelFromStr(reasonLabelKey, reasonStr)
+        reasonLabels[flags] = reasonLabel
+      }
+      return reasonLabel
+    }
+
+    let durationFrom = Number.POSITIVE_INFINITY
+    let durationTo = 0
+    const dateOffset = BigInt(Math.round(performance.timeOrigin * MS_TO_NS))
+
+    const samples = this.entries.map((item) => {
+      const { startTime, duration } = item
+      const { kind, flags } = node16 ? item.detail : item
+      const endTime = startTime + duration
+      if (durationFrom > startTime) durationFrom = startTime
+      if (durationTo < endTime) durationTo = endTime
+      const labels = [
+        gcEventLabel,
+        threadLabel,
+        new Label({ key: timestampLabelKey, num: dateOffset + BigInt(Math.round(endTime * MS_TO_NS)) }),
+        kindLabels[kind]
+      ]
+      const reasonLabel = getReasonLabel(flags)
+      if (reasonLabel) {
+        labels.push(reasonLabel)
+      }
+      const sample = new Sample({
+        value: [Math.round(duration * MS_TO_NS)],
+        label: labels,
+        locationId: locationsPerKind[kind]
+      })
+      return sample
+    })
+
+    this.entries = []
+
+    const timeValueType = new ValueType({
+      type: stringTable.dedup(pprofValueType),
+      unit: stringTable.dedup(pprofValueUnit)
+    })
+
+    return new Profile({
+      sampleType: [timeValueType],
+      timeNanos: dateOffset + BigInt(Math.round(durationFrom * MS_TO_NS)),
+      periodType: timeValueType,
+      period: this._flushIntervalNanos,
+      durationNanos: Math.max(0, Math.round((durationTo - durationFrom) * MS_TO_NS)),
+      sample: samples,
+      location: locations,
+      function: functions,
+      stringTable: stringTable
+    })
+  }
+
+  encode (profile) {
+    return pprof.encode(profile)
+  }
+}
+
+module.exports = EventsProfiler

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

@@ -0,0 +1,9 @@
+'use strict'
+
+const { isMainThread, threadId } = require('node:worker_threads')
+
+module.exports = {
+  END_TIMESTAMP: 'end_timestamp_ns',
+  THREAD_NAME: 'thread name',
+  threadNamePrefix: isMainThread ? 'Main' : `Worker #${threadId}`
+}

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

@@ -2,21 +2,20 @@
 
 const { storage } = require('../../../../datadog-core')
 
-const dc = require('../../../../diagnostics_channel')
+const dc = require('dc-polyfill')
 const { HTTP_METHOD, HTTP_ROUTE, RESOURCE_NAME, SPAN_TYPE } = require('../../../../../ext/tags')
 const { WEB } = require('../../../../../ext/types')
 const runtimeMetrics = require('../../runtime_metrics')
 const telemetryMetrics = require('../../telemetry/metrics')
+const { END_TIMESTAMP, THREAD_NAME, threadNamePrefix } = require('./shared')
 
 const beforeCh = dc.channel('dd-trace:storage:before')
 const enterCh = dc.channel('dd-trace:storage:enter')
+const spanFinishCh = dc.channel('dd-trace:span:finish')
 const profilerTelemetryMetrics = telemetryMetrics.manager.namespace('profilers')
+const threadName = `${threadNamePrefix} Event Loop`
 
-const threadName = (function () {
-  const { isMainThread, threadId } = require('node:worker_threads')
-  const name = isMainThread ? 'Main' : `Worker #${threadId}`
-  return `${name} Event Loop`
-})()
+const CachedWebTags = Symbol('NativeWallProfiler.CachedWebTags')
 
 let kSampleCount
 
@@ -30,7 +29,11 @@ function getStartedSpans (context) {
 }
 
 function generateLabels ({ context: { spanId, rootSpanId, webTags, endpoint }, timestamp }) {
-  const labels = { 'thread name': threadName }
+  const labels = {
+    [THREAD_NAME]: threadName,
+    // Incoming timestamps are in microseconds, we emit nanos.
+    [END_TIMESTAMP]: timestamp * 1000n
+  }
   if (spanId) {
     labels['span id'] = spanId
   }
@@ -43,16 +46,10 @@ function generateLabels ({ context: { spanId, rootSpanId, webTags, endpoint }, t
     // fallback to endpoint computed when sample was taken
     labels['trace endpoint'] = endpoint
   }
-  // Incoming timestamps are in microseconds, we emit nanos.
-  labels['end_timestamp_ns'] = timestamp * 1000n
 
   return labels
 }
 
-function getSpanContextTags (span) {
-  return span.context()._tags
-}
-
 function isWebServerSpan (tags) {
   return tags[SPAN_TYPE] === WEB
 }
@@ -78,6 +75,7 @@ class NativeWallProfiler {
 
     // Bind to this so the same value can be used to unsubscribe later
     this._enter = this._enter.bind(this)
+    this._spanFinished = this._spanFinished.bind(this)
     this._logger = options.logger
     this._started = false
   }
@@ -120,10 +118,12 @@ class NativeWallProfiler {
       this._pprof.time.setContext(this._currentContext)
       this._lastSpan = undefined
       this._lastStartedSpans = undefined
+      this._lastWebTags = undefined
       this._lastSampleCount = 0
 
       beforeCh.subscribe(this._enter)
       enterCh.subscribe(this._enter)
+      spanFinishCh.subscribe(this._spanFinished)
     }
 
     this._started = true
@@ -144,11 +144,43 @@ class NativeWallProfiler {
 
     const span = getActiveSpan()
     if (span) {
+      const context = span.context()
       this._lastSpan = span
-      this._lastStartedSpans = getStartedSpans(span.context())
+      const startedSpans = getStartedSpans(context)
+      this._lastStartedSpans = startedSpans
+      if (this._endpointCollectionEnabled) {
+        const cachedWebTags = span[CachedWebTags]
+        if (cachedWebTags === undefined) {
+          let found = false
+          // Find the first webspan starting from the end:
+          // There might be several webspans, for example with next.js, http plugin creates a first span
+          // and then next.js plugin creates a child span, and this child span has the correct endpoint information.
+          let nextSpanId = context._spanId
+          for (let i = startedSpans.length - 1; i >= 0; i--) {
+            const nextContext = startedSpans[i].context()
+            if (nextContext._spanId === nextSpanId) {
+              const tags = nextContext._tags
+              if (isWebServerSpan(tags)) {
+                this._lastWebTags = tags
+                span[CachedWebTags] = tags
+                found = true
+                break
+              }
+              nextSpanId = nextContext._parentId
+            }
+          }
+          if (!found) {
+            this._lastWebTags = undefined
+            span[CachedWebTags] = null // cache negative lookup result
+          }
+        } else {
+          this._lastWebTags = cachedWebTags
+        }
+      }
     } else {
       this._lastStartedSpans = undefined
       this._lastSpan = undefined
+      this._lastWebTags = undefined
     }
   }
 
@@ -163,21 +195,17 @@ class NativeWallProfiler {
         context.rootSpanId = rootSpan.context().toSpanId()
       }
     }
-    if (this._endpointCollectionEnabled) {
-      const startedSpans = this._lastStartedSpans
-      // Find the first webspan starting from the end:
-      // There might be several webspans, for example with next.js, http plugin creates a first span
-      // and then next.js plugin creates a child span, and this child span haves the correct endpoint information.
-      for (let i = startedSpans.length - 1; i >= 0; i--) {
-        const tags = getSpanContextTags(startedSpans[i])
-        if (isWebServerSpan(tags)) {
-          context.webTags = tags
-          // endpoint may not be determined yet, but keep it as fallback
-          // if tags are not available anymore during serialization
-          context.endpoint = endpointNameFromTags(tags)
-          break
-        }
-      }
+    if (this._lastWebTags) {
+      context.webTags = this._lastWebTags
+      // endpoint may not be determined yet, but keep it as fallback
+      // if tags are not available anymore during serialization
+      context.endpoint = endpointNameFromTags(this._lastWebTags)
+    }
+  }
+
+  _spanFinished (span) {
+    if (span[CachedWebTags]) {
+      span[CachedWebTags] = undefined
     }
   }
 
@@ -223,7 +251,11 @@ class NativeWallProfiler {
     if (this._withContexts) {
       beforeCh.unsubscribe(this._enter)
       enterCh.unsubscribe(this._enter)
+      spanFinishCh.unsubscribe(this._spanFinished)
       this._profilerState = undefined
+      this._lastSpan = undefined
+      this._lastStartedSpans = undefined
+      this._lastWebTags = undefined
     }
 
     this._started = false

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

@@ -3,7 +3,7 @@
 const path = require('path')
 const Module = require('module')
 const parse = require('module-details-from-path')
-const dc = require('../../diagnostics_channel')
+const dc = require('dc-polyfill')
 
 const origRequire = Module.prototype.require
 

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

@@ -138,6 +138,10 @@ class SpanProcessor {
       }
     }
 
+    for (const span of trace.finished) {
+      span.context()._tags = {}
+    }
+
     trace.started = active
     trace.finished = []
   }

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('dc-polyfill')
 const { fileURLToPath } = require('url')
 
 const savedDependenciesToSend = 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('dc-polyfill')
 const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const dc = require('../../../../diagnostics_channel')
+const dc = require('dc-polyfill')
 const logCollector = require('./log-collector')
 const { sendData } = require('../send-data')
 

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

@@ -31,8 +31,10 @@ class DatadogTracer extends Tracer {
 
   // todo[piochelepiotr] These two methods are not related to the tracer, but to data streams monitoring.
   // They should be moved outside of the tracer in the future.
-  setCheckpoint (edgeTags) {
-    const ctx = this._dataStreamsProcessor.setCheckpoint(edgeTags, DataStreamsContext.getDataStreamsContext())
+  setCheckpoint (edgeTags, span, payloadSize = 0) {
+    const ctx = this._dataStreamsProcessor.setCheckpoint(
+      edgeTags, span, DataStreamsContext.getDataStreamsContext(), payloadSize
+    )
     DataStreamsContext.setDataStreamsContext(ctx)
     return ctx
   }

package/packages/diagnostics_channel/index.js

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

package/packages/diagnostics_channel/src/index.js

@@ -1,121 +0,0 @@
-'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
-  }
-}
-
-if (!Channel.prototype.runStores) {
-  const ActiveChannelPrototype = getActiveChannelPrototype()
-
-  Channel.prototype.bindStore = ActiveChannelPrototype.bindStore = function (store, transform) {
-    if (!this._stores) {
-      this._stores = new Map()
-    }
-    this._stores.set(store, transform)
-  }
-
-  Channel.prototype.unbindStore = ActiveChannelPrototype.unbindStore = function (store) {
-    if (!this._stores) return
-    this._stores.delete(store)
-  }
-
-  Channel.prototype.runStores = ActiveChannelPrototype.runStores = function (data, fn, thisArg, ...args) {
-    if (!this._stores) return Reflect.apply(fn, thisArg, args)
-
-    let run = () => {
-      this.publish(data)
-      return Reflect.apply(fn, thisArg, args)
-    }
-
-    for (const entry of this._stores.entries()) {
-      const store = entry[0]
-      const transform = entry[1]
-      run = wrapStoreRun(store, data, run, transform)
-    }
-
-    return run()
-  }
-}
-
-function defaultTransform (data) {
-  return data
-}
-
-function wrapStoreRun (store, data, next, transform = defaultTransform) {
-  return () => {
-    let context
-    try {
-      context = transform(data)
-    } catch (err) {
-      process.nextTick(() => {
-        throw err
-      })
-      return next()
-    }
-
-    return store.run(context, next)
-  }
-}
-
-function getActiveChannelPrototype () {
-  const dummyChannel = channel('foo')
-  const listener = () => {}
-
-  dummyChannel.subscribe(listener)
-  const ActiveChannelPrototype = Object.getPrototypeOf(dummyChannel)
-  dummyChannel.unsubscribe(listener)
-
-  return ActiveChannelPrototype
-}
-
-module.exports = dc