dd-trace 3.15.0 → 3.17.0

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

@@ -132,7 +132,7 @@ class TextMapPropagator {
     const hasB3multi = this._hasPropagationStyle('inject', 'b3multi')
     if (!(hasB3 || hasB3multi)) return
 
-    carrier[b3TraceKey] = spanContext._traceId.toString(16)
+    carrier[b3TraceKey] = this._getB3TraceId(spanContext)
     carrier[b3SpanKey] = spanContext._spanId.toString(16)
     carrier[b3SampledKey] = spanContext._sampling.priority >= AUTO_KEEP ? '1' : '0'
 
@@ -149,7 +149,7 @@ class TextMapPropagator {
     const hasB3SingleHeader = this._hasPropagationStyle('inject', 'b3 single header')
     if (!hasB3SingleHeader) return null
 
-    const traceId = spanContext._traceId.toString(16)
+    const traceId = this._getB3TraceId(spanContext)
     const spanId = spanContext._spanId.toString(16)
     const sampled = spanContext._sampling.priority >= AUTO_KEEP ? '1' : '0'
 
@@ -277,6 +277,8 @@ class TextMapPropagator {
       spanContext._sampling.priority = priority
     }
 
+    this._extract128BitTraceId(b3[b3TraceKey], spanContext)
+
     return spanContext
   }
 
@@ -321,6 +323,8 @@ class TextMapPropagator {
         tracestate
       })
 
+      this._extract128BitTraceId(traceId, spanContext)
+
       tracestate.forVendor('dd', state => {
         for (const [key, value] of state.entries()) {
           switch (key) {
@@ -484,6 +488,20 @@ class TextMapPropagator {
     }
   }
 
+  _extract128BitTraceId (traceId, spanContext) {
+    if (!spanContext) return
+
+    const buffer = spanContext._traceId.toBuffer()
+
+    if (buffer.length !== 16) return
+
+    const tid = traceId.substring(0, 16)
+
+    if (tid === '0000000000000000') return
+
+    spanContext._trace.tags['_dd.p.tid'] = tid
+  }
+
   _validateTagKey (key) {
     return tagKeyExpr.test(key)
   }
@@ -501,6 +519,14 @@ class TextMapPropagator {
       return AUTO_REJECT
     }
   }
+
+  _getB3TraceId (spanContext) {
+    if (spanContext._traceId.toBuffer().length <= 8 && spanContext._trace.tags['_dd.p.tid']) {
+      return spanContext._trace.tags['_dd.p.tid'] + spanContext._traceId.toString(16)
+    }
+
+    return spanContext._traceId.toString(16)
+  }
 }
 
 module.exports = TextMapPropagator

package/packages/dd-trace/src/opentracing/span.js

@@ -32,9 +32,14 @@ class DatadogSpan {
     this._processor = processor
     this._prioritySampler = prioritySampler
     this._store = storage.getStore()
+    this._duration = undefined
+
+    // For internal use only. You probably want `context()._name`.
+    // This name property is not updated when the span name changes.
+    // This is necessary for span count metrics.
     this._name = operationName
 
-    this._spanContext = this._createContext(parent)
+    this._spanContext = this._createContext(parent, fields)
     this._spanContext._name = operationName
     this._spanContext._tags = tags
     this._spanContext._hostname = hostname
@@ -140,7 +145,7 @@ class DatadogSpan {
     this._processor.process(this)
   }
 
-  _createContext (parent) {
+  _createContext (parent, fields) {
     let spanContext
 
     if (parent) {
@@ -153,16 +158,27 @@ class DatadogSpan {
         trace: parent._trace,
         tracestate: parent._tracestate
       })
+
+      if (!spanContext._trace.startTime) {
+        spanContext._trace.startTime = dateNow()
+      }
     } else {
       const spanId = id()
+      const startTime = dateNow()
       spanContext = new SpanContext({
         traceId: spanId,
         spanId
       })
+      spanContext._trace.startTime = startTime
+
+      if (fields.traceId128BitGenerationEnabled) {
+        spanContext._trace.tags['_dd.p.tid'] = Math.floor(startTime / 1000).toString(16)
+          .padStart(8, '0')
+          .padEnd(16, '0')
+      }
     }
 
     spanContext._trace.started.push(this)
-    spanContext._trace.startTime = spanContext._trace.startTime || dateNow()
     spanContext._trace.ticks = spanContext._trace.ticks || now()
 
     return spanContext

package/packages/dd-trace/src/opentracing/span_context.js

@@ -34,7 +34,9 @@ class DatadogSpanContext {
 
   toTraceparent () {
     const flags = this._sampling.priority >= AUTO_KEEP ? '01' : '00'
-    const traceId = this._traceId.toString(16).padStart(32, '0')
+    const traceId = this._traceId.toBuffer().length <= 8 && this._trace.tags['_dd.p.tid']
+      ? this._trace.tags['_dd.p.tid'] + this._traceId.toString(16).padStart(16, '0')
+      : this._traceId.toString(16).padStart(32, '0')
     const spanId = this._spanId.toString(16).padStart(16, '0')
     const version = (this._traceparent && this._traceparent.version) || '00'
     return `${version}-${traceId}-${spanId}-${flags}`

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

@@ -33,6 +33,7 @@ class DatadogTracer {
     this._processor = new SpanProcessor(this._exporter, this._prioritySampler, config)
     this._url = this._exporter._url
     this._enableGetRumData = config.experimental.enableGetRumData
+    this._traceId128BitGenerationEnabled = config.traceId128BitGenerationEnabled
     this._propagators = {
       [formats.TEXT_MAP]: new TextMapPropagator(config),
       [formats.HTTP_HEADERS]: new HttpPropagator(config),
@@ -58,7 +59,8 @@ class DatadogTracer {
       parent,
       tags,
       startTime: options.startTime,
-      hostname: this._hostname
+      hostname: this._hostname,
+      traceId128BitGenerationEnabled: this._traceId128BitGenerationEnabled
     }, this._debug)
 
     span.addTags(this._tags)

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

@@ -28,17 +28,17 @@ loadChannel.subscribe(({ name }) => {
   const Plugin = plugins[name]
 
   if (!Plugin || typeof Plugin !== 'function') return
-  if (!pluginClasses[Plugin.name]) {
-    const envName = `DD_TRACE_${Plugin.name.toUpperCase()}_ENABLED`
+  if (!pluginClasses[Plugin.id]) {
+    const envName = `DD_TRACE_${Plugin.id.toUpperCase()}_ENABLED`
     const enabled = process.env[envName.replace(/[^a-z0-9_]/ig, '_')]
 
     // TODO: remove the need to load the plugin class in order to disable the plugin
-    if (isFalse(enabled) || disabledPlugins.has(Plugin.name)) {
-      log.debug(`Plugin "${Plugin.name}" was disabled via configuration option.`)
+    if (isFalse(enabled) || disabledPlugins.has(Plugin.id)) {
+      log.debug(`Plugin "${Plugin.id}" was disabled via configuration option.`)
 
-      pluginClasses[Plugin.name] = null
+      pluginClasses[Plugin.id] = null
     } else {
-      pluginClasses[Plugin.name] = Plugin
+      pluginClasses[Plugin.id] = Plugin
     }
   }
 })
@@ -56,7 +56,7 @@ module.exports = class PluginManager {
 
       if (!Plugin || typeof Plugin !== 'function') return
 
-      this.loadPlugin(Plugin.name)
+      this.loadPlugin(Plugin.id)
     }
 
     loadChannel.subscribe(this._loadedSubscriber)

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

@@ -12,7 +12,7 @@ const {
   TEST_MODULE_ID,
   TEST_SESSION_ID,
   TEST_COMMAND,
-  TEST_BUNDLE
+  TEST_MODULE
 } = require('./util/test')
 const Plugin = require('./plugin')
 const { COMPONENT } = require('../constants')
@@ -22,13 +22,13 @@ module.exports = class CiPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
-    this.addSub(`ci:${this.constructor.name}:itr-configuration`, ({ onDone }) => {
+    this.addSub(`ci:${this.constructor.id}:itr-configuration`, ({ onDone }) => {
       if (!this.tracer._exporter || !this.tracer._exporter.getItrConfiguration) {
         return onDone({ err: new Error('CI Visibility was not initialized correctly') })
       }
       this.tracer._exporter.getItrConfiguration(this.testConfiguration, (err, itrConfig) => {
         if (err) {
-          log.error(`Error fetching intelligent test runner configuration: ${err.message}`)
+          log.error(`Intelligent Test Runner configuration could not be fetched. ${err.message}`)
         } else {
           this.itrConfig = itrConfig
         }
@@ -36,40 +36,40 @@ module.exports = class CiPlugin extends Plugin {
       })
     })
 
-    this.addSub(`ci:${this.constructor.name}:test-suite:skippable`, ({ onDone }) => {
+    this.addSub(`ci:${this.constructor.id}:test-suite:skippable`, ({ onDone }) => {
       if (!this.tracer._exporter || !this.tracer._exporter.getSkippableSuites) {
         return onDone({ err: new Error('CI Visibility was not initialized correctly') })
       }
       this.tracer._exporter.getSkippableSuites(this.testConfiguration, (err, skippableSuites) => {
         if (err) {
-          log.error(`Error fetching skippable suites: ${err.message}`)
+          log.error(`Skippable suites could not be fetched. ${err.message}`)
         }
         onDone({ err, skippableSuites })
       })
     })
 
-    this.addSub(`ci:${this.constructor.name}:session:start`, ({ command, frameworkVersion, rootDir }) => {
+    this.addSub(`ci:${this.constructor.id}:session:start`, ({ command, frameworkVersion, rootDir }) => {
       const childOf = getTestParentSpan(this.tracer)
-      const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion)
-      const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion)
+      const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion, this.constructor.id)
+      const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion, this.constructor.id)
 
       this.command = command
       this.frameworkVersion = frameworkVersion
       // only for playwright
       this.rootDir = rootDir
 
-      this.testSessionSpan = this.tracer.startSpan(`${this.constructor.name}.test_session`, {
+      this.testSessionSpan = this.tracer.startSpan(`${this.constructor.id}.test_session`, {
         childOf,
         tags: {
-          [COMPONENT]: this.constructor.name,
+          [COMPONENT]: this.constructor.id,
           ...this.testEnvironmentMetadata,
           ...testSessionSpanMetadata
         }
       })
-      this.testModuleSpan = this.tracer.startSpan(`${this.constructor.name}.test_module`, {
+      this.testModuleSpan = this.tracer.startSpan(`${this.constructor.id}.test_module`, {
         childOf: this.testSessionSpan,
         tags: {
-          [COMPONENT]: this.constructor.name,
+          [COMPONENT]: this.constructor.id,
           ...this.testEnvironmentMetadata,
           ...testModuleSpanMetadata
         }
@@ -79,7 +79,7 @@ module.exports = class CiPlugin extends Plugin {
 
   configure (config) {
     super.configure(config)
-    this.testEnvironmentMetadata = getTestEnvironmentMetadata(this.constructor.name, this.config)
+    this.testEnvironmentMetadata = getTestEnvironmentMetadata(this.constructor.id, this.config)
     this.codeOwnersEntries = getCodeOwnersFileEntries()
 
     const {
@@ -110,7 +110,7 @@ module.exports = class CiPlugin extends Plugin {
 
     let testTags = {
       ...getTestCommonTags(testName, testSuite, this.frameworkVersion),
-      [COMPONENT]: this.constructor.name,
+      [COMPONENT]: this.constructor.id,
       ...extraTags
     }
 
@@ -129,7 +129,7 @@ module.exports = class CiPlugin extends Plugin {
         [TEST_SUITE_ID]: testSuiteSpan.context().toSpanId(),
         [TEST_SESSION_ID]: testSuiteSpan.context().toTraceId(),
         [TEST_COMMAND]: testSuiteSpan.context()._tags[TEST_COMMAND],
-        [TEST_BUNDLE]: testSuiteSpan.context()._tags[TEST_COMMAND]
+        [TEST_MODULE]: this.constructor.id
       }
       if (testSuiteSpan.context()._parentId) {
         suiteTags[TEST_MODULE_ID] = testSuiteSpan.context()._parentId.toString(10)
@@ -142,7 +142,7 @@ module.exports = class CiPlugin extends Plugin {
     }
 
     const testSpan = this.tracer
-      .startSpan(`${this.constructor.name}.test`, {
+      .startSpan(`${this.constructor.id}.test`, {
         childOf,
         tags: {
           ...this.testEnvironmentMetadata,

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

@@ -39,6 +39,7 @@ module.exports = {
   get 'jest-environment-node' () { return require('../../../datadog-plugin-jest/src') },
   get 'jest-environment-jsdom' () { return require('../../../datadog-plugin-jest/src') },
   get 'jest-jasmine2' () { return require('../../../datadog-plugin-jest/src') },
+  get 'jest-worker' () { return require('../../../datadog-plugin-jest/src') },
   get 'koa' () { return require('../../../datadog-plugin-koa/src') },
   get 'koa-router' () { return require('../../../datadog-plugin-koa/src') },
   get 'kafkajs' () { return require('../../../datadog-plugin-kafkajs/src') },

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

@@ -39,7 +39,7 @@ module.exports = class LogPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
-    this.addSub(`apm:${this.constructor.name}:log`, (arg) => {
+    this.addSub(`apm:${this.constructor.id}:log`, (arg) => {
       const store = storage.getStore()
       const span = store && store.span
 

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

@@ -1,5 +1,6 @@
 'use strict'
 
+const { CLIENT_PORT_KEY } = require('../constants')
 const TracingPlugin = require('./tracing')
 
 // TODO: Exit span on finish when AsyncResource instances are removed.
@@ -23,7 +24,7 @@ class OutgoingPlugin extends TracingPlugin {
 
     span.addTags({
       'out.host': hostname,
-      'out.port': port
+      [CLIENT_PORT_KEY]: port
     })
   }
 }

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

@@ -9,7 +9,7 @@ class TracingPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
-    this.component = this.constructor.component || this.constructor.name
+    this.component = this.constructor.component || this.constructor.id
     this.operation = this.constructor.operation
 
     this.addTraceSub('start', message => {

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

@@ -534,6 +534,18 @@ module.exports = {
       }
     }
 
+    if (env.TEAMCITY_VERSION) {
+      const { BUILD_URL, TEAMCITY_BUILDCONF_NAME, DATADOG_BUILD_ID } = env
+      tags = {
+        [CI_PROVIDER_NAME]: 'teamcity',
+        [CI_JOB_URL]: BUILD_URL,
+        [CI_JOB_NAME]: TEAMCITY_BUILDCONF_NAME,
+        [CI_ENV_VARS]: JSON.stringify({
+          DATADOG_BUILD_ID
+        })
+      }
+    }
+
     normalizeTag(tags, CI_WORKSPACE_PATH, resolveTilde)
     normalizeTag(tags, GIT_REPOSITORY_URL, filterSensitiveInfoFromRepository)
     normalizeTag(tags, GIT_BRANCH, normalizeRef)

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

@@ -2,18 +2,18 @@
 
 const BlockList = require('./ip_blocklist')
 const net = require('net')
-const log = require('../../log')
 
 const ipHeaderList = [
   'x-forwarded-for',
   'x-real-ip',
-  'client-ip',
+  'true-client-ip',
+  'x-client-ip',
   'x-forwarded',
-  'x-cluster-client-ip',
   'forwarded-for',
-  'forwarded',
-  'via',
-  'true-client-ip'
+  'x-cluster-client-ip',
+  'fastly-client-ip',
+  'cf-connecting-ip',
+  'cf-connecting-ipv6'
 ]
 
 const privateCIDRs = [
@@ -41,36 +41,31 @@ function extractIp (config, req) {
   const headers = req.headers
   if (config.clientIpHeader) {
     if (!headers) return
-    const header = headers[config.clientIpHeader]
-    if (!header) return
 
-    return findFirstIp(header)
+    const ip = findFirstIp(headers[config.clientIpHeader])
+    return ip.public || ip.private
   }
 
-  const foundHeaders = []
+  let firstPrivateIp
   if (headers) {
     for (let i = 0; i < ipHeaderList.length; i++) {
-      if (headers[ipHeaderList[i]]) {
-        foundHeaders.push(ipHeaderList[i])
+      const firstIp = findFirstIp(headers[ipHeaderList[i]])
+
+      if (firstIp.public) {
+        return firstIp.public
+      } else if (!firstPrivateIp && firstIp.private) {
+        firstPrivateIp = firstIp.private
       }
     }
   }
 
-  if (foundHeaders.length === 1) {
-    const header = headers[foundHeaders[0]]
-    const firstIp = findFirstIp(header)
-
-    if (firstIp) return firstIp
-  } else if (foundHeaders.length > 1) {
-    log.error(`Cannot find client IP: multiple IP headers detected ${foundHeaders}`)
-    return
-  }
-
-  return req.socket && req.socket.remoteAddress
+  return firstPrivateIp || (req.socket && req.socket.remoteAddress)
 }
 
 function findFirstIp (str) {
-  let firstPrivateIp
+  const result = {}
+  if (!str) return result
+
   const splitted = str.split(',')
 
   for (let i = 0; i < splitted.length; i++) {
@@ -83,14 +78,15 @@ function findFirstIp (str) {
 
     if (!privateIPMatcher.check(chunk, type === 6 ? 'ipv6' : 'ipv4')) {
       // it's public, return it immediately
-      return chunk
+      result.public = chunk
+      break
     }
 
     // it's private, only save the first one found
-    if (!firstPrivateIp) firstPrivateIp = chunk
+    if (!result.private) result.private = chunk
   }
 
-  return firstPrivateIp
+  return result
 }
 
 module.exports = {

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

@@ -38,10 +38,11 @@ const TEST_CODE_OWNERS = 'test.codeowners'
 const TEST_SOURCE_FILE = 'test.source.file'
 const LIBRARY_VERSION = 'library_version'
 const TEST_COMMAND = 'test.command'
-const TEST_BUNDLE = 'test.bundle'
+const TEST_MODULE = 'test.module'
 const TEST_SESSION_ID = 'test_session_id'
 const TEST_MODULE_ID = 'test_module_id'
 const TEST_SUITE_ID = 'test_suite_id'
+const TEST_TOOLCHAIN = 'test.toolchain'
 
 const CI_APP_ORIGIN = 'ciapp-test'
 
@@ -55,6 +56,10 @@ const TEST_MODULE_CODE_COVERAGE_ENABLED = 'test_module.code_coverage.enabled'
 
 const TEST_CODE_COVERAGE_LINES_TOTAL = 'test.codecov_lines_total'
 
+// jest worker variables
+const JEST_WORKER_TRACE_PAYLOAD_CODE = 60
+const JEST_WORKER_COVERAGE_PAYLOAD_CODE = 61
+
 module.exports = {
   TEST_CODE_OWNERS,
   TEST_FRAMEWORK,
@@ -70,6 +75,8 @@ module.exports = {
   TEST_SOURCE_FILE,
   CI_APP_ORIGIN,
   LIBRARY_VERSION,
+  JEST_WORKER_TRACE_PAYLOAD_CODE,
+  JEST_WORKER_COVERAGE_PAYLOAD_CODE,
   getTestEnvironmentMetadata,
   getTestParametersString,
   finishAllTraceSpans,
@@ -82,11 +89,12 @@ module.exports = {
   getTestModuleCommonTags,
   getTestSuiteCommonTags,
   TEST_COMMAND,
+  TEST_TOOLCHAIN,
   TEST_SESSION_ID,
   TEST_MODULE_ID,
   TEST_SUITE_ID,
   TEST_ITR_TESTS_SKIPPED,
-  TEST_BUNDLE,
+  TEST_MODULE,
   TEST_SESSION_ITR_SKIPPING_ENABLED,
   TEST_SESSION_CODE_COVERAGE_ENABLED,
   TEST_MODULE_ITR_SKIPPING_ENABLED,
@@ -99,6 +107,15 @@ module.exports = {
   fromCoverageMapToCoverage
 }
 
+// Returns pkg manager and its version, separated by '-', e.g. npm-8.15.0 or yarn-1.22.19
+function getPkgManager () {
+  try {
+    return process.env.npm_config_user_agent.split(' ')[0].replace('/', '-')
+  } catch (e) {
+    return ''
+  }
+}
+
 function getTestEnvironmentMetadata (testFramework, config) {
   // TODO: eventually these will come from the tracer (generally available)
   const ciMetadata = getCIMetadata()
@@ -261,28 +278,30 @@ function getTestLevelCommonTags (command, testFrameworkVersion) {
   }
 }
 
-function getTestSessionCommonTags (command, testFrameworkVersion) {
+function getTestSessionCommonTags (command, testFrameworkVersion, testFramework) {
   return {
     [SPAN_TYPE]: 'test_session_end',
     [RESOURCE_NAME]: `test_session.${command}`,
+    [TEST_MODULE]: testFramework,
+    [TEST_TOOLCHAIN]: getPkgManager(),
     ...getTestLevelCommonTags(command, testFrameworkVersion)
   }
 }
 
-function getTestModuleCommonTags (command, testFrameworkVersion) {
+function getTestModuleCommonTags (command, testFrameworkVersion, testFramework) {
   return {
     [SPAN_TYPE]: 'test_module_end',
     [RESOURCE_NAME]: `test_module.${command}`,
-    [TEST_BUNDLE]: command,
+    [TEST_MODULE]: testFramework,
     ...getTestLevelCommonTags(command, testFrameworkVersion)
   }
 }
 
-function getTestSuiteCommonTags (command, testFrameworkVersion, testSuite) {
+function getTestSuiteCommonTags (command, testFrameworkVersion, testSuite, testFramework) {
   return {
     [SPAN_TYPE]: 'test_suite_end',
     [RESOURCE_NAME]: `test_suite.${testSuite}`,
-    [TEST_BUNDLE]: command,
+    [TEST_MODULE]: testFramework,
     [TEST_SUITE]: testSuite,
     ...getTestLevelCommonTags(command, testFrameworkVersion)
   }