dd-trace 5.90.0 → 5.92.0

package/packages/dd-trace/src/process-tags/index.js

@@ -12,8 +12,19 @@ const ENTRYPOINT_PATH = require.main?.filename || ''
 // entrypoint.basedir = baz
 // package.json.name = <from package.json>
 
-// process tags are constant throughout the lifetime of a process
-function getProcessTags () {
+/**
+ * Sanitize a process tag value
+ *
+ * @param {string} value
+ * @returns {string}
+ */
+function sanitize (value) {
+  return String(value)
+    .toLowerCase()
+    .replaceAll(/[^a-zA-Z0-9/_.-]+/g, '_')
+}
+
+function buildProcessTags (config) {
   // Lazy load pkg to avoid issues with require.main during test initialization
   const pkg = require('../pkg')
 
@@ -35,6 +46,13 @@ function getProcessTags () {
     ['package.json.name', pkg.name || undefined],
   ]
 
+  // If config dependent tags keep growing, we should consider moving this into a function
+  if (config?.isServiceNameInferred) {
+    tags.push(['svc.auto', config.service])
+  } else if (config) {
+    tags.push(['svc.user', true])
+  }
+
   const tagsArray = []
   const tagsObject = {}
 
@@ -46,38 +64,27 @@ function getProcessTags () {
     }
   }
 
-  const serialized = tagsArray.join(',')
-
-  return {
-    tags,
-    serialized,
-    tagsObject,
-    tagsArray,
-  }
+  processTags.tags = tags
+  processTags.serialized = tagsArray.join(',')
+  processTags.tagsObject = tagsObject
+  processTags.tagsArray = tagsArray
 }
 
-// Export the singleton
-module.exports = getProcessTags()
-
-module.exports.TRACING_FIELD_NAME = '_dd.tags.process'
-module.exports.DSM_FIELD_NAME = 'ProcessTags'
-module.exports.PROFILING_FIELD_NAME = 'process_tags'
-module.exports.DYNAMIC_INSTRUMENTATION_FIELD_NAME = 'process_tags'
-module.exports.TELEMETRY_FIELD_NAME = 'process_tags'
-module.exports.REMOTE_CONFIG_FIELD_NAME = 'process_tags'
-module.exports.CRASH_TRACKING_FIELD_NAME = 'process_tags'
-module.exports.CLIENT_TRACE_STATISTICS_FIELD_NAME = 'ProcessTags'
-
-/**
- * Sanitize a process tag value
- *
- * @param {string} value
- * @returns {string}
- */
-function sanitize (value) {
-  return String(value)
-    .toLowerCase()
-    .replaceAll(/[^a-zA-Z0-9/_.-]+/g, '_')
+// Singleton with constant defaults so pre-init reads don't blow up
+const processTags = module.exports = {
+  initialize (config) {
+    // check if one of the properties added during build exist and if so return
+    if (processTags.tags) return
+    buildProcessTags(config)
+  },
+
+  TRACING_FIELD_NAME: '_dd.tags.process',
+  DSM_FIELD_NAME: 'ProcessTags',
+  PROFILING_FIELD_NAME: 'process_tags',
+  DYNAMIC_INSTRUMENTATION_FIELD_NAME: 'process_tags',
+  TELEMETRY_FIELD_NAME: 'process_tags',
+  REMOTE_CONFIG_FIELD_NAME: 'process_tags',
+  CRASH_TRACKING_FIELD_NAME: 'process_tags',
+  CLIENT_TRACE_STATISTICS_FIELD_NAME: 'ProcessTags',
+  sanitize,
 }
-
-module.exports.sanitize = sanitize

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

@@ -290,7 +290,15 @@ class NativeWallProfiler {
       }
 
       profilingContext = { spanId, rootSpanId, webTags }
-      span[ProfilingContext] = profilingContext
+      // Don't cache if endpoint collection is enabled and webTags is undefined but
+      // the span's type hasn't been set yet. TracingPlugin.startSpan() calls
+      // enterWith() before the plugin sets span.type='web' via addRequestTags(),
+      // so the first enterCh event fires before the type is known. Without this
+      // guard we'd cache webTags=undefined and then serve that stale value on the
+      // subsequent activation (when span.type='web' is already set).
+      if (!this.#endpointCollectionEnabled || webTags !== undefined || context._tags['span.type']) {
+        span[ProfilingContext] = profilingContext
+      }
     }
     return profilingContext
   }

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

@@ -13,6 +13,7 @@ const nomenclature = require('./service-naming')
 const PluginManager = require('./plugin_manager')
 const NoopDogStatsDClient = require('./noop/dogstatsd')
 const { IS_SERVERLESS } = require('./serverless')
+const processTags = require('./process-tags')
 const {
   setBaggageItem,
   getBaggageItem,
@@ -102,6 +103,9 @@ class Tracer extends NoopProxy {
     try {
       const config = getConfig(options) // TODO: support dynamic code config
 
+      // Add config dependent process tags
+      processTags.initialize(config)
+
       // Configure propagation hash manager for process tags + container tags
       const propagationHash = require('./propagation-hash')
       propagationHash.configure(config)

package/packages/dd-trace/src/telemetry/send-data.js

@@ -91,12 +91,17 @@ let agentTelemetry = true
  * @returns {Record<string, string>}
  */
 function getHeaders (config, application, reqType) {
+  const sessionId = config.tags['runtime-id']
   const headers = {
     'content-type': 'application/json',
     'dd-telemetry-api-version': 'v2',
     'dd-telemetry-request-type': reqType,
     'dd-client-library-language': application.language_name,
     'dd-client-library-version': application.tracer_version,
+    'dd-session-id': sessionId,
+  }
+  if (config.rootSessionId && config.rootSessionId !== sessionId) {
+    headers['dd-root-session-id'] = config.rootSessionId
   }
   const debug = config.telemetry && config.telemetry.debug
   if (debug) {

package/packages/dd-trace/src/telemetry/session-propagation.js

@@ -0,0 +1,78 @@
+'use strict'
+
+const dc = require('dc-polyfill')
+
+const childProcessChannel = dc.tracingChannel('datadog:child_process:execution')
+
+let subscribed = false
+let rootSessionId
+let runtimeId
+
+function injectSessionEnv (existingEnv) {
+  // eslint-disable-next-line eslint-rules/eslint-process-env -- not in supported-configurations.json
+  const base = existingEnv == null ? process.env : existingEnv
+  return {
+    ...base,
+    DD_ROOT_JS_SESSION_ID: rootSessionId,
+    DD_PARENT_JS_SESSION_ID: runtimeId,
+  }
+}
+
+function findOptionsIndex (args, shell) {
+  if (Array.isArray(args[1])) {
+    return { index: 2, exists: args[2] != null && typeof args[2] === 'object' }
+  }
+  if (args[1] != null && typeof args[1] === 'object') {
+    return { index: 1, exists: true }
+  }
+  if (!shell && args[2] != null && typeof args[2] === 'object') {
+    return { index: 2, exists: true }
+  }
+  return { index: shell ? 1 : 2, exists: false }
+}
+
+function onChildProcessStart (context) {
+  if (!context.callArgs) return
+
+  const args = context.callArgs
+  const { index, exists } = findOptionsIndex(args, context.shell)
+
+  if (exists) {
+    args[index] = { ...args[index], env: injectSessionEnv(args[index].env) }
+    return
+  }
+
+  const opts = { env: injectSessionEnv(null) }
+
+  if (!context.shell && !Array.isArray(args[1])) {
+    args.splice(1, 0, [])
+  }
+
+  if (typeof args[index] === 'function') {
+    args.splice(index, 0, opts)
+  } else {
+    args[index] = opts
+  }
+}
+
+const handler = { start: onChildProcessStart }
+
+function start (config) {
+  if (!config.telemetry?.enabled || subscribed) return
+  subscribed = true
+
+  rootSessionId = config.rootSessionId
+  runtimeId = config.tags['runtime-id']
+
+  childProcessChannel.subscribe(handler)
+}
+
+function stop () {
+  if (!subscribed) return
+  childProcessChannel.unsubscribe(handler)
+  subscribed = false
+  rootSessionId = undefined
+  runtimeId = undefined
+}
+
+module.exports = { start, stop, _onChildProcessStart: onChildProcessStart }

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

@@ -12,6 +12,7 @@ const endpoints = require('./endpoints')
 const { sendData } = require('./send-data')
 const { manager: metricsManager } = require('./metrics')
 const telemetryLogger = require('./logs')
+const sessionPropagation = require('./session-propagation')
 
 /**
  * @typedef {Record<string, unknown>} TelemetryPayloadObject
@@ -370,6 +371,7 @@ function start (aConfig, thePluginManager) {
   dependencies.start(config, application, host, getRetryData, updateRetryData)
   telemetryLogger.start(config)
   endpoints.start(config, application, host, getRetryData, updateRetryData)
+  sessionPropagation.start(config)
 
   sendData(config, application, host, 'app-started', appStarted(config))
 
@@ -397,6 +399,7 @@ function stop () {
   telemetryStopChannel.publish(getTelemetryData())
 
   endpoints.stop()
+  sessionPropagation.stop()
   config = undefined
 }