dd-trace 4.0.0 → 4.1.1

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

@@ -36,6 +36,22 @@ function safeJsonParse (input) {
   }
 }
 
+const namingVersions = ['v0', 'v1']
+const defaultNamingVersion = 'v0'
+
+function validateNamingVersion (versionString) {
+  if (!versionString) {
+    return defaultNamingVersion
+  }
+  if (!namingVersions.includes(versionString)) {
+    log.warn(
+      `Unexpected input for config.spanAttributeSchema, picked default ${defaultNamingVersion}`
+    )
+    return defaultNamingVersion
+  }
+  return versionString
+}
+
 // Shallow clone with property name remapping
 function remapify (input, mappings) {
   if (!input) return
@@ -200,8 +216,11 @@ class Config {
       process.env.DD_TRACE_TELEMETRY_ENABLED,
       !inServerlessEnvironment
     )
-    const DD_TELEMETRY_DEBUG_ENABLED = coalesce(
-      process.env.DD_TELEMETRY_DEBUG_ENABLED,
+    const DD_TELEMETRY_HEARTBEAT_INTERVAL = process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL
+      ? parseInt(process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL) * 1000
+      : 60000
+    const DD_TELEMETRY_DEBUG = coalesce(
+      process.env.DD_TELEMETRY_DEBUG,
       false
     )
     const DD_TRACE_AGENT_PROTOCOL_VERSION = coalesce(
@@ -273,7 +292,9 @@ class Config {
       process.env.DD_TRACE_EXPERIMENTAL_GET_RUM_DATA_ENABLED,
       false
     )
-
+    const DD_TRACE_SPAN_ATTRIBUTE_SCHEMA = validateNamingVersion(
+      process.env.DD_TRACE_SPAN_ATTRIBUTE_SCHEMA
+    )
     const DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH = coalesce(
       process.env.DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH,
       '512'
@@ -489,13 +510,15 @@ ken|consumer_?(?:id|key|secret)|sign(?:ed|ature)?|auth(?:entication|orization)?)
       sourceMap: !isFalse(DD_PROFILING_SOURCE_MAP),
       exporters: DD_PROFILING_EXPORTERS
     }
+    this.spanAttributeSchema = DD_TRACE_SPAN_ATTRIBUTE_SCHEMA
     this.lookup = options.lookup
     this.startupLogs = isTrue(DD_TRACE_STARTUP_LOGS)
     // Disabled for CI Visibility's agentless
     this.telemetry = {
       enabled: DD_TRACE_EXPORTER !== 'datadog' && isTrue(DD_TRACE_TELEMETRY_ENABLED),
+      heartbeatInterval: DD_TELEMETRY_HEARTBEAT_INTERVAL,
       logCollection: isTrue(DD_TELEMETRY_LOG_COLLECTION_ENABLED),
-      debug: isTrue(DD_TELEMETRY_DEBUG_ENABLED)
+      debug: isTrue(DD_TELEMETRY_DEBUG)
     }
     this.protocolVersion = DD_TRACE_AGENT_PROTOCOL_VERSION
     this.tagsHeaderMaxLength = parseInt(DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH)
@@ -545,7 +568,15 @@ ken|consumer_?(?:id|key|secret)|sign(?:ed|ature)?|auth(?:entication|orization)?)
           process.env.DD_GIT_PROPERTIES_FILE,
           `${process.cwd()}/git.properties`
         )
-        const gitPropertiesString = maybeFile(DD_GIT_PROPERTIES_FILE)
+        let gitPropertiesString
+        try {
+          gitPropertiesString = fs.readFileSync(DD_GIT_PROPERTIES_FILE, 'utf8')
+        } catch (e) {
+          // Only log error if the user has set a git.properties path
+          if (process.env.DD_GIT_PROPERTIES_FILE) {
+            log.error(e)
+          }
+        }
         if (gitPropertiesString) {
           const { commitSHA, repositoryUrl } = getGitMetadataFromGitProperties(gitPropertiesString)
           this.commitSHA = this.commitSHA || commitSHA

package/packages/dd-trace/src/encode/coverage-ci-visibility.js

@@ -26,11 +26,19 @@ class CoverageCIVisibilityEncoder extends AgentEncoder {
   }
 
   encodeCodeCoverage (bytes, coverage) {
-    this._encodeMapPrefix(bytes, 3)
+    if (coverage.testId) {
+      this._encodeMapPrefix(bytes, 4)
+    } else {
+      this._encodeMapPrefix(bytes, 3)
+    }
     this._encodeString(bytes, 'test_session_id')
-    this._encodeId(bytes, coverage.traceId)
+    this._encodeId(bytes, coverage.sessionId)
     this._encodeString(bytes, 'test_suite_id')
-    this._encodeId(bytes, coverage.spanId)
+    this._encodeId(bytes, coverage.suiteId)
+    if (coverage.testId) {
+      this._encodeString(bytes, 'span_id')
+      this._encodeId(bytes, coverage.testId)
+    }
     this._encodeString(bytes, 'files')
     this._encodeArrayPrefix(bytes, coverage.files)
     for (const filename of coverage.files) {

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

@@ -0,0 +1,9 @@
+function safeJSONStringify (value) {
+  return JSON.stringify(
+    value,
+    (key, value) => key !== 'dd-api-key' ? value : undefined,
+    process.env.DD_TRACE_BEAUTIFUL_LOGS ? 2 : undefined
+  )
+}
+
+module.exports = { safeJSONStringify }

package/packages/dd-trace/src/exporters/common/writer.js

@@ -2,6 +2,7 @@
 
 const request = require('./request')
 const log = require('../../log')
+const { safeJSONStringify } = require('./util')
 
 class Writer {
   constructor ({ url }) {
@@ -25,11 +26,11 @@ class Writer {
 
   append (payload) {
     if (!request.writable) {
-      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${JSON.stringify(payload)}`)
+      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${safeJSONStringify(payload)}`)
       return
     }
 
-    log.debug(() => `Encoding payload: ${JSON.stringify(payload)}`)
+    log.debug(() => `Encoding payload: ${safeJSONStringify(payload)}`)
 
     this._encode(payload)
   }

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

@@ -4,6 +4,7 @@ const { channel } = require('../../diagnostics_channel')
 const { isFalse } = require('./util')
 const plugins = require('./plugins')
 const log = require('./log')
+const Nomenclature = require('./service-naming')
 
 const loadChannel = channel('dd-trace:instrumentation:load')
 
@@ -96,6 +97,7 @@ module.exports = class PluginManager {
   // like instrumenter.enable()
   configure (config = {}) {
     this._tracerConfig = config
+    Nomenclature.configure(config)
 
     for (const name in pluginClasses) {
       this.loadPlugin(name)

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

@@ -4,6 +4,13 @@ const StoragePlugin = require('./storage')
 
 class CachePlugin extends StoragePlugin {
   static get operation () { return 'command' }
+
+  startSpan (options) {
+    if (!options.kind) {
+      options.kind = this.constructor.kind
+    }
+    return super.startSpan(this.operationName(), options)
+  }
 }
 
 module.exports = CachePlugin

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

@@ -22,6 +22,8 @@ module.exports = class CiPlugin extends Plugin {
   constructor (...args) {
     super(...args)
 
+    this.rootDir = process.cwd() // fallback in case :session:start events are not emitted
+
     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') })

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

@@ -1,9 +1,10 @@
 'use strict'
 
-const OutgoingPlugin = require('./outgoing')
+const OutboundPlugin = require('./outbound')
 
-class ClientPlugin extends OutgoingPlugin {
+class ClientPlugin extends OutboundPlugin {
   static get operation () { return 'request' }
+  static get kind () { return 'client' }
 }
 
 module.exports = ClientPlugin

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

@@ -1,9 +1,21 @@
 'use strict'
 
-const IncomingPlugin = require('./incoming')
+const InboundPlugin = require('./inbound')
 
-class ConsumerPlugin extends IncomingPlugin {
+class ConsumerPlugin extends InboundPlugin {
   static get operation () { return 'receive' }
+  static get kind () { return 'consumer' }
+  static get type () { return 'messaging' }
+
+  startSpan (options) {
+    if (!options.service) {
+      options.service = this.config.service || this.serviceName()
+    }
+    if (!options.kind) {
+      options.kind = this.constructor.kind
+    }
+    return super.startSpan(this.operationName(), options)
+  }
 }
 
 module.exports = ConsumerPlugin

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

@@ -37,12 +37,12 @@ class DatabasePlugin extends StoragePlugin {
     `ddps='${encodedDdps}',ddpv='${encodedDdpv}'`
   }
 
-  injectDbmQuery (query, serviceName) {
+  injectDbmQuery (query, serviceName, isPreparedStatement = false) {
     if (this.config.dbmPropagationMode === 'disabled') {
       return query
     }
     const servicePropagation = this.createDBMPropagationCommentService(serviceName)
-    if (this.config.dbmPropagationMode === 'service') {
+    if (isPreparedStatement || this.config.dbmPropagationMode === 'service') {
       return `/*${servicePropagation}*/ ${query}`
     } else if (this.config.dbmPropagationMode === 'full') {
       this.activeSpan.setTag('_dd.dbm_trace_injected', 'true')

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

@@ -0,0 +1,7 @@
+'use strict'
+
+const TracingPlugin = require('./tracing')
+
+class InboundPlugin extends TracingPlugin {}
+
+module.exports = InboundPlugin

package/packages/dd-trace/src/plugins/{outgoing.js → outbound.js}

@@ -4,7 +4,7 @@ const { CLIENT_PORT_KEY } = require('../constants')
 const TracingPlugin = require('./tracing')
 
 // TODO: Exit span on finish when AsyncResource instances are removed.
-class OutgoingPlugin extends TracingPlugin {
+class OutboundPlugin extends TracingPlugin {
   constructor (...args) {
     super(...args)
 
@@ -29,4 +29,4 @@ class OutgoingPlugin extends TracingPlugin {
   }
 }
 
-module.exports = OutgoingPlugin
+module.exports = OutboundPlugin

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

@@ -1,9 +1,26 @@
 'use strict'
 
-const OutgoingPlugin = require('./outgoing')
+const OutboundPlugin = require('./outbound')
 
-class ProducerPlugin extends OutgoingPlugin {
+class ProducerPlugin extends OutboundPlugin {
   static get operation () { return 'publish' }
+  static get kind () { return 'producer' }
+  static get type () { return 'messaging' }
+
+  startSpan (options) {
+    const spanDefaults = {
+      kind: this.constructor.kind
+    }
+    if (!options.service) {
+      options.service = this.config.service || this.serviceName()
+    }
+    Object.keys(spanDefaults).forEach(
+      key => {
+        if (!options[key]) options[key] = spanDefaults[key]
+      }
+    )
+    return super.startSpan(this.operationName(), options)
+  }
 }
 
 module.exports = ProducerPlugin

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

@@ -1,8 +1,8 @@
 'use strict'
 
-const IncomingPlugin = require('./incoming')
+const InboundPlugin = require('./inbound')
 
-class ServerPlugin extends IncomingPlugin {
+class ServerPlugin extends InboundPlugin {
   static get operation () { return 'request' }
 }
 

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

@@ -3,6 +3,8 @@
 const ClientPlugin = require('./client')
 
 class StoragePlugin extends ClientPlugin {
+  static get type () { return 'storage' }
+
   constructor (...args) {
     super(...args)
 

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

@@ -4,6 +4,7 @@ const Plugin = require('./plugin')
 const { storage } = require('../../../datadog-core')
 const analyticsSampler = require('../analytics_sampler')
 const { COMPONENT } = require('../constants')
+const Nomenclature = require('../service-naming')
 
 class TracingPlugin extends Plugin {
   constructor (...args) {
@@ -31,6 +32,16 @@ class TracingPlugin extends Plugin {
     return store && store.span
   }
 
+  serviceName (...serviceArgs) {
+    const { type, id, kind } = this.constructor
+    return Nomenclature.serviceName(type, kind, id, ...serviceArgs)
+  }
+
+  operationName (...opNameArgs) {
+    const { type, id, kind } = this.constructor
+    return Nomenclature.opName(type, kind, id, ...opNameArgs)
+  }
+
   configure (config) {
     return super.configure({
       ...config,

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

@@ -192,7 +192,7 @@ module.exports = {
         [GIT_TAG]: CI_COMMIT_TAG,
         [GIT_BRANCH]: CI_COMMIT_REF_NAME,
         [CI_WORKSPACE_PATH]: CI_PROJECT_DIR,
-        [CI_PIPELINE_URL]: GITLAB_PIPELINE_URL && GITLAB_PIPELINE_URL.replace('/-/pipelines/', '/pipelines/'),
+        [CI_PIPELINE_URL]: GITLAB_PIPELINE_URL,
         [CI_STAGE_NAME]: CI_JOB_STAGE,
         [CI_JOB_NAME]: GITLAB_CI_JOB_NAME,
         [GIT_COMMIT_MESSAGE]: CI_COMMIT_MESSAGE,

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

@@ -91,8 +91,10 @@ class Config {
       Number(DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE), 0)
     const maxHeapExtensionCount = coalesce(options.oomMaxHeapExtensionCount,
       Number(DD_PROFILING_EXPERIMENTAL_OOM_MAX_HEAP_EXTENSION_COUNT), 0)
-    const exportStrategies = ensureOOMExportStrategies(coalesce(options.oomExportStrategies,
-      DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES), this)
+    const exportStrategies = oomMonitoringEnabled
+      ? ensureOOMExportStrategies(coalesce(options.oomExportStrategies, DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES,
+        [oomExportStrategies.PROCESS]), this)
+      : []
     const exportCommand = oomMonitoringEnabled ? buildExportCommand(this) : undefined
     this.oomMonitoring = {
       enabled: oomMonitoringEnabled,

package/packages/dd-trace/src/service-naming/index.js

@@ -0,0 +1,30 @@
+const { schemaDefinitions } = require('./schemas')
+
+class SchemaManager {
+  constructor () {
+    this.schemas = schemaDefinitions
+    this.config = { spanAttributeSchema: 'v0' }
+  }
+
+  get schema () {
+    return this.schemas[this.version]
+  }
+
+  get version () {
+    return this.config.spanAttributeSchema
+  }
+
+  opName (type, kind, plugin, ...opNameArgs) {
+    return this.schema.getOpName(type, kind, plugin, ...opNameArgs)
+  }
+
+  serviceName (type, kind, plugin, ...serviceNameArgs) {
+    return this.schema.getServiceName(type, kind, plugin, this.config.service, ...serviceNameArgs)
+  }
+
+  configure (config = {}) {
+    this.config = config
+  }
+}
+
+module.exports = new SchemaManager()

package/packages/dd-trace/src/service-naming/schemas/definition.js

@@ -0,0 +1,24 @@
+class SchemaDefinition {
+  constructor (schema) {
+    this.schema = schema
+  }
+
+  getSchemaItem (type, kind, plugin) {
+    const schema = this.schema
+    if (schema && schema[type] && schema[type][kind] && schema[type][kind][plugin]) {
+      return schema[type][kind][plugin]
+    }
+  }
+
+  getOpName (type, kind, plugin, ...opNameArgs) {
+    const item = this.getSchemaItem(type, kind, plugin)
+    return item.opName(...opNameArgs)
+  }
+
+  getServiceName (type, kind, plugin, service, ...serviceNameArgs) {
+    const item = this.getSchemaItem(type, kind, plugin)
+    return item.serviceName(service, ...serviceNameArgs)
+  }
+}
+
+module.exports = SchemaDefinition

package/packages/dd-trace/src/service-naming/schemas/index.js

@@ -0,0 +1,6 @@
+const v0 = require('./v0')
+const v1 = require('./v1')
+
+module.exports = {
+  schemaDefinitions: { v0, v1 }
+}

package/packages/dd-trace/src/service-naming/schemas/util.js

@@ -0,0 +1,5 @@
+function identityService (service) {
+  return service
+}
+
+module.exports = { identityService }

package/packages/dd-trace/src/service-naming/schemas/v0/index.js

@@ -0,0 +1,5 @@
+const SchemaDefinition = require('../definition')
+const messaging = require('./messaging')
+const storage = require('./storage')
+
+module.exports = new SchemaDefinition({ messaging, storage })

package/packages/dd-trace/src/service-naming/schemas/v0/messaging.js

@@ -0,0 +1,64 @@
+const { identityService } = require('../util')
+
+function amqpServiceName (service) {
+  return `${service}-amqp`
+}
+
+const messaging = {
+  producer: {
+    amqplib: {
+      opName: () => 'amqp.command',
+      serviceName: amqpServiceName
+    },
+    amqp10: {
+      opName: () => 'amqp.send',
+      serviceName: amqpServiceName
+    },
+    'google-cloud-pubsub': {
+      opName: () => 'pubsub.request',
+      serviceName: service => `${service}-pubsub`
+    },
+    kafkajs: {
+      opName: () => 'kafka.produce',
+      serviceName: service => `${service}-kafka`
+    },
+    rhea: {
+      opName: () => 'amqp.send',
+      serviceName: service => `${service}-amqp-producer`
+    }
+  },
+  consumer: {
+    amqplib: {
+      opName: () => 'amqp.command',
+      serviceName: amqpServiceName
+    },
+    amqp10: {
+      opName: () => 'amqp.receive',
+      serviceName: amqpServiceName
+    },
+    'google-cloud-pubsub': {
+      opName: () => 'pubsub.receive',
+      serviceName: identityService
+    },
+    kafkajs: {
+      opName: () => 'kafka.consume',
+      serviceName: service => `${service}-kafka`
+    },
+    rhea: {
+      opName: () => 'amqp.receive',
+      serviceName: identityService
+    }
+  },
+  client: {
+    amqplib: {
+      opName: () => 'amqp.command',
+      serviceName: amqpServiceName
+    },
+    'google-cloud-pubsub': {
+      opName: () => 'pubsub.request',
+      serviceName: service => `${service}-pubsub`
+    }
+  }
+}
+
+module.exports = messaging

package/packages/dd-trace/src/service-naming/schemas/v0/storage.js

@@ -0,0 +1,33 @@
+function getRedisService (config, connectionName) {
+  if (config.splitByInstance && connectionName) {
+    return config.service
+      ? `${config.service}-${connectionName}`
+      : connectionName
+  }
+
+  return config.service
+}
+
+function fromSystem (service, system) {
+  return system ? `${service}-${system}` : undefined
+}
+
+const redisConfig = {
+  opName: () => 'redis.command',
+  serviceName: (service, config, system, connectionName) => {
+    return getRedisService(config, connectionName) || fromSystem(service, system)
+  }
+}
+
+const storage = {
+  client: {
+    ioredis: redisConfig,
+    memcached: {
+      opName: () => 'memcached.command',
+      serviceName: (service, config, system) => config.service || fromSystem(service, system)
+    },
+    redis: redisConfig
+  }
+}
+
+module.exports = storage

package/packages/dd-trace/src/service-naming/schemas/v1/index.js

@@ -0,0 +1,5 @@
+const SchemaDefinition = require('../definition')
+const messaging = require('./messaging')
+const storage = require('./storage')
+
+module.exports = new SchemaDefinition({ messaging, storage })

package/packages/dd-trace/src/service-naming/schemas/v1/messaging.js

@@ -0,0 +1,52 @@
+const { identityService } = require('../util')
+
+const amqpInbound = {
+  opName: () => 'amqp.process',
+  serviceName: identityService
+}
+
+const amqpOutbound = {
+  opName: () => 'amqp.send',
+  serviceName: identityService
+}
+
+const messaging = {
+  producer: {
+    amqplib: amqpOutbound,
+    amqp10: amqpOutbound,
+    'google-cloud-pubsub': {
+      opName: () => 'gcp.pubsub.send',
+      serviceName: identityService
+    },
+    kafkajs: {
+      opName: () => 'kafka.send',
+      serviceName: identityService
+    },
+    rhea: amqpOutbound
+  },
+  consumer: {
+    amqplib: amqpInbound,
+    amqp10: amqpInbound,
+    'google-cloud-pubsub': {
+      opName: () => 'gcp.pubsub.process',
+      serviceName: identityService
+    },
+    kafkajs: {
+      opName: () => 'kafka.process',
+      serviceName: identityService
+    },
+    rhea: amqpInbound
+  },
+  client: {
+    amqplib: {
+      opName: () => 'amqp.command',
+      serviceName: identityService
+    },
+    'google-cloud-pubsub': {
+      opName: () => 'gcp.pubsub.request',
+      serviceName: identityService
+    }
+  }
+}
+
+module.exports = messaging

package/packages/dd-trace/src/service-naming/schemas/v1/storage.js

@@ -0,0 +1,21 @@
+function configWithFallback (service, config) {
+  return config.service || service
+}
+
+const redisNaming = {
+  opName: () => 'redis.command',
+  serviceName: configWithFallback
+}
+
+const storage = {
+  client: {
+    ioredis: redisNaming,
+    memcached: {
+      opName: () => 'memcached.command',
+      serviceName: configWithFallback
+    },
+    redis: redisNaming
+  }
+}
+
+module.exports = storage

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

@@ -6,10 +6,6 @@ const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')
 
-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')
 
@@ -19,6 +15,7 @@ let pluginManager
 let application
 let host
 let interval
+let heartbeatInterval
 const sentIntegrations = new Set()
 
 function getIntegrations () {
@@ -108,7 +105,7 @@ function createHostObject () {
 }
 
 function getTelemetryData () {
-  return { config, application, host, heartbeatInterval: HEARTBEAT_INTERVAL }
+  return { config, application, host, heartbeatInterval }
 }
 
 function start (aConfig, thePluginManager) {
@@ -119,11 +116,13 @@ function start (aConfig, thePluginManager) {
   pluginManager = thePluginManager
   application = createAppObject()
   host = createHostObject()
+  heartbeatInterval = config.telemetry.heartbeatInterval
+
   dependencies.start(config, application, host)
   sendData(config, application, host, 'app-started', appStarted())
   interval = setInterval(() => {
     sendData(config, application, host, 'app-heartbeat')
-  }, HEARTBEAT_INTERVAL)
+  }, heartbeatInterval)
   interval.unref()
   process.on('beforeExit', onBeforeExit)