dd-trace 5.105.0 → 5.106.0

package/packages/dd-trace/src/profiling/config.js

@@ -5,6 +5,7 @@ const { pathToFileURL } = require('url')
 
 const satisfies = require('../../../../vendor/dist/semifies')
 const getGitMetadata = require('../git_metadata')
+const log = require('../log')
 const { GIT_REPOSITORY_URL, GIT_COMMIT_SHA } = require('../plugins/util/tags')
 const { getIsAzureFunction } = require('../serverless')
 const { getAzureTagsFromMetadata, getAzureAppMetadata, getAzureFunctionMetadata } = require('../azure_metadata')
@@ -14,7 +15,6 @@ const { isACFActive } = require('../../../datadog-core/src/storage')
 
 const { AgentExporter } = require('./exporters/agent')
 const { FileExporter } = require('./exporters/file')
-const { ConsoleLogger } = require('./loggers/console')
 const WallProfiler = require('./profilers/wall')
 const SpaceProfiler = require('./profilers/space')
 const EventsProfiler = require('./profilers/events')
@@ -54,7 +54,6 @@ class Config {
     this.pprofPrefix = options.DD_PROFILING_PPROF_PREFIX
     this.v8ProfilerBugWorkaroundEnabled = options.DD_PROFILING_V8_PROFILER_BUG_WORKAROUND
 
-    this.logger = ensureLogger(options.logger)
     this.url = getAgentUrl(options)
 
     this.libraryInjected = !!options.DD_INJECTION_ENABLED
@@ -73,7 +72,7 @@ class Config {
     const heapLimitExtensionSize = options.DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE
     const maxHeapExtensionCount = options.DD_PROFILING_EXPERIMENTAL_OOM_MAX_HEAP_EXTENSION_COUNT
     const exportStrategies = oomMonitoringEnabled
-      ? ensureOOMExportStrategies(options.DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES, this)
+      ? ensureOOMExportStrategies(options.DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES)
       : []
     const exportCommand = oomMonitoringEnabled ? buildExportCommand(this) : undefined
     this.oomMonitoring = {
@@ -102,7 +101,7 @@ class Config {
     if (level !== undefined) {
       const maxLevel = { gzip: 9, zstd: 22 }[uploadCompression]
       if (level > maxLevel) {
-        this.logger.warn(`Invalid compression level ${level}. Will use ${maxLevel}.`)
+        log.warn('Invalid compression level %d. Will use %d.', level, maxLevel)
         level = maxLevel
       }
     }
@@ -119,8 +118,7 @@ class Config {
 
     const that = this
     function turnOffAsyncContextFrame (msg) {
-      that.logger.warn(
-        `DD_PROFILING_ASYNC_CONTEXT_FRAME_ENABLED was set ${msg}, it will have no effect.`)
+      log.warn('DD_PROFILING_ASYNC_CONTEXT_FRAME_ENABLED was set %s, it will have no effect.', msg)
       that.asyncContextFrameEnabled = false
     }
 
@@ -215,18 +213,18 @@ function getProfilers ({
   return profilersArray
 }
 
-function getExportStrategy (name, options) {
+function getExportStrategy (name) {
   const strategy = Object.values(oomExportStrategies).find(value => value === name)
   if (strategy === undefined) {
-    options.logger.error(`Unknown oom export strategy "${name}"`)
+    log.error('Unknown oom export strategy "%s"', name)
   }
   return strategy
 }
 
-function ensureOOMExportStrategies (strategies, options) {
+function ensureOOMExportStrategies (strategies) {
   const set = new Set()
   for (const strategy of strategies) {
-    set.add(getExportStrategy(strategy, options))
+    set.add(getExportStrategy(strategy))
   }
 
   return [...set]
@@ -239,7 +237,7 @@ function getExporter (name, options) {
     case 'file':
       return new FileExporter(options)
     default:
-      options.logger.error(`Unknown exporter "${name}"`)
+      log.error('Unknown exporter "%s"', name)
   }
 }
 
@@ -255,7 +253,7 @@ function getProfiler (name, options) {
     case 'space':
       return new SpaceProfiler(options)
     default:
-      options.logger.error(`Unknown profiler "${name}"`)
+      log.error('Unknown profiler "%s"', name)
   }
 }
 
@@ -278,17 +276,6 @@ function ensureProfilers (profilers, options) {
   return filteredProfilers
 }
 
-function ensureLogger (logger) {
-  if (typeof logger?.debug !== 'function' ||
-    typeof logger.info !== 'function' ||
-    typeof logger.warn !== 'function' ||
-    typeof logger.error !== 'function') {
-    return new ConsoleLogger()
-  }
-
-  return logger
-}
-
 function buildExportCommand (options) {
   const tags = [...Object.entries(options.tags),
     ['snapshot', snapshotKinds.ON_OUT_OF_MEMORY]].map(([key, value]) => `${key}:${value}`).join(',')

package/packages/dd-trace/src/profiling/exporters/agent.js

@@ -9,6 +9,7 @@ const retry = require('../../../../../vendor/dist/retry')
 // TODO: avoid using dd-trace internals. Make this a separate module?
 const docker = require('../../exporters/common/docker')
 const FormData = require('../../exporters/common/form-data')
+const log = require('../../log')
 const { storage } = require('../../../../datadog-core')
 const version = require('../../../../../package.json').version
 const telemetryMetrics = require('../../telemetry/metrics')
@@ -89,9 +90,8 @@ function computeRetries (uploadTimeout) {
 class AgentExporter extends EventSerializer {
   constructor (config = {}) {
     super(config)
-    const { url, logger, uploadTimeout } = config
+    const { url, uploadTimeout } = config
     this._url = url
-    this._logger = logger
 
     const [backoffTries, backoffTime] = computeRetries(uploadTimeout)
 
@@ -109,12 +109,11 @@ class AgentExporter extends EventSerializer {
       contentType: 'application/json',
     }])
 
-    this._logger.debug(() => {
-      return `Building agent export report:\n${event}`
-    })
+    log.debug('Building agent export report:\n%s', event)
 
     for (const [type, buffer] of Object.entries(profiles)) {
-      this._logger.debug(() => {
+      // eslint-disable-next-line eslint-rules/eslint-log-printf-style
+      log.debug(() => {
         const bytes = buffer.toString('hex').match(/../g).join(' ')
         return `Adding ${type} profile to agent export: ` + bytes
       })
@@ -163,7 +162,8 @@ class AgentExporter extends EventSerializer {
           options.port = httpOptions.port
         }
 
-        this._logger.debug(() => {
+        // eslint-disable-next-line eslint-rules/eslint-log-printf-style
+        log.debug(() => {
           return `Submitting profiler agent report attempt #${attempt} to: ${JSON.stringify(options)}`
         })
 
@@ -171,7 +171,7 @@ class AgentExporter extends EventSerializer {
           if (err) {
             const { status } = err
             if ((typeof status !== 'number' || status >= 500 || status === 429) && operation.retry(err)) {
-              this._logger.warn(`Error from the agent: ${err.message}`)
+              log.warn('Error from the agent: %s', err.message)
             } else {
               reject(err)
             }
@@ -180,9 +180,10 @@ class AgentExporter extends EventSerializer {
 
           getBody(response, (err, body) => {
             if (err) {
-              this._logger.warn(`Error reading agent response: ${err.message}`)
+              log.warn('Error reading agent response: %s', err.message)
             } else {
-              this._logger.debug(() => {
+              // eslint-disable-next-line eslint-rules/eslint-log-printf-style
+              log.debug(() => {
                 const bytes = (body.toString('hex').match(/../g) || []).join(' ')
                 return `Agent export response: ${bytes}`
               })

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

@@ -40,6 +40,16 @@ function processInfo (infos, info, type) {
   }
 }
 
+// Route pprof through the central log module so logLevel applies.
+const pprofLogger = {
+  trace: (...args) => log.trace(...args),
+  debug: (...args) => log.debug(...args),
+  info: (...args) => log.info(...args),
+  warn: (...args) => log.warn(...args),
+  error: (...args) => log.error(...args),
+  fatal: (...args) => log.error(...args),
+}
+
 class Profiler extends EventEmitter {
   #compressionFn
   #compressionFnInitialized = false
@@ -49,7 +59,6 @@ class Profiler extends EventEmitter {
   #enabled = false
   #endpointCounts = new Map()
   #lastStart
-  #logger
   #profileSeq = 0
   #spanFinishListener
   #timer
@@ -159,14 +168,13 @@ class Profiler extends EventEmitter {
     this.#enabled = true
 
     const config = this.#config = new Config(options)
-    this.#logger = config.logger
 
     this._setInterval()
     // Log errors if the source map finder fails, but don't prevent the rest
     // of the profiler from running without source maps.
     let mapper
     const { setLogger, SourceMapper } = require('@datadog/pprof')
-    setLogger(config.logger)
+    setLogger(pprofLogger)
 
     if (config.sourceMap) {
       mapper = new SourceMapper(config.debugSourceMaps)
@@ -174,7 +182,8 @@ class Profiler extends EventEmitter {
         .then(() => {
           if (config.debugSourceMaps) {
             const count = mapper.infoMap.size
-            this.#logger.debug(() => {
+            // eslint-disable-next-line eslint-rules/eslint-log-printf-style
+            log.debug(() => {
               return count === 0
                 ? 'Found no source maps'
                 : `Found source maps for following files: [${[...mapper.infoMap.keys()].join(', ')}]`
@@ -195,7 +204,7 @@ class Profiler extends EventEmitter {
           mapper,
           nearOOMCallback,
         })
-        this.#logger.debug(`Started ${profiler.type} profiler in ${threadNamePrefix} thread`)
+        log.debug('Started %s profiler in %s thread', profiler.type, threadNamePrefix)
       }
 
       if (config.endpointCollectionEnabled) {
@@ -248,7 +257,7 @@ class Profiler extends EventEmitter {
 
     for (const profiler of this.#config.profilers) {
       profiler.stop()
-      this.#logger.debug(`Stopped ${profiler.type} profiler in ${threadNamePrefix} thread`)
+      log.debug('Stopped %s profiler in %s thread', profiler.type, threadNamePrefix)
     }
 
     clearTimeout(this.#timer)
@@ -312,7 +321,7 @@ class Profiler extends EventEmitter {
           const info = profiler.getInfo()
           const profile = profiler.profile(restart, startDate, endDate)
           if (!restart) {
-            this.#logger.debug(`Stopped ${profiler.type} profiler in ${threadNamePrefix} thread`)
+            log.debug('Stopped %s profiler in %s thread', profiler.type, threadNamePrefix)
           }
           if (!profile) continue
           profiles.push({ profiler, profile, info })
@@ -341,7 +350,8 @@ class Profiler extends EventEmitter {
             infos.hasMissingSourceMaps = true
           }
           processInfo(infos, info, profiler.type)
-          this.#logger.debug(() => {
+          // eslint-disable-next-line eslint-rules/eslint-log-printf-style
+          log.debug(() => {
             const profileJson = JSON.stringify(profile, (_, value) => {
               return typeof value === 'bigint' ? value.toString() : value
             })
@@ -358,7 +368,7 @@ class Profiler extends EventEmitter {
       if (hasEncoded) {
         await this.#submit(encodedProfiles, infos, startDate, endDate, snapshotKind)
         profileSubmittedChannel.publish()
-        this.#logger.debug('Submitted profiles')
+        log.debug('Submitted profiles')
       }
     } catch (error) {
       log.error(error)

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

@@ -3,6 +3,7 @@
 const dc = require('dc-polyfill')
 
 const { storage } = require('../../../../datadog-core')
+const log = require('../../log')
 const runtimeMetrics = require('../../runtime_metrics')
 const telemetryMetrics = require('../../telemetry/metrics')
 const { isWebServerSpan, endpointNameFromTags, getStartedSpans } = require('../webspan-utils')
@@ -112,7 +113,6 @@ class NativeWallProfiler {
   #customLabelKeys
   #endpointCollectionEnabled = false
   #flushIntervalMillis = 0
-  #logger
   #mapper
   #pprof
   #samplingIntervalMicros = 0
@@ -136,7 +136,6 @@ class NativeWallProfiler {
     this.#cpuProfilingEnabled = !!options.cpuProfilingEnabled
     this.#endpointCollectionEnabled = !!options.endpointCollectionEnabled
     this.#flushIntervalMillis = options.flushInterval || 60 * 1e3 // 60 seconds
-    this.#logger = options.logger
     // TODO: Remove default value. It is only used in testing.
     this.#samplingIntervalMicros = (options.samplingInterval || 1e3 / 99) * 1000
     this.#telemetryHeartbeatIntervalMillis = options.heartbeatInterval || 60 * 1e3 // 60 seconds
@@ -348,7 +347,7 @@ class NativeWallProfiler {
   #reportV8bug (maybeBug) {
     const tag = `v8_profiler_bug_workaround_enabled:${this.#v8ProfilerBugWorkaroundEnabled}`
     const metric = `v8_cpu_profiler${maybeBug ? '_maybe' : ''}_stuck_event_loop`
-    this.#logger?.warn(`Wall profiler: ${maybeBug ? 'possible ' : ''}v8 profiler stuck event loop detected.`)
+    log.warn('Wall profiler: %sv8 profiler stuck event loop detected.', maybeBug ? 'possible ' : '')
     // report as runtime metric (can be removed in the future when telemetry is mature)
     runtimeMetrics.increment(`runtime.node.profiler.${metric}`, tag, true)
     // report as telemetry metric