dd-trace 3.15.0 → 3.16.0

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

@@ -2,6 +2,7 @@
 
 const { EventEmitter } = require('events')
 const { Config } = require('./config')
+const { snapshotKinds } = require('./constants')
 
 function maybeSourceMap (sourceMap) {
   if (!sourceMap) return
@@ -49,7 +50,10 @@ class Profiler extends EventEmitter {
     try {
       for (const profiler of config.profilers) {
         // TODO: move this out of Profiler when restoring sourcemap support
-        profiler.start({ mapper })
+        profiler.start({
+          mapper,
+          nearOOMCallback: this._nearOOMExport.bind(this)
+        })
         this._logger.debug(`Started ${profiler.type} profiler`)
       }
 
@@ -60,6 +64,14 @@ class Profiler extends EventEmitter {
     }
   }
 
+  _nearOOMExport (profileType, encodedProfile) {
+    const start = this._lastStart
+    const end = new Date()
+    this._submit({
+      [profileType]: encodedProfile
+    }, start, end, snapshotKinds.ON_OUT_OF_MEMORY)
+  }
+
   _setInterval () {
     this._timeoutInterval = this._config.flushInterval
   }
@@ -69,7 +81,7 @@ class Profiler extends EventEmitter {
 
     // collect and export current profiles
     // once collect returns, profilers can be safely stopped
-    this._collect()
+    this._collect(snapshotKinds.ON_SHUTDOWN)
     this._stop()
   }
 
@@ -93,14 +105,14 @@ class Profiler extends EventEmitter {
     if (!this._enabled) return
     this._lastStart = new Date()
     if (!this._timer || timeout !== this._timeoutInterval) {
-      this._timer = setTimeout(() => this._collect(), timeout)
+      this._timer = setTimeout(() => this._collect(snapshotKinds.PERIODIC), timeout)
       this._timer.unref()
     } else {
       this._timer.refresh()
     }
   }
 
-  async _collect () {
+  async _collect (snapshotKind) {
     if (!this._enabled) return
 
     const start = this._lastStart
@@ -128,7 +140,7 @@ class Profiler extends EventEmitter {
       }
 
       this._capture(this._timeoutInterval)
-      await this._submit(encodedProfiles, start, end)
+      await this._submit(encodedProfiles, start, end, snapshotKind)
       this._logger.debug('Submitted profiles')
     } catch (err) {
       this._logger.error(err)
@@ -136,13 +148,14 @@ class Profiler extends EventEmitter {
     }
   }
 
-  _submit (profiles, start, end) {
+  _submit (profiles, start, end, snapshotKind) {
     if (!Object.keys(profiles).length) {
       return Promise.reject(new Error('No profiles to submit'))
     }
     const { tags } = this._config
     const tasks = []
 
+    tags.snapshot = snapshotKind
     for (const exporter of this._config.exporters) {
       const task = exporter.export({ profiles, start, end, tags })
         .catch(err => this._logger.error(err))
@@ -167,10 +180,10 @@ class ServerlessProfiler extends Profiler {
     this._flushAfterIntervals = this._config.flushInterval / 1000
   }
 
-  async _collect () {
+  async _collect (snapshotKind) {
     if (this._profiledIntervals >= this._flushAfterIntervals) {
       this._profiledIntervals = 0
-      await super._collect()
+      await super._collect(snapshotKind)
     } else {
       this._profiledIntervals += 1
       this._capture(this._timeoutInterval)

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

@@ -1,17 +1,37 @@
 'use strict'
 
+const { oomExportStrategies } = require('../constants')
+
+function strategiesToCallbackMode (strategies, callbackMode) {
+  const hasInterrupt = strategies.includes(oomExportStrategies.INTERRUPT_CALLBACK) ? callbackMode.Interrupt : 0
+  const hasCallback = strategies.includes(oomExportStrategies.ASYNC_CALLBACK) ? callbackMode.Async : 0
+  return hasInterrupt | hasCallback
+}
+
 class NativeSpaceProfiler {
   constructor (options = {}) {
     this.type = 'space'
     this._samplingInterval = options.samplingInterval || 512 * 1024
     this._stackDepth = options.stackDepth || 64
     this._pprof = undefined
+    this._oomMonitoring = options.oomMonitoring || {}
   }
 
-  start ({ mapper } = {}) {
+  start ({ mapper, nearOOMCallback } = {}) {
     this._mapper = mapper
     this._pprof = require('@datadog/pprof')
     this._pprof.heap.start(this._samplingInterval, this._stackDepth)
+    if (this._oomMonitoring.enabled) {
+      const strategies = this._oomMonitoring.exportStrategies
+      this._pprof.heap.monitorOutOfMemory(
+        this._oomMonitoring.heapLimitExtensionSize,
+        this._oomMonitoring.maxHeapExtensionCount,
+        strategies.includes(oomExportStrategies.LOGS),
+        strategies.includes(oomExportStrategies.PROCESS) ? this._oomMonitoring.exportCommand : [],
+        (profile) => nearOOMCallback(this.type, this._pprof.encodeSync(profile)),
+        strategiesToCallbackMode(strategies, this._pprof.heap.CallbackMode)
+      )
+    }
   }
 
   profile () {

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

@@ -73,8 +73,9 @@ class SpanSampler {
 
     const { started } = spanContext._trace
     for (const span of started) {
-      const tags = span.context()._tags || {}
-      const name = span._name
+      const context = span.context()
+      const tags = context._tags || {}
+      const name = context._name
       const service = tags.service ||
         tags['service.name'] ||
         span.tracer()._service

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

@@ -1,6 +1,7 @@
 'use strict'
 
 const tracerVersion = require('../../../../package.json').version
+const dc = require('diagnostics_channel')
 const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')
@@ -9,6 +10,9 @@ const HEARTBEAT_INTERVAL = process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL
   ? Number(process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL) * 1000
   : 60000
 
+const telemetryStartChannel = dc.channel('datadog:telemetry:start')
+const telemetryStopChannel = dc.channel('datadog:telemetry:stop')
+
 let config
 let pluginManager
 
@@ -103,8 +107,12 @@ function createHostObject () {
   }
 }
 
+function getTelemetryData () {
+  return { config, application, host, heartbeatInterval: HEARTBEAT_INTERVAL }
+}
+
 function start (aConfig, thePluginManager) {
-  if (!aConfig.telemetryEnabled) {
+  if (!aConfig.telemetry.enabled) {
     return
   }
   config = aConfig
@@ -118,6 +126,8 @@ function start (aConfig, thePluginManager) {
   }, HEARTBEAT_INTERVAL)
   interval.unref()
   process.on('beforeExit', onBeforeExit)
+
+  telemetryStartChannel.publish(getTelemetryData())
 }
 
 function stop () {
@@ -126,10 +136,14 @@ function stop () {
   }
   clearInterval(interval)
   process.removeListener('beforeExit', onBeforeExit)
+
+  telemetryStopChannel.publish(getTelemetryData())
+
+  config = undefined
 }
 
 function updateIntegrations () {
-  if (!config || !config.telemetryEnabled) {
+  if (!config || !config.telemetry.enabled) {
     return
   }
   const integrations = getIntegrations()

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

@@ -1,5 +1,7 @@
 'use strict'
 
+const path = require('path')
+
 function isTrue (str) {
   str = String(str).toLowerCase()
   return str === 'true' || str === '1'
@@ -61,9 +63,16 @@ function globMatch (pattern, subject) {
   return true
 }
 
+function calculateDDBasePath (dirname) {
+  const dirSteps = dirname.split(path.sep)
+  const packagesIndex = dirSteps.lastIndexOf('packages')
+  return dirSteps.slice(0, packagesIndex).join(path.sep) + path.sep
+}
+
 module.exports = {
   isTrue,
   isFalse,
   isError,
-  globMatch
+  globMatch,
+  calculateDDBasePath
 }

package/scripts/install_plugin_modules.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const fs = require('fs')
+const os = require('os')
 const path = require('path')
 const crypto = require('crypto')
 const semver = require('semver')
@@ -11,6 +12,7 @@ const externals = require('../packages/dd-trace/test/plugins/externals')
 
 const requirePackageJsonPath = require.resolve('../packages/dd-trace/src/require-package-json')
 
+const excludeList = os.arch() === 'arm64' ? ['couchbase', 'grpc', 'oracledb'] : []
 const workspaces = new Set()
 const versionLists = {}
 const deps = {}
@@ -42,6 +44,8 @@ async function run () {
   assertFolder()
   await assertVersions()
   assertWorkspace()
+  // Some native addon packages rely on libraries that are not supported on ARM64
+  excludeList.forEach(pkg => delete workspaces[pkg])
   install()
 }
 
@@ -197,7 +201,7 @@ function install () {
 
 function addFolder (name, version) {
   const basename = [name, version].filter(val => val).join('@')
-  workspaces.add(basename)
+  if (!excludeList.includes(name)) workspaces.add(basename)
 }
 
 function folder (name, version) {

package/scripts/junit_report.js

@@ -1,25 +0,0 @@
-/* eslint-disable no-console */
-
-const { execSync } = require('child_process')
-
-function uploadJUnitXMLReport () {
-  if (process.env.CIRCLE_PR_NUMBER) {
-    console.log('Running in a fork. Skipping step.')
-    return
-  }
-  // we install @datadog/datadog-ci
-  execSync('yarn global add @datadog/datadog-ci@0.13.2', { stdio: 'inherit' })
-  const service = process.env.PLUGINS ? 'plugins' : 'core'
-  // we execute the upload command
-  execSync(
-    `DD_ENV=ci datadog-ci junit upload \
-    --tags runtime.version:${process.version} \
-    --service dd-trace-js-${service}-tests \
-    ./test-results/mocha/test-results.xml`,
-    {
-      stdio: 'inherit'
-    }
-  )
-}
-
-uploadJUnitXMLReport()

package/scripts/tdd.js

@@ -1,34 +0,0 @@
-'use strict'
-
-const execSync = require('child_process').execSync
-const fs = require('fs')
-const path = require('path')
-
-const options = { stdio: [0, 1, 2] }
-const command = 'yarn services && NO_DEPRECATION=* mocha --watch --expose-gc'
-
-const base = path.join(__dirname, '..', 'packages')
-const globs = [
-  'packages/dd-trace/test/setup/node.js'
-].map(glob => `'${glob}'`).join(' ')
-
-const pluginName = /\/?datadog-plugin-([\w -]+)\/?/
-const plugins = []
-const args = process.argv.slice(2).map((arg) => {
-  if (fs.existsSync(path.join(base, `datadog-plugin-${arg}`))) {
-    plugins.push(arg)
-    return `'packages/datadog-plugin-${arg}/test/**/*.spec.js'`
-  } else if (pluginName.test(arg)) {
-    const plugin = arg.match(pluginName)[1]
-    plugins.push(plugin)
-  }
-  return arg
-}).join(' ')
-
-const pluginEnvList = plugins.join('|')
-
-if (plugins) {
-  execSync(`PLUGINS=${pluginEnvList} ${command} ${globs} ${args}`, options)
-} else {
-  execSync(`${command} ${globs} ${args}`, options)
-}