dd-trace 4.29.0 → 4.31.0

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

@@ -6,7 +6,7 @@ function getDataStreamsContext () {
 }
 
 function setDataStreamsContext (dataStreamsContext) {
-  storage.enterWith({ ...(storage.getStore()), dataStreamsContext })
+  if (dataStreamsContext) storage.enterWith({ ...(storage.getStore()), dataStreamsContext })
 }
 
 module.exports = {

package/packages/dd-trace/src/datastreams/pathway.js

@@ -8,6 +8,9 @@ const LRUCache = require('lru-cache')
 const options = { max: 500 }
 const cache = new LRUCache(options)
 
+const CONTEXT_PROPAGATION_KEY = 'dd-pathway-ctx'
+const CONTEXT_PROPAGATION_KEY_BASE64 = 'dd-pathway-ctx-base64'
+
 function shaHash (checkpointString) {
   const hash = crypto.createHash('md5').update(checkpointString).digest('hex').slice(0, 16)
   return Buffer.from(hash, 'hex')
@@ -33,6 +36,11 @@ function encodePathwayContext (dataStreamsContext) {
   ], 20)
 }
 
+function encodePathwayContextBase64 (dataStreamsContext) {
+  const encodedPathway = encodePathwayContext(dataStreamsContext)
+  return encodedPathway.toString('base64')
+}
+
 function decodePathwayContext (pathwayContext) {
   if (pathwayContext == null || pathwayContext.length < 8) {
     return null
@@ -51,8 +59,57 @@ function decodePathwayContext (pathwayContext) {
   return { hash: pathwayHash, pathwayStartNs: pathwayStartMs * 1e6, edgeStartNs: edgeStartMs * 1e6 }
 }
 
+function decodePathwayContextBase64 (pathwayContext) {
+  if (pathwayContext == null || pathwayContext.length < 8) {
+    return
+  }
+  if (Buffer.isBuffer(pathwayContext)) {
+    pathwayContext = pathwayContext.toString()
+  }
+  const encodedPathway = Buffer.from(pathwayContext, 'base64')
+  return decodePathwayContext(encodedPathway)
+}
+
+class DsmPathwayCodec {
+  // we use a class for encoding / decoding in case we update our encoding/decoding. A class will make updates easier
+  // instead of using individual functions.
+  static encode (dataStreamsContext, carrier) {
+    if (!dataStreamsContext || !dataStreamsContext.hash) {
+      return
+    }
+    carrier[CONTEXT_PROPAGATION_KEY_BASE64] = encodePathwayContextBase64(dataStreamsContext)
+  }
+
+  static decode (carrier) {
+    if (carrier == null) return
+
+    let ctx
+    if (CONTEXT_PROPAGATION_KEY_BASE64 in carrier) {
+      // decode v2 encoding of base64
+      ctx = decodePathwayContextBase64(carrier[CONTEXT_PROPAGATION_KEY_BASE64])
+    } else if (CONTEXT_PROPAGATION_KEY in carrier) {
+      try {
+        // decode v1 encoding
+        ctx = decodePathwayContext(carrier[CONTEXT_PROPAGATION_KEY])
+      } catch {
+        // pass
+      }
+      // cover case where base64 context was received under wrong key
+      if (!ctx) ctx = decodePathwayContextBase64(carrier[CONTEXT_PROPAGATION_KEY])
+    }
+    return ctx
+  }
+
+  static contextExists (carrier) {
+    return CONTEXT_PROPAGATION_KEY_BASE64 in carrier || CONTEXT_PROPAGATION_KEY in carrier
+  }
+}
+
 module.exports = {
   computePathwayHash: computeHash,
   encodePathwayContext,
-  decodePathwayContext
+  decodePathwayContext,
+  encodePathwayContextBase64,
+  decodePathwayContextBase64,
+  DsmPathwayCodec
 }

package/packages/dd-trace/src/datastreams/processor.js

@@ -4,7 +4,7 @@ const pkg = require('../../../../package.json')
 const Uint64 = require('int64-buffer').Uint64BE
 
 const { LogCollapsingLowestDenseDDSketch } = require('@datadog/sketches-js')
-const { encodePathwayContext } = require('./pathway')
+const { DsmPathwayCodec } = require('./pathway')
 const { DataStreamsWriter } = require('./writer')
 const { computePathwayHash } = require('./pathway')
 const { types } = require('util')
@@ -13,7 +13,6 @@ const { PATHWAY_HASH } = require('../../../../ext/tags')
 const ENTRY_PARENT_HASH = Buffer.from('0000000000000000', 'hex')
 
 const HIGH_ACCURACY_DISTRIBUTION = 0.0075
-const CONTEXT_PROPAGATION_KEY = 'dd-pathway-ctx'
 
 class StatsPoint {
   constructor (hash, parentHash, edgeTags) {
@@ -285,7 +284,7 @@ class DataStreamsProcessor {
       // Add the header for this now, as the callee doesn't have access to context when producing
       // - 1 to account for extra byte for {
       const ddInfoContinued = {}
-      ddInfoContinued[CONTEXT_PROPAGATION_KEY] = encodePathwayContext(dataStreamsContext).toJSON()
+      DsmPathwayCodec.encode(dataStreamsContext, ddInfoContinued)
       payloadSize += getSizeOrZero(JSON.stringify(ddInfoContinued)) - 1
     }
     const checkpoint = {
@@ -364,6 +363,5 @@ module.exports = {
   getHeadersSize,
   getSizeOrZero,
   getAmqpMessageSize,
-  ENTRY_PARENT_HASH,
-  CONTEXT_PROPAGATION_KEY
+  ENTRY_PARENT_HASH
 }

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

@@ -108,7 +108,6 @@ function extractTags (trace, span) {
 
   for (const tag in tags) {
     switch (tag) {
-      case 'operation.name':
       case 'service.name':
       case 'span.type':
       case 'resource.name':

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

@@ -87,7 +87,7 @@ const registerLambdaHook = () => {
   const lambdaTaskRoot = process.env.LAMBDA_TASK_ROOT
   const originalLambdaHandler = process.env.DD_LAMBDA_HANDLER
 
-  if (originalLambdaHandler !== undefined) {
+  if (originalLambdaHandler !== undefined && lambdaTaskRoot !== undefined) {
     const [moduleRoot, moduleAndHandler] = _extractModuleRootAndHandler(originalLambdaHandler)
     const [_module] = _extractModuleNameAndHandlerPath(moduleAndHandler)
 

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const pick = require('../../../../utils/src/pick')
+const pick = require('../../../../datadog-core/src/utils/src/pick')
 const id = require('../../id')
 const DatadogSpanContext = require('../span_context')
 const log = require('../../log')
@@ -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/plugins/util/test.js

@@ -52,12 +52,13 @@ 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'
 
 const JEST_TEST_RUNNER = 'test.jest.test_runner'
+const JEST_DISPLAY_NAME = 'test.jest.display_name'
 
 const TEST_ITR_TESTS_SKIPPED = '_dd.ci.itr.tests_skipped'
 const TEST_ITR_SKIPPING_ENABLED = 'test.itr.tests_skipping.enabled'
@@ -83,6 +84,7 @@ module.exports = {
   TEST_FRAMEWORK,
   TEST_FRAMEWORK_VERSION,
   JEST_TEST_RUNNER,
+  JEST_DISPLAY_NAME,
   TEST_TYPE,
   TEST_NAME,
   TEST_SUITE,
@@ -99,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/plugins/util/web.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const uniq = require('../../../../utils/src/uniq')
+const uniq = require('../../../../datadog-core/src/utils/src/uniq')
 const analyticsSampler = require('../../analytics_sampler')
 const FORMAT_HTTP_HEADERS = 'http_headers'
 const log = require('../../log')

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/exporters/agent.js

@@ -9,6 +9,8 @@ const docker = require('../../exporters/common/docker')
 const FormData = require('../../exporters/common/form-data')
 const { storage } = require('../../../../datadog-core')
 const version = require('../../../../../package.json').version
+const os = require('os')
+const perf = require('perf_hooks').performance
 
 const containerId = docker.id()
 
@@ -50,7 +52,7 @@ function computeRetries (uploadTimeout) {
 }
 
 class AgentExporter {
-  constructor ({ url, logger, uploadTimeout } = {}) {
+  constructor ({ url, logger, uploadTimeout, env, host, service, version } = {}) {
     this._url = url
     this._logger = logger
 
@@ -58,6 +60,10 @@ class AgentExporter {
 
     this._backoffTime = backoffTime
     this._backoffTries = backoffTries
+    this._env = env
+    this._host = host
+    this._service = service
+    this._appVersion = version
   }
 
   export ({ profiles, start, end, tags }) {
@@ -83,7 +89,37 @@ class AgentExporter {
         `profiler_version:${version}`,
         'format:pprof',
         ...Object.entries(tags).map(([key, value]) => `${key}:${value}`)
-      ].join(',')
+      ].join(','),
+      info: {
+        application: {
+          env: this._env,
+          service: this._service,
+          start_time: new Date(perf.nodeTiming.nodeStart + perf.timeOrigin).toISOString(),
+          version: this._appVersion
+        },
+        platform: {
+          hostname: this._host,
+          kernel_name: os.type(),
+          kernel_release: os.release(),
+          kernel_version: os.version()
+        },
+        profiler: {
+          version
+        },
+        runtime: {
+          // Using `nodejs` for consistency with the existing `runtime` tag.
+          // Note that the event `family` property uses `node`, as that's what's
+          // proscribed by the Intake API, but that's an internal enum and is
+          // not customer visible.
+          engine: 'nodejs',
+          // strip off leading 'v'. This makes the format consistent with other
+          // runtimes (e.g. Ruby) but not with the existing `runtime_version` tag.
+          // We'll keep it like this as we want cross-engine consistency. We
+          // also aren't changing the format of the existing tag as we don't want
+          // to break it.
+          version: process.version.substring(1)
+        }
+      }
     })
 
     fields.push(['event', event, {

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

@@ -20,6 +20,7 @@ let heartbeatTimeout
 let heartbeatInterval
 let extendedInterval
 let integrations
+let configWithOrigin = []
 let retryData = null
 const extendedHeartbeatPayload = {}
 
@@ -96,23 +97,6 @@ function getProducts (config) {
   return products
 }
 
-function flatten (input, result = [], prefix = [], traversedObjects = null) {
-  traversedObjects = traversedObjects || new WeakSet()
-  if (traversedObjects.has(input)) {
-    return
-  }
-  traversedObjects.add(input)
-  for (const [key, value] of Object.entries(input)) {
-    if (typeof value === 'object' && value !== null) {
-      flatten(value, result, [...prefix, key], traversedObjects)
-    } else {
-      // TODO: add correct origin value
-      result.push({ name: [...prefix, key].join('.'), value, origin: 'unknown' })
-    }
-  }
-  return result
-}
-
 function getInstallSignature (config) {
   const { installSignature: sig } = config
   if (sig && (sig.id || sig.time || sig.type)) {
@@ -127,7 +111,7 @@ function getInstallSignature (config) {
 function appStarted (config) {
   const app = {
     products: getProducts(config),
-    configuration: flatten(config)
+    configuration: configWithOrigin
   }
   const installSignature = getInstallSignature(config)
   if (installSignature) {
@@ -305,44 +289,59 @@ function updateIntegrations () {
   sendData(config, application, host, reqType, payload, updateRetryData)
 }
 
+function formatMapForTelemetry (map) {
+  // format from an object to a string map in order for
+  // telemetry intake to accept the configuration
+  return map
+    ? Object.entries(map).map(([key, value]) => `${key}:${value}`).join(',')
+    : ''
+}
+
 function updateConfig (changes, config) {
   if (!config.telemetry.enabled) return
   if (changes.length === 0) return
 
-  // Hack to make system tests happy until we ship telemetry v2
-  if (process.env.DD_INTERNAL_TELEMETRY_V2_ENABLED !== '1') return
-
   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) {
-    if (!names.hasOwnProperty(change.name)) continue
-
-    const name = names[change.name]
+    const name = nameMapping[change.name] || change.name
+    names.push(name)
     const { origin, value } = change
-    const entry = { name, origin, value }
+    const entry = { name, value, origin }
 
-    if (Array.isArray(value)) {
-      entry.value = value.join(',')
-    } else if (name === 'DD_TAGS') {
-      entry.value = Object.entries(value).map(([key, value]) => `${key}:${value}`)
-    }
+    if (Array.isArray(value)) entry.value = value.join(',')
+    if (namesNeedFormatting.has(entry.name)) entry.value = formatMapForTelemetry(entry.value)
+    if (entry.name === 'url' && entry.value) entry.value = entry.value.toString()
 
     configuration.push(entry)
   }
 
-  const { reqType, payload } = createPayload('app-client-configuration-change', { configuration })
+  function isNotModified (entry) {
+    return !names.includes(entry.name)
+  }
 
-  sendData(config, application, host, reqType, payload, updateRetryData)
+  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)
+  }
 }
 
 module.exports = {

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

@@ -8,7 +8,7 @@ const { isError } = require('./util')
 const { setStartupLogConfig } = require('./startup-log')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
 const { DataStreamsProcessor } = require('./datastreams/processor')
-const { decodePathwayContext } = require('./datastreams/pathway')
+const { DsmPathwayCodec } = require('./datastreams/pathway')
 const { DD_MAJOR } = require('../../../version')
 const DataStreamsContext = require('./data_streams_context')
 
@@ -39,8 +39,8 @@ class DatadogTracer extends Tracer {
     return ctx
   }
 
-  decodeDataStreamsContext (data) {
-    const ctx = decodePathwayContext(data)
+  decodeDataStreamsContext (carrier) {
+    const ctx = DsmPathwayCodec.decode(carrier)
     // we erase the previous context everytime we decode a new one
     DataStreamsContext.setDataStreamsContext(ctx)
     return ctx

package/register.js

@@ -0,0 +1,4 @@
+const { register } = require('node:module')
+const { pathToFileURL } = require('node:url')
+
+register('./loader-hook.mjs', pathToFileURL(__filename))