WIP: otel baggage support proof of concept

packages/datadog-plugin-aws-sdk/test/eventbridge.spec.js

@@ -27,6 +27,7 @@ describe('EventBridge', () => {
  _traceFlags: {
  sampled: 1
  },
+ _baggageItems: {},
  'x-datadog-trace-id': traceId,
  'x-datadog-parent-id': parentId,
  'x-datadog-sampling-priority': '1',

packages/dd-trace/src/config.js

@@ -462,6 +462,9 @@ class Config {
  this._setValue(defaults, 'appsec.stackTrace.maxDepth', 32)
  this._setValue(defaults, 'appsec.stackTrace.maxStackTraces', 2)
  this._setValue(defaults, 'appsec.wafTimeout', 5e3) // µs
+ this._setValue(defaults, 'baggageMaxBytes', 8192)
+ this._setValue(defaults, 'baggageMaxItems', 64)
+ this._setValue(defaults, 'ciVisibilityTestSessionName', '')
  this._setValue(defaults, 'clientIpEnabled', false)
  this._setValue(defaults, 'clientIpHeader', null)
  this._setValue(defaults, 'codeOriginForSpans.enabled', false)
@@ -501,6 +504,7 @@ class Config {
  this._setValue(defaults, 'isManualApiEnabled', false)
  this._setValue(defaults, 'ciVisibilityTestSessionName', '')
  this._setValue(defaults, 'ciVisAgentlessLogSubmissionEnabled', false)
+ this._setValue(defaults, 'legacyBaggageEnabled', true)
  this._setValue(defaults, 'logInjection', false)
  this._setValue(defaults, 'lookup', undefined)
  this._setValue(defaults, 'memcachedCommandEnabled', false)
@@ -545,8 +549,8 @@ class Config {
  this._setValue(defaults, 'traceId128BitGenerationEnabled', true)
  this._setValue(defaults, 'traceId128BitLoggingEnabled', false)
  this._setValue(defaults, 'tracePropagationExtractFirst', false)
- this._setValue(defaults, 'tracePropagationStyle.inject', ['datadog', 'tracecontext'])
- this._setValue(defaults, 'tracePropagationStyle.extract', ['datadog', 'tracecontext'])
+ this._setValue(defaults, 'tracePropagationStyle.inject', ['datadog', 'tracecontext', 'baggage'])
+ this._setValue(defaults, 'tracePropagationStyle.extract', ['datadog', 'tracecontext', 'baggage'])
  this._setValue(defaults, 'tracePropagationStyle.otelPropagators', false)
  this._setValue(defaults, 'tracing', true)
  this._setValue(defaults, 'url', undefined)
@@ -626,6 +630,8 @@ class Config {
  DD_TRACE_AGENT_HOSTNAME,
  DD_TRACE_AGENT_PORT,
  DD_TRACE_AGENT_PROTOCOL_VERSION,
+ DD_TRACE_BAGGAGE_MAX_BYTES,
+ DD_TRACE_BAGGAGE_MAX_ITEMS,
  DD_TRACE_CLIENT_IP_ENABLED,
  DD_TRACE_CLIENT_IP_HEADER,
  DD_TRACE_ENABLED,
@@ -635,6 +641,7 @@ class Config {
  DD_TRACE_GIT_METADATA_ENABLED,
  DD_TRACE_GLOBAL_TAGS,
  DD_TRACE_HEADER_TAGS,
+ DD_TRACE_LEGACY_BAGGAGE_ENABLED,
  DD_TRACE_MEMCACHED_COMMAND_ENABLED,
  DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP,
  DD_TRACE_PARTIAL_FLUSH_MIN_SPANS,
@@ -706,6 +713,8 @@ class Config {
  this._envUnprocessed['appsec.stackTrace.maxStackTraces'] = DD_APPSEC_MAX_STACK_TRACES
  this._setValue(env, 'appsec.wafTimeout', maybeInt(DD_APPSEC_WAF_TIMEOUT))
  this._envUnprocessed['appsec.wafTimeout'] = DD_APPSEC_WAF_TIMEOUT
+ this._setValue(env, 'baggageMaxBytes', DD_TRACE_BAGGAGE_MAX_BYTES)
+ this._setValue(env, 'baggageMaxItems', DD_TRACE_BAGGAGE_MAX_ITEMS)
  this._setBoolean(env, 'clientIpEnabled', DD_TRACE_CLIENT_IP_ENABLED)
  this._setString(env, 'clientIpHeader', DD_TRACE_CLIENT_IP_HEADER)
  this._setBoolean(env, 'codeOriginForSpans.enabled', DD_CODE_ORIGIN_FOR_SPANS_ENABLED)
@@ -744,6 +753,7 @@ class Config {
  this._setArray(env, 'injectionEnabled', DD_INJECTION_ENABLED)
  this._setBoolean(env, 'isAzureFunction', getIsAzureFunction())
  this._setBoolean(env, 'isGCPFunction', getIsGCPFunction())
+ this._setBoolean(env, 'legacyBaggageEnabled', DD_TRACE_LEGACY_BAGGAGE_ENABLED)
  this._setBoolean(env, 'logInjection', DD_LOGS_INJECTION)
  // Requires an accompanying DD_APM_OBFUSCATION_MEMCACHED_KEEP_COMMAND=true in the agent
  this._setBoolean(env, 'memcachedCommandEnabled', DD_TRACE_MEMCACHED_COMMAND_ENABLED)
@@ -877,6 +887,8 @@ class Config {
  this._optsUnprocessed['appsec.wafTimeout'] = options.appsec.wafTimeout
  this._setBoolean(opts, 'clientIpEnabled', options.clientIpEnabled)
  this._setString(opts, 'clientIpHeader', options.clientIpHeader)
+ this._setValue(opts, 'baggageMaxBytes', options.baggageMaxBytes)
+ this._setValue(opts, 'baggageMaxItems', options.baggageMaxItems)
  this._setBoolean(opts, 'codeOriginForSpans.enabled', options.codeOriginForSpans?.enabled)
  this._setString(opts, 'dbmPropagationMode', options.dbmPropagationMode)
  if (options.dogstatsd) {
@@ -914,6 +926,7 @@ class Config {
  }
  this._setString(opts, 'iast.telemetryVerbosity', options.iast && options.iast.telemetryVerbosity)
  this._setBoolean(opts, 'isCiVisibility', options.isCiVisibility)
+ this._setBoolean(opts, 'legacyBaggageEnabled', options.legacyBaggageEnabled)
  this._setBoolean(opts, 'logInjection', options.logInjection)
  this._setString(opts, 'lookup', options.lookup)
  this._setBoolean(opts, 'openAiLogsEnabled', options.openAiLogsEnabled)

packages/dd-trace/src/noop/span.js

@@ -16,6 +16,9 @@ class NoopSpan {
  setOperationName (name) { return this }
  setBaggageItem (key, value) { return this }
  getBaggageItem (key) {}
+ getAllBaggageItems () {}
+ removeBaggageItem (key) { return this }
+ removeAllBaggageItems () { return this }
  setTag (key, value) { return this }
  addTags (keyValueMap) { return this }
  addLink (link) { return this }

packages/dd-trace/src/opentelemetry/span.js

@@ -236,6 +236,29 @@ class Span {
  return this
  }
 
+ setBaggageItem (key, value) {
+ this._ddSpan._spanContext._baggageItems[key] = value
+ return this
+ }
+
+ getBaggageItem (key) {
+ return this._ddSpan._spanContext._baggageItems[key]
+ }
+
+ getAllBaggageItems () {
+ return JSON.stringify(this._ddSpan._spanContext._baggageItems)
+ }
+
+ removeBaggageItem (key) {
+ delete this._ddSpan._spanContext._baggageItems[key]
+ return this
+ }
+
+ removeAllBaggageItems () {
+ this._ddSpan._spanContext._baggageItems = {}
+ return this
+ }
+
  end (timeInput) {
  if (this.ended) {
  api.diag.error('You can only call end() on a span once.')

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

@@ -107,10 +107,28 @@ class TextMapPropagator {
  }
  }
 
+ _encodeOtelBaggageKey (key) {
+ let encoded = encodeURIComponent(key)
+ encoded = encoded.replaceAll('(', '%28')
+ encoded = encoded.replaceAll(')', '%29')
+ return encoded
+ }
+
  _injectBaggageItems (spanContext, carrier) {
- spanContext._baggageItems && Object.keys(spanContext._baggageItems).forEach(key => {
- carrier[baggagePrefix + key] = String(spanContext._baggageItems[key])
- })
+ if (this._config.legacyBaggageEnabled) {
+ spanContext._baggageItems && Object.keys(spanContext._baggageItems).forEach(key => {
+ carrier[baggagePrefix + key] = String(spanContext._baggageItems[key])
+ })
+ }
+ if (this._hasPropagationStyle('inject', 'baggage')) {
+ if (Object.keys(spanContext._baggageItems).length > this._config.baggageMaxItems) return
+ const baggage = Object.entries(spanContext._baggageItems)
+ .map(([key, value]) =>
+ `${this._encodeOtelBaggageKey(String(key).trim())}=${encodeURIComponent(String(value).trim())}`).join(',')
+ const buf = Buffer.from(baggage)
+ if (buf.length > this._config.baggageMaxBytes) return
+ if (baggage) carrier.baggage = baggage
+ }
  }
 
  _injectTags (spanContext, carrier) {
@@ -299,6 +317,11 @@ class TextMapPropagator {
  default:
  log.warn(`Unknown propagation style: ${extractor}`)
  }
+
+ if (this._config.tracePropagationStyle.extract.includes('baggage') && carrier.baggage) {
+ spanContext = spanContext || new DatadogSpanContext()
+ this._extractBaggageItems(carrier, spanContext)
+ }
  }
 
  return spanContext || this._extractSqsdContext(carrier)
@@ -310,7 +333,7 @@ class TextMapPropagator {
  if (!spanContext) return spanContext
 
  this._extractOrigin(carrier, spanContext)
- this._extractBaggageItems(carrier, spanContext)
+ this._extractLegacyBaggageItems(carrier, spanContext)
  this._extractSamplingPriority(carrier, spanContext)
  this._extractTags(carrier, spanContext)
 
@@ -444,7 +467,7 @@ class TextMapPropagator {
  }
  })
 
- this._extractBaggageItems(carrier, spanContext)
+ this._extractLegacyBaggageItems(carrier, spanContext)
  return spanContext
  }
  return null
@@ -528,14 +551,43 @@ class TextMapPropagator {
  }
  }
 
- _extractBaggageItems (carrier, spanContext) {
- Object.keys(carrier).forEach(key => {
- const match = key.match(baggageExpr)
+ _decodeOtelBaggageKey (key) {
+ let decoded = decodeURIComponent(key)
+ decoded = decoded.replaceAll('%28', '(')
+ decoded = decoded.replaceAll('%29', ')')
+ return decoded
+ }
+
+ _extractLegacyBaggageItems (carrier, spanContext) {
+ if (this._config.legacyBaggageEnabled) {
+ Object.keys(carrier).forEach(key => {
+ const match = key.match(baggageExpr)
 
- if (match) {
- spanContext._baggageItems[match[1]] = carrier[key]
+ if (match) {
+ spanContext._baggageItems[match[1]] = carrier[key]
+ }
+ })
+ }
+ }
+
+ _extractBaggageItems (carrier, spanContext) {
+ const baggages = carrier.baggage.split(',')
+ for (const keyValue of baggages) {
+ if (!keyValue.includes('=')) {
+ spanContext._baggageItems = {}
+ return
  }
- })
+ let [key, value] = keyValue.split('=')
+ key = this._decodeOtelBaggageKey(key.trim())
+ value = decodeURIComponent(value.trim())
+ if (!key || !value) {
+ spanContext._baggageItems = {}
+ return
+ }
+ // the current code assumes precedence of ot-baggage- (legacy opentracing baggage) over baggage
+ if (key in spanContext._baggageItems) return
+ spanContext._baggageItems[key] = value
+ }
  }
 
  _extractSamplingPriority (carrier, spanContext) {

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

@@ -145,6 +145,18 @@ class DatadogSpan {
  return this._spanContext._baggageItems[key]
  }
 
+ getAllBaggageItems () {
+ return JSON.stringify(this._spanContext._baggageItems)
+ }
+
+ removeBaggageItem (key) {
+ delete this._spanContext._baggageItems[key]
+ }
+
+ removeAllBaggageItems () {
+ this._spanContext._baggageItems = {}
+ }
+
  setTag (key, value) {
  this._addTags({ [key]: value })
  return this

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

@@ -36,13 +36,15 @@ class DatadogSpanContext {
  ? this._trace.tags[TRACE_ID_128] + this._traceId.toString(16).padStart(16, '0')
  : this._traceId.toString(16).padStart(32, '0')
  }
+ // if (!this._traceId) return ''
  return this._traceId.toString(10)
  }
 
  toSpanId (get128bitId = false) {
  if (get128bitId) {
  return this._spanId.toString(16).padStart(16, '0')
  }
+ // if (!this._spanId) return ''
  return this._spanId.toString(10)
  }
 

packages/dd-trace/test/config.spec.js

@@ -229,8 +229,8 @@ describe('Config', () => {
  expect(config).to.have.property('spanRemoveIntegrationFromService', false)
  expect(config).to.have.property('instrumentation_config_id', undefined)
  expect(config).to.have.deep.property('serviceMapping', {})
- expect(config).to.have.nested.deep.property('tracePropagationStyle.inject', ['datadog', 'tracecontext'])
- expect(config).to.have.nested.deep.property('tracePropagationStyle.extract', ['datadog', 'tracecontext'])
+ expect(config).to.have.nested.deep.property('tracePropagationStyle.inject', ['datadog', 'tracecontext', 'baggage'])
+ expect(config).to.have.nested.deep.property('tracePropagationStyle.extract', ['datadog', 'tracecontext', 'baggage'])
  expect(config).to.have.nested.property('experimental.runtimeId', false)
  expect(config).to.have.nested.property('experimental.exporter', undefined)
  expect(config).to.have.nested.property('experimental.enableGetRumData', false)