dd-trace 1.6.0 → 1.7.0

package/NOTICE

@@ -0,0 +1,4 @@
+Datadog dd-trace-js
+Copyright 2016-Present Datadog, Inc.
+
+This product includes software developed at Datadog, Inc. (https://www.datadoghq.com/).

package/ci/init.js

@@ -1,7 +1,11 @@
 const tracer = require('../packages/dd-trace')
+const { ORIGIN_KEY } = require('../packages/dd-trace/src/constants')
 
 tracer.init({
-  startupLogs: false
+  startupLogs: false,
+  tags: {
+    [ORIGIN_KEY]: 'ciapp-test'
+  }
 })
 
 tracer.use('fs', false)

package/ci/jest/env.js

@@ -1,8 +1,12 @@
 const tracer = require('../../packages/dd-trace')
+const { ORIGIN_KEY } = require('../../packages/dd-trace/src/constants')
 
 tracer.init({
   startupLogs: false,
-  flushInterval: 400000
+  flushInterval: 400000,
+  tags: {
+    [ORIGIN_KEY]: 'ciapp-test'
+  }
 })
 
 tracer.use('fs', false)

package/index.d.ts

@@ -792,7 +792,7 @@ declare namespace plugins {
    * This plugin automatically instruments the
    * [cucumber](https://www.npmjs.com/package/@cucumber/cucumber) module.
    */
-  interface cucumber extends Instrumentation {}
+  interface cucumber extends Integration {}
 
   /**
    * This plugin automatically instruments the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -10,6 +10,7 @@
     "bench": "node benchmark",
     "bench:profiler": "node benchmark/profiler",
     "bench:e2e": "SERVICES=mongo yarn services && cd benchmark/e2e && node benchmark-run.js --duration=30",
+    "bench:e2e:ci-visibility": "node benchmark/e2e-ci/benchmark-run.js",
     "type:doc": "cd docs && yarn && yarn build",
     "type:test": "cd docs && yarn && yarn test",
     "lint": "node scripts/check_licenses.js && eslint . && yarn audit --groups dependencies",

package/packages/datadog-plugin-cucumber/src/index.js

@@ -103,8 +103,8 @@ module.exports = [
     name: '@cucumber/cucumber',
     versions: ['7.0.0 - 7.2.1'],
     file: 'lib/runtime/pickle_runner.js',
-    patch (PickleRunner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber')
+    patch (PickleRunner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber', config)
       const sourceRoot = process.cwd()
       const pl = PickleRunner.default
       this.wrap(
@@ -127,8 +127,8 @@ module.exports = [
     name: '@cucumber/cucumber',
     versions: ['>=7.3.0'],
     file: 'lib/runtime/test_case_runner.js',
-    patch (TestCaseRunner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber')
+    patch (TestCaseRunner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('cucumber', config)
       const sourceRoot = process.cwd()
       const pl = TestCaseRunner.default
       this.wrap(

package/packages/datadog-plugin-cypress/src/plugin.js

@@ -4,6 +4,7 @@ const {
   TEST_SUITE,
   TEST_STATUS,
   TEST_FRAMEWORK_VERSION,
+  TEST_IS_RUM_ACTIVE,
   getTestEnvironmentMetadata,
   CI_APP_ORIGIN,
   getTestParentSpan
@@ -66,19 +67,28 @@ module.exports = (on, config) => {
           }
         })
       }
-      return null
+      return activeSpan ? activeSpan._spanContext._traceId.toString(10) : null
     },
     'dd:afterEach': (test) => {
-      const { state, error } = test
+      const { state, error, isRUMActive } = test
       if (activeSpan) {
         activeSpan.setTag(TEST_STATUS, CYPRESS_STATUS_TO_TEST_STATUS[state])
         if (error) {
           activeSpan.setTag('error', error)
         }
+        if (isRUMActive) {
+          activeSpan.setTag(TEST_IS_RUM_ACTIVE, true)
+        }
         activeSpan.finish()
       }
       activeSpan = null
       return null
+    },
+    'dd:addTags': (tags) => {
+      if (activeSpan) {
+        activeSpan.addTags(tags)
+      }
+      return null
     }
   })
 }

package/packages/datadog-plugin-cypress/src/support.js

@@ -3,15 +3,30 @@ beforeEach(() => {
   cy.task('dd:beforeEach', {
     testName: Cypress.mocha.getRunner().suite.ctx.currentTest.fullTitle(),
     testSuite: Cypress.mocha.getRootSuite().file
+  }).then(traceId => {
+    Cypress.env('traceId', traceId)
   })
 })
 
+after(() => {
+  cy.window().then(win => {
+    win.dispatchEvent(new Event('beforeunload'))
+  })
+})
+
+
 afterEach(() => {
-  const currentTest = Cypress.mocha.getRunner().suite.ctx.currentTest
-  cy.task('dd:afterEach', {
-    testName: currentTest.fullTitle(),
-    testSuite: Cypress.mocha.getRootSuite().file,
-    state: currentTest.state,
-    error: currentTest.err
+  cy.window().then(win => {
+    const currentTest = Cypress.mocha.getRunner().suite.ctx.currentTest
+    const testInfo = {
+      testName: currentTest.fullTitle(),
+      testSuite: Cypress.mocha.getRootSuite().file,
+      state: currentTest.state,
+      error: currentTest.err,
+    }
+    if (win.DD_RUM) {
+      testInfo.isRUMActive = true
+    }
+    cy.task('dd:afterEach', testInfo)
   })
 })

package/packages/datadog-plugin-jest/src/jest-environment.js

@@ -238,8 +238,8 @@ module.exports = [
   {
     name: 'jest-environment-node',
     versions: ['>=24.8.0'],
-    patch: function (NodeEnvironment, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (NodeEnvironment, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
 
       this.wrap(NodeEnvironment.prototype, 'teardown', createWrapTeardown(tracer, this))
 
@@ -257,8 +257,8 @@ module.exports = [
   {
     name: 'jest-environment-jsdom',
     versions: ['>=24.8.0'],
-    patch: function (JsdomEnvironment, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (JsdomEnvironment, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
 
       this.wrap(JsdomEnvironment.prototype, 'teardown', createWrapTeardown(tracer, this))
 

package/packages/datadog-plugin-jest/src/jest-jasmine2.js

@@ -169,8 +169,8 @@ module.exports = [
     name: 'jest-jasmine2',
     versions: ['>=24.8.0'],
     file: 'build/jasmineAsyncInstall.js',
-    patch: function (jasmineAsyncInstallExport, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest')
+    patch: function (jasmineAsyncInstallExport, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('jest', config)
       return this.wrapExport(
         jasmineAsyncInstallExport.default,
         createWrapJasmineAsyncInstall(tracer, this, testEnvironmentMetadata)(jasmineAsyncInstallExport.default)

package/packages/datadog-plugin-mocha/src/index.js

@@ -122,6 +122,7 @@ function getAllTestsInSuite (root) {
 function createWrapRunTests (tracer, testEnvironmentMetadata, sourceRoot) {
   return function wrapRunTests (runTests) {
     return function runTestsWithTrace () {
+      this.once('end', () => tracer._exporter._writer.flush())
       runTests.apply(this, arguments)
       const suite = arguments[0]
       const tests = getAllTestsInSuite(suite)
@@ -239,8 +240,8 @@ module.exports = [
     name: 'mocha',
     versions: ['>=5.2.0'],
     file: 'lib/runner.js',
-    patch (Runner, tracer) {
-      const testEnvironmentMetadata = getTestEnvironmentMetadata('mocha')
+    patch (Runner, tracer, config) {
+      const testEnvironmentMetadata = getTestEnvironmentMetadata('mocha', config)
       const sourceRoot = process.cwd()
       this.wrap(Runner.prototype, 'runTests', createWrapRunTests(tracer, testEnvironmentMetadata, sourceRoot))
       this.wrap(Runner.prototype, 'runTest', createWrapRunTest(tracer, testEnvironmentMetadata, sourceRoot))

package/packages/dd-trace/lib/version.js

@@ -1 +1 @@
-module.exports = '1.6.0'
+module.exports = '1.7.0'

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

@@ -10,5 +10,10 @@ module.exports = {
   SAMPLING_RULE_DECISION: '_dd.rule_psr',
   SAMPLING_LIMIT_DECISION: '_dd.limit_psr',
   SAMPLING_AGENT_DECISION: '_dd.agent_psr',
-  DATADOG_LAMBDA_EXTENSION_PATH: '/opt/extensions/datadog-agent'
+  SAMPLING_MECHANISM_DEFAULT: 0,
+  SAMPLING_MECHANISM_AGENT: 1,
+  SAMPLING_MECHANISM_RULE: 3,
+  SAMPLING_MECHANISM_MANUAL: 4,
+  DATADOG_LAMBDA_EXTENSION_PATH: '/opt/extensions/datadog-agent',
+  UPSTREAM_SERVICES_KEY: '_dd.p.upstream_services'
 }

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

@@ -25,6 +25,7 @@ function format (span) {
 
   extractError(formatted, span)
   extractRootTags(formatted, span)
+  extractChunkTags(formatted, span)
   extractTags(formatted, span)
 
   return formatted
@@ -112,6 +113,17 @@ function extractRootTags (trace, span) {
   addTag({}, trace.metrics, SAMPLING_AGENT_DECISION, context._trace[SAMPLING_AGENT_DECISION])
 }
 
+function extractChunkTags (trace, span) {
+  const context = span.context()
+  const isLocalRoot = span === context._trace.started[0]
+
+  if (!isLocalRoot) return
+
+  for (const key in context._trace.tags) {
+    addTag(trace.meta, trace.metrics, key, context._trace.tags[key])
+  }
+}
+
 function extractError (trace, span) {
   const error = span.context()._tags['error']
   if (isError(error)) {

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

@@ -11,6 +11,7 @@ const spanKey = 'x-datadog-parent-id'
 const originKey = 'x-datadog-origin'
 const samplingKey = 'x-datadog-sampling-priority'
 const sampleKey = 'x-datadog-sampled'
+const tagsKey = 'x-datadog-tags'
 const baggagePrefix = 'ot-baggage-'
 const b3TraceKey = 'x-b3-traceid'
 const b3TraceExpr = /^([0-9a-f]{16}){1,2}$/i
@@ -41,6 +42,7 @@ class TextMapPropagator {
     this._injectSamplingPriority(spanContext, carrier)
     this._injectBaggageItems(spanContext, carrier)
     this._injectB3(spanContext, carrier)
+    this._injectTags(spanContext, carrier)
 
     log.debug(() => `Inject into carrier: ${JSON.stringify(pick(carrier, logKeys))}.`)
   }
@@ -53,6 +55,7 @@ class TextMapPropagator {
     this._extractOrigin(carrier, spanContext)
     this._extractBaggageItems(carrier, spanContext)
     this._extractSamplingPriority(carrier, spanContext)
+    this._extractTags(carrier, spanContext)
 
     log.debug(() => `Extract from carrier: ${JSON.stringify(pick(carrier, logKeys))}.`)
 
@@ -81,6 +84,25 @@ class TextMapPropagator {
     })
   }
 
+  _injectTags (spanContext, carrier) {
+    const trace = spanContext._trace
+    const tags = []
+
+    for (const key in trace.tags) {
+      if (!key.startsWith('_dd.p.')) continue
+
+      tags.push(`${key}=${trace.tags[key]}`)
+    }
+
+    const header = tags.join(',')
+
+    if (header.length <= 512) {
+      carrier[tagsKey] = header
+    } else {
+      trace.tags['_dd.propagation_error:max_size'] = 1
+    }
+  }
+
   _injectB3 (spanContext, carrier) {
     if (!this._config.experimental.b3) return
 
@@ -241,6 +263,18 @@ class TextMapPropagator {
     }
   }
 
+  _extractTags (carrier, spanContext) {
+    if (!carrier[tagsKey]) return
+
+    const pairs = carrier[tagsKey].split(',')
+
+    for (const pair of pairs) {
+      const [key, value] = pair.split('=')
+
+      spanContext._trace.tags[key] = value
+    }
+  }
+
   _isSampled (sampled, debug) {
     if (debug || sampled === '1') {
       return true

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

@@ -22,7 +22,8 @@ class DatadogSpanContext extends SpanContext {
     this._noop = props.noop || null
     this._trace = props.trace || {
       started: [],
-      finished: []
+      finished: [],
+      tags: {}
     }
   }
 

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

@@ -24,6 +24,7 @@ const TEST_SUITE = 'test.suite'
 const TEST_STATUS = 'test.status'
 const TEST_PARAMETERS = 'test.parameters'
 const TEST_SKIP_REASON = 'test.skip_reason'
+const TEST_IS_RUM_ACTIVE = 'test.is_rum_active'
 
 const ERROR_TYPE = 'error.type'
 const ERROR_MESSAGE = 'error.msg'
@@ -43,6 +44,7 @@ module.exports = {
   TEST_STATUS,
   TEST_PARAMETERS,
   TEST_SKIP_REASON,
+  TEST_IS_RUM_ACTIVE,
   ERROR_TYPE,
   ERROR_MESSAGE,
   ERROR_STACK,
@@ -54,7 +56,7 @@ module.exports = {
   getTestSuitePath
 }
 
-function getTestEnvironmentMetadata (testFramework) {
+function getTestEnvironmentMetadata (testFramework, config) {
   // TODO: eventually these will come from the tracer (generally available)
   const ciMetadata = getCIMetadata()
   const {
@@ -83,13 +85,17 @@ function getTestEnvironmentMetadata (testFramework) {
 
   const runtimeAndOSMetadata = getRuntimeAndOSMetadata()
 
-  return {
+  const metadata = {
     [TEST_FRAMEWORK]: testFramework,
     ...gitMetadata,
     ...ciMetadata,
     ...userProvidedGitMetadata,
     ...runtimeAndOSMetadata
   }
+  if (config && config.service) {
+    metadata['service.name'] = config.service
+  }
+  return metadata
 }
 
 function getTestParametersString (parametersByTestName, testName) {

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

@@ -1,14 +1,20 @@
 'use strict'
 
+const coalesce = require('koalas')
 const RateLimiter = require('./rate_limiter')
 const Sampler = require('./sampler')
 const ext = require('../../../ext')
 const { setSamplingRules } = require('./startup-log')
 
 const {
+  SAMPLING_MECHANISM_DEFAULT,
+  SAMPLING_MECHANISM_AGENT,
+  SAMPLING_MECHANISM_RULE,
+  SAMPLING_MECHANISM_MANUAL,
   SAMPLING_RULE_DECISION,
   SAMPLING_LIMIT_DECISION,
-  SAMPLING_AGENT_DECISION
+  SAMPLING_AGENT_DECISION,
+  UPSTREAM_SERVICES_KEY
 } = require('./constants')
 
 const SERVICE_NAME = ext.tags.SERVICE_NAME
@@ -21,6 +27,9 @@ const AUTO_KEEP = ext.priority.AUTO_KEEP
 const USER_KEEP = ext.priority.USER_KEEP
 const DEFAULT_KEY = 'service:,env:'
 
+const defaultSampler = new Sampler(AUTO_KEEP)
+const serviceNames = new Map()
+
 class PrioritySampler {
   constructor (env, { sampleRate, rateLimit = 100, rules = [] } = {}) {
     this._env = env
@@ -50,12 +59,14 @@ class PrioritySampler {
 
     if (this.validate(tag)) {
       context._sampling.priority = tag
+      context._sampling.mechanism = SAMPLING_MECHANISM_MANUAL
+    } else if (auto) {
+      context._sampling.priority = this._getPriorityFromAuto(root)
+    } else {
       return
     }
 
-    if (auto) {
-      context._sampling.priority = this._getPriorityFromAuto(root)
-    }
+    this._addUpstreamService(root)
   }
 
   update (rates) {
@@ -68,7 +79,7 @@ class PrioritySampler {
       samplers[key] = sampler
     }
 
-    samplers[DEFAULT_KEY] = samplers[DEFAULT_KEY] || new Sampler(AUTO_KEEP)
+    samplers[DEFAULT_KEY] = samplers[DEFAULT_KEY] || defaultSampler
 
     this._samplers = samplers
   }
@@ -116,6 +127,7 @@ class PrioritySampler {
 
   _getPriorityByRule (context, rule) {
     context._trace[SAMPLING_RULE_DECISION] = rule.sampleRate
+    context._sampling.mechanism = SAMPLING_MECHANISM_RULE
 
     return rule.sampler.isSampled(context) && this._isSampledByRateLimit(context) ? USER_KEEP : USER_REJECT
   }
@@ -134,9 +146,44 @@ class PrioritySampler {
 
     context._trace[SAMPLING_AGENT_DECISION] = sampler.rate()
 
+    if (sampler === defaultSampler) {
+      context._sampling.mechanism = SAMPLING_MECHANISM_DEFAULT
+    } else {
+      context._sampling.mechanism = SAMPLING_MECHANISM_AGENT
+    }
+
     return sampler.isSampled(context) ? AUTO_KEEP : AUTO_REJECT
   }
 
+  _addUpstreamService (span) {
+    const context = span.context()
+    const trace = context._trace
+    const service = this._toBase64(context._tags['service.name'])
+    const priority = context._sampling.priority
+    const mechanism = context._sampling.mechanism
+    const rate = Math.ceil(coalesce(
+      context._trace[SAMPLING_RULE_DECISION],
+      context._trace[SAMPLING_AGENT_DECISION]
+    ) * 10000) / 10000
+    const group = `${service}|${priority}|${mechanism}|${rate}`
+    const groups = trace.tags[UPSTREAM_SERVICES_KEY]
+      ? `${trace.tags[UPSTREAM_SERVICES_KEY]};${group}`
+      : group
+
+    trace.tags[UPSTREAM_SERVICES_KEY] = groups
+  }
+
+  _toBase64 (serviceName) {
+    let encoded = serviceNames.get(serviceName)
+
+    if (!encoded) {
+      encoded = Buffer.from(serviceName).toString('base64')
+      serviceNames.set(serviceName, encoded)
+    }
+
+    return encoded
+  }
+
   _normalizeRules (rules, sampleRate) {
     return rules
       .concat({ sampleRate })

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

@@ -55,7 +55,6 @@ class AgentExporter {
   }
 
   export ({ profiles, start, end, tags }) {
-    const form = new FormData()
     const types = Object.keys(profiles)
 
     const fields = [
@@ -75,10 +74,6 @@ class AgentExporter {
       ...Object.entries(tags).map(([key, value]) => ['tags[]', `${key}:${value}`])
     ]
 
-    for (const [key, value] of fields) {
-      form.append(key, value)
-    }
-
     this._logger.debug(() => {
       const body = fields.map(([key, value]) => `  ${key}: ${value}`).join('\n')
       return `Building agent export report: ${'\n' + body}`
@@ -93,36 +88,14 @@ class AgentExporter {
         return `Adding ${type} profile to agent export: ` + bytes
       })
 
-      form.append(`types[${index}]`, type)
-      form.append(`data[${index}]`, buffer, {
+      fields.push([`types[${index}]`, type])
+      fields.push([`data[${index}]`, buffer, {
         filename: `${type}.pb.gz`,
         contentType: 'application/octet-stream',
         knownLength: buffer.length
-      })
-    }
-
-    const options = {
-      method: 'POST',
-      path: '/profiling/v1/input',
-      headers: form.getHeaders()
-    }
-
-    if (containerId) {
-      options.headers['Datadog-Container-ID'] = containerId
+      }])
     }
 
-    if (this._url.protocol === 'unix:') {
-      options.socketPath = this._url.pathname
-    } else {
-      options.protocol = this._url.protocol
-      options.hostname = this._url.hostname
-      options.port = this._url.port
-    }
-
-    this._logger.debug(() => {
-      return `Submitting agent report to: ${JSON.stringify(options)}`
-    })
-
     return new Promise((resolve, reject) => {
       const operation = retry.operation({
         randomize: true,
@@ -131,8 +104,36 @@ class AgentExporter {
       })
 
       operation.attempt((attempt) => {
-        const timeout = this._backoffTime * Math.pow(2, attempt)
-        sendRequest({ ...options, timeout }, form, (err, response) => {
+        const form = new FormData()
+
+        for (const [key, value, options] of fields) {
+          form.append(key, value, options)
+        }
+
+        const options = {
+          method: 'POST',
+          path: '/profiling/v1/input',
+          headers: form.getHeaders(),
+          timeout: this._backoffTime * Math.pow(2, attempt)
+        }
+
+        if (containerId) {
+          options.headers['Datadog-Container-ID'] = containerId
+        }
+
+        if (this._url.protocol === 'unix:') {
+          options.socketPath = this._url.pathname
+        } else {
+          options.protocol = this._url.protocol
+          options.hostname = this._url.hostname
+          options.port = this._url.port
+        }
+
+        this._logger.debug(() => {
+          return `Submitting profiler agent report attempt #${attempt} to: ${JSON.stringify(options)}`
+        })
+
+        sendRequest(options, form, (err, response) => {
           if (operation.retry(err)) {
             this._logger.error(`Error from the agent: ${err.message}`)
             return