dd-trace 5.96.0 → 5.97.0

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

@@ -1,5 +1,8 @@
 'use strict'
+
 const { inspect } = require('util')
+
+const { defaults } = require('../config/defaults')
 const { isTrue } = require('../util')
 const { getValueFromEnvSources } = require('../config/helper')
 const { traceChannel, debugChannel, infoChannel, warnChannel, errorChannel } = require('./channels')
@@ -8,12 +11,17 @@ const { Log, LogConfig, NoTransmitError } = require('./log')
 const { memoize } = require('./utils')
 
 const config = {
-  enabled: false,
+  enabled: defaults.DD_TRACE_DEBUG,
   logger: undefined,
-  logLevel: 'debug',
+  logLevel: defaults.logLevel,
 }
 
-// in most places where we know we want to mute a log we use log.error() directly
+const deprecate = memoize((code, message) => {
+  publishFormatted(errorChannel, null, message)
+  return true
+})
+
+// In most places where we know we want to mute a log we use log.error() directly
 const NO_TRANSMIT = new LogConfig(false)
 
 const log = {
@@ -21,36 +29,6 @@ const log = {
   NO_TRANSMIT,
   NoTransmitError,
 
-  /**
-   * @returns Read-only version of logging config. To modify config, call `log.use` and `log.toggle`
-   */
-  getConfig () {
-    return { ...config }
-  },
-
-  use (logger) {
-    config.logger = logger
-    logWriter.use(logger)
-    return log
-  },
-
-  toggle (enabled, logLevel) {
-    config.enabled = enabled
-    config.logLevel = logLevel
-    logWriter.toggle(enabled, logLevel)
-    return log
-  },
-
-  reset () {
-    logWriter.reset()
-    log._deprecate = memoize((code, message) => {
-      publishFormatted(errorChannel, null, message)
-      return true
-    })
-
-    return log
-  },
-
   trace (...args) {
     if (traceChannel.hasSubscribers) {
       const logRecord = {}
@@ -66,6 +44,8 @@ const log = {
 
       publishFormatted(traceChannel, null, stack.join('\n'))
     }
+    // TODO: Why do we allow chaining here? This is likely not used anywhere.
+    // If it is used, that seems like a mistake.
     return log
   },
 
@@ -103,30 +83,23 @@ const log = {
   },
 
   deprecate (code, message) {
-    return log._deprecate(code, message)
+    return deprecate(code, message)
   },
 
-  isEnabled (fleetStableConfigValue, localStableConfigValue) {
-    return isTrue(
-      fleetStableConfigValue ??
+  configure (options) {
+    config.logger = options.logger
+    config.logLevel = options.logLevel ??
+        getValueFromEnvSources('DD_TRACE_LOG_LEVEL') ??
+        config.logLevel
+    config.enabled = isTrue(
       getValueFromEnvSources('DD_TRACE_DEBUG') ??
-      (getValueFromEnvSources('OTEL_LOG_LEVEL') === 'debug' || undefined) ??
-      localStableConfigValue ??
-      config.enabled
+      // TODO: Handle this by adding a log buffer so that configure may be called with the actual configurations.
+      // eslint-disable-next-line eslint-rules/eslint-process-env
+      (process.env.OTEL_LOG_LEVEL === 'debug' || config.enabled)
     )
-  },
+    logWriter.configure(config.enabled, config.logLevel, options.logger)
 
-  getLogLevel (
-    optionsValue,
-    fleetStableConfigValue,
-    localStableConfigValue
-  ) {
-    return optionsValue ??
-      fleetStableConfigValue ??
-      getValueFromEnvSources('DD_TRACE_LOG_LEVEL') ??
-      getValueFromEnvSources('OTEL_LOG_LEVEL') ??
-      localStableConfigValue ??
-      config.logLevel
+    return config.enabled
   },
 }
 
@@ -150,8 +123,6 @@ function getErrorLog (err) {
   return err
 }
 
-log.reset()
-
-log.toggle(log.isEnabled(), log.getLogLevel())
+log.configure({})
 
 module.exports = log

package/packages/dd-trace/src/log/writer.js

@@ -2,6 +2,7 @@
 
 const { storage } = require('../../../datadog-core')
 const { LogChannel } = require('./channels')
+
 const defaultLogger = {
   debug: msg => console.debug(msg), /* eslint-disable-line no-console */
   info: msg => console.info(msg), /* eslint-disable-line no-console */
@@ -17,12 +18,8 @@ function withNoop (fn) {
   storage('legacy').run({ noop: true }, fn)
 }
 
-function unsubscribeAll () {
-  logChannel.unsubscribe({ trace, debug, info, warn, error })
-}
-
 function toggleSubscription (enable, level) {
-  unsubscribeAll()
+  logChannel.unsubscribe({ trace, debug, info, warn, error })
 
   if (enable) {
     logChannel = new LogChannel(level)
@@ -30,23 +27,14 @@ function toggleSubscription (enable, level) {
   }
 }
 
-function toggle (enable, level) {
+function configure (enable, level, newLogger) {
   enabled = enable
+  logger = typeof newLogger?.debug === 'function' && typeof newLogger.error === 'function'
+    ? newLogger
+    : defaultLogger
   toggleSubscription(enabled, level)
 }
 
-function use (newLogger) {
-  if (typeof newLogger?.debug === 'function' && typeof newLogger.error === 'function') {
-    logger = newLogger
-  }
-}
-
-function reset () {
-  logger = defaultLogger
-  enabled = false
-  toggleSubscription(false)
-}
-
 function error (err) {
   withNoop(() => logger.error(err))
 }
@@ -69,4 +57,4 @@ function trace (log) {
   withNoop(() => logger.debug(log))
 }
 
-module.exports = { use, toggle, reset, error, warn, info, debug, trace }
+module.exports = { configure, error, warn, info, debug, trace }

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

@@ -13,6 +13,10 @@ const noopDogStatsDClient = new NoopDogStatsDClient()
 const noopLLMObs = new NoopLLMObsSDK(noop)
 const noopOpenFeatureProvider = new NoopFlaggingProvider()
 const noopAIGuard = new NoopAIGuardSDK()
+const noopProfiling = {
+  setCustomLabelKeys () {},
+  runWithLabels (labels, fn) { return fn() },
+}
 
 /** @type {import('../../src/index')} Proxy */
 class NoopProxy {
@@ -98,6 +102,10 @@ class NoopProxy {
     return this
   }
 
+  get profiling () {
+    return noopProfiling
+  }
+
   get TracerProvider () {
     return require('../opentelemetry/tracer_provider')
   }

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

@@ -33,7 +33,7 @@ const OtlpHttpLogExporter = require('./otlp_http_log_exporter')
 
 /**
  * Initializes OpenTelemetry Logs support
- * @param {Config} config - Tracer configuration instance
+ * @param {import('../../config/config-base')} config - Tracer configuration instance
  */
 function initializeOpenTelemetryLogs (config) {
   // Build resource attributes

package/packages/dd-trace/src/opentelemetry/metrics/index.js

@@ -35,7 +35,7 @@ const OtlpHttpMetricExporter = require('./otlp_http_metric_exporter')
 
 /**
  * Initializes OpenTelemetry Metrics support
- * @param {Config} config - Tracer configuration instance
+ * @param {import('../../config/config-base')} config - Tracer configuration instance
  */
 function initializeOpenTelemetryMetrics (config) {
   const resourceAttributes = {

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

@@ -6,6 +6,7 @@ const id = require('../../id')
 const DatadogSpanContext = require('../span_context')
 const log = require('../../log')
 const tags = require('../../../../../ext/tags')
+const { getConfiguredEnvName } = require('../../config/helper')
 const { setBaggageItem, getAllBaggageItems, removeAllBaggageItems } = require('../../baggage')
 const telemetryMetrics = require('../../telemetry/metrics')
 
@@ -65,8 +66,15 @@ const zeroTraceId = '0000000000000000'
 const hex16 = /^[0-9A-Fa-f]{16}$/
 
 class TextMapPropagator {
+  #extractB3Context
+
   constructor (config) {
     this._config = config
+
+    // TODO: should match "b3 single header" in next major
+    const envName = getConfiguredEnvName('DD_TRACE_PROPAGATION_STYLE')
+    // eslint-disable-next-line eslint-rules/eslint-env-aliases
+    this.#extractB3Context = envName === 'OTEL_PROPAGATORS' ? this._extractB3SingleContext : this._extractB3MultiContext
   }
 
   inject (spanContext, carrier) {
@@ -363,10 +371,7 @@ class TextMapPropagator {
           extractedContext = this._extractB3SingleContext(carrier)
           break
         case 'b3':
-          extractedContext = this._config.tracePropagationStyle.otelPropagators
-            // TODO: should match "b3 single header" in next major
-            ? this._extractB3SingleContext(carrier)
-            : this._extractB3MultiContext(carrier)
+          extractedContext = this.#extractB3Context(carrier)
           break
         case 'b3multi':
           extractedContext = this._extractB3MultiContext(carrier)

package/packages/dd-trace/src/payload-tagging/config/index.js

@@ -3,16 +3,17 @@
 const aws = require('./aws.json')
 const sdks = { aws }
 
+/** @typedef {Record<string, { request: string[], response: string[], expand: string[] }>} SDKRules */
 /**
  * Builds rules per service for a given SDK, appending user-provided rules.
  *
- * @param {Record<string, { request: string[], response: string[], expand: string[] }>} sdk
+ * @param {SDKRules} sdk
  * @param {string[]} requestInput
  * @param {string[]} responseInput
- * @returns {Record<string, { request: string[], response: string[], expand: string[] }>}
+ * @returns {SDKRules}
  */
 function getSDKRules (sdk, requestInput, responseInput) {
-  const sdkServiceRules = {}
+  const sdkServiceRules = /** @type {SDKRules} */ ({})
   for (const [service, serviceRules] of Object.entries(sdk)) {
     sdkServiceRules[service] = {
       // Make a copy. Otherwise calling the function multiple times would append
@@ -31,10 +32,10 @@ function getSDKRules (sdk, requestInput, responseInput) {
  *
  * @param {string[]} [requestInput=[]]
  * @param {string[]} [responseInput=[]]
- * @returns {Record<string, Record<string, { request: string[], response: string[], expand: string[] }>>}
+ * @returns {Record<string, SDKRules>}
  */
 function appendRules (requestInput = [], responseInput = []) {
-  const sdkRules = {}
+  const sdkRules = /** @type {Record<string, SDKRules>} */ ({})
   for (const [name, sdk] of Object.entries(sdks)) {
     sdkRules[name] = getSDKRules(sdk, requestInput, responseInput)
   }

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

@@ -67,7 +67,6 @@ function getEnabled (Plugin) {
 module.exports = class PluginManager {
   constructor (tracer) {
     this._tracer = tracer
-    this._tracerConfig = null
     this._pluginsByName = {}
     this._configsByName = {}
 
@@ -104,7 +103,7 @@ module.exports = class PluginManager {
 
     // extracts predetermined configuration from tracer and combines it with plugin-specific config
     this._pluginsByName[name].configure({
-      ...this._getSharedConfig(name),
+      ...this.#getSharedConfig(name),
       ...pluginConfig,
     })
   }
@@ -121,8 +120,11 @@ module.exports = class PluginManager {
     this.loadPlugin(name)
   }
 
-  // like instrumenter.enable()
-  configure (config = {}) {
+  /**
+   * Like instrumenter.enable()
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
+  configure (config) {
     this._tracerConfig = config
     this._tracer._nomenclature.configure(config)
 
@@ -148,7 +150,7 @@ module.exports = class PluginManager {
   }
 
   // TODO: figure out a better way to handle this
-  _getSharedConfig (name) {
+  #getSharedConfig (name) {
     const {
       logInjection,
       serviceMapping,
@@ -172,7 +174,7 @@ module.exports = class PluginManager {
       traceWebsocketMessagesSeparateTraces,
       experimental,
       resourceRenamingEnabled,
-    } = this._tracerConfig
+    } = /** @type {import('./config/config-base')} */ (this._tracerConfig)
 
     const sharedConfig = {
       codeOriginForSpans,

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

@@ -469,6 +469,10 @@ module.exports = class CiPlugin extends Plugin {
     return getSessionRequestErrorTags(this.testSessionSpan)
   }
 
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   * @param {boolean} shouldGetEnvironmentData - Whether to get environment data
+   */
   configure (config, shouldGetEnvironmentData = true) {
     super.configure(config)
 

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

@@ -72,7 +72,7 @@ module.exports = class Plugin {
    * Create a new plugin instance.
    *
    * @param {object} tracer Tracer instance or wrapper containing it under `_tracer`.
-   * @param {object} tracerConfig Global tracer configuration object.
+   * @param {import('../config/config-base')} tracerConfig Global tracer configuration object.
    */
   constructor (tracer, tracerConfig) {
     this._subscriptions = []
@@ -80,6 +80,8 @@ module.exports = class Plugin {
     this._enabled = false
     this._tracer = tracer
     this.config = {} // plugin-specific configuration, unset until .configure() is called
+
+    /** @type {import('../config/config-base')} */
     this._tracerConfig = tracerConfig // global tracer configuration
   }
 
@@ -163,9 +165,10 @@ module.exports = class Plugin {
   /**
    * Enable or disable the plugin and (re)apply its configuration.
    *
-   * @param {boolean|object} config Either a boolean to enable/disable or a configuration object
-   *                                containing at least `{ enabled: boolean }`.
-   * @returns {void}
+   * TODO: Remove the overloading with `enabled` and use the config object directly.
+   *
+   * @param {boolean|import('../config/config-base')} config Either a boolean to enable/disable
+   * or a configuration object containing at least `{ enabled: boolean }`.
    */
   configure (config) {
     if (typeof config === 'boolean') {

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

@@ -72,6 +72,9 @@ function buildProcessTags (config) {
 
 // Singleton with constant defaults so pre-init reads don't blow up
 const processTags = module.exports = {
+  /**
+   * @param {import('../config/config-base')} config
+   */
   initialize (config) {
     // check if one of the properties added during build exist and if so return
     if (processTags.tags) return

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

@@ -5,13 +5,38 @@ const { profiler } = require('./profiling')
 globalThis[Symbol.for('dd-trace')].beforeExitHandlers.add(() => { profiler.stop() })
 
 module.exports = {
-  start: config => {
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
+  start (config) {
     // Forward the full tracer config to the profiling layer.
     // Profiling code is responsible for deriving the specific options it needs.
     return profiler.start(config)
   },
 
-  stop: () => {
+  stop () {
     profiler.stop()
   },
+
+  /**
+   * Declares the set of custom label keys that will be used with
+   * {@link runWithLabels}.
+   *
+   * @param {Iterable<string>} keys - Custom label key names
+   */
+  setCustomLabelKeys: (keys) => {
+    profiler.setCustomLabelKeys(keys)
+  },
+
+  /**
+   * Runs a function with custom profiling labels attached to wall profiler samples.
+   *
+   * @param {Record<string, string | number>} labels - Custom labels to attach
+   * @param {function(): T} fn - Function to execute with the labels
+   * @returns {T} The return value of fn
+   * @template T
+   */
+  runWithLabels: (labels, fn) => {
+    return profiler.runWithLabels(labels, fn)
+  },
 }