dd-trace 5.41.1 → 5.43.0

package/packages/dd-trace/src/encode/0.4.js

@@ -5,11 +5,22 @@ const { Chunk, MsgpackEncoder } = require('../msgpack')
 const log = require('../log')
 const { isTrue } = require('../util')
 const coalesce = require('koalas')
+const { memoize } = require('../log/utils')
 
 const SOFT_LIMIT = 8 * 1024 * 1024 // 8MB
 
-function formatSpan (span) {
-  return normalizeSpan(truncateSpan(span, false))
+function formatSpan (span, config) {
+  span = normalizeSpan(truncateSpan(span, false))
+  if (span.span_events) {
+    // ensure span events are encoded as tags if agent doesn't support native top level span events
+    if (!config?.trace?.nativeSpanEvents) {
+      span.meta.events = JSON.stringify(span.span_events)
+      delete span.span_events
+    } else {
+      formatSpanEvents(span)
+    }
+  }
+  return span
 }
 
 class AgentEncoder {
@@ -24,6 +35,7 @@ class AgentEncoder {
       process.env.DD_TRACE_ENCODING_DEBUG,
       false
     ))
+    this._config = this._writer?._config
   }
 
   count () {
@@ -74,16 +86,18 @@ class AgentEncoder {
     this._encodeArrayPrefix(bytes, trace)
 
     for (let span of trace) {
-      span = formatSpan(span)
+      span = formatSpan(span, this._config)
       bytes.reserve(1)
 
-      if (span.type && span.meta_struct) {
-        bytes.buffer[bytes.length - 1] = 0x8d
-      } else if (span.type || span.meta_struct) {
-        bytes.buffer[bytes.length - 1] = 0x8c
-      } else {
-        bytes.buffer[bytes.length - 1] = 0x8b
-      }
+      // this is the original size of the fixed map for span attributes that always exist
+      let mapSize = 11
+
+      // increment the payload map size depending on if some optional fields exist
+      if (span.type) mapSize += 1
+      if (span.meta_struct) mapSize += 1
+      if (span.span_events) mapSize += 1
+
+      bytes.buffer[bytes.length - 1] = 0x80 + mapSize
 
       if (span.type) {
         this._encodeString(bytes, 'type')
@@ -112,6 +126,10 @@ class AgentEncoder {
       this._encodeMap(bytes, span.meta)
       this._encodeString(bytes, 'metrics')
       this._encodeMap(bytes, span.metrics)
+      if (span.span_events) {
+        this._encodeString(bytes, 'span_events')
+        this._encodeObjectAsArray(bytes, span.span_events, new Set())
+      }
       if (span.meta_struct) {
         this._encodeString(bytes, 'meta_struct')
         this._encodeMetaStruct(bytes, span.meta_struct)
@@ -200,6 +218,9 @@ class AgentEncoder {
       case 'number':
         this._encodeFloat(bytes, value)
         break
+      case 'boolean':
+        this._encodeBool(bytes, value)
+        break
       default:
         // should not happen
     }
@@ -258,7 +279,7 @@ class AgentEncoder {
       this._encodeObjectAsArray(bytes, value, circularReferencesDetector)
     } else if (value !== null && typeof value === 'object') {
       this._encodeObjectAsMap(bytes, value, circularReferencesDetector)
-    } else if (typeof value === 'string' || typeof value === 'number') {
+    } else if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
       this._encodeValue(bytes, value)
     }
   }
@@ -268,7 +289,7 @@ class AgentEncoder {
     const validKeys = keys.filter(key => {
       const v = value[key]
       return typeof v === 'string' ||
-        typeof v === 'number' ||
+        typeof v === 'number' || typeof v === 'boolean' ||
         (v !== null && typeof v === 'object' && !circularReferencesDetector.has(v))
     })
 
@@ -319,4 +340,79 @@ class AgentEncoder {
   }
 }
 
+const memoizedLogDebug = memoize((key, message) => {
+  log.debug(message)
+  // return something to store in memoize cache
+  return true
+})
+
+function formatSpanEvents (span) {
+  for (const spanEvent of span.span_events) {
+    if (spanEvent.attributes) {
+      for (const [key, value] of Object.entries(spanEvent.attributes)) {
+        const newValue = convertSpanEventAttributeValues(key, value)
+        if (newValue !== undefined) {
+          spanEvent.attributes[key] = newValue
+        } else {
+          delete spanEvent.attributes[key] // delete from attributes if undefined
+        }
+      }
+      if (Object.entries(spanEvent.attributes).length === 0) {
+        delete spanEvent.attributes
+      }
+    }
+  }
+}
+
+function convertSpanEventAttributeValues (key, value, depth = 0) {
+  if (typeof value === 'string') {
+    return {
+      type: 0,
+      string_value: value
+    }
+  } else if (typeof value === 'boolean') {
+    return {
+      type: 1,
+      bool_value: value
+    }
+  } else if (Number.isInteger(value)) {
+    return {
+      type: 2,
+      int_value: value
+    }
+  } else if (typeof value === 'number') {
+    return {
+      type: 3,
+      double_value: value
+    }
+  } else if (Array.isArray(value)) {
+    if (depth === 0) {
+      const convertedArray = value
+        .map((val) => convertSpanEventAttributeValues(key, val, 1))
+        .filter((convertedVal) => convertedVal !== undefined)
+
+      // Only include array_value if there are valid elements
+      if (convertedArray.length > 0) {
+        return {
+          type: 4,
+          array_value: convertedArray
+        }
+      } else {
+        // If all elements were unsupported, return undefined
+        return undefined
+      }
+    } else {
+      memoizedLogDebug(key, 'Encountered nested array data type for span event v0.4 encoding. ' +
+        `Skipping encoding key: ${key}: with value: ${typeof value}.`
+      )
+      return undefined
+    }
+  } else {
+    memoizedLogDebug(key, 'Encountered unsupported data type for span event v0.4 encoding, key: ' +
+       `${key}: with value: ${typeof value}. Skipping encoding of pair.`
+    )
+    return undefined
+  }
+}
+
 module.exports = { AgentEncoder }

package/packages/dd-trace/src/encode/0.5.js

@@ -7,7 +7,13 @@ const ARRAY_OF_TWO = 0x92
 const ARRAY_OF_TWELVE = 0x9c
 
 function formatSpan (span) {
-  return normalizeSpan(truncateSpan(span, false))
+  span = normalizeSpan(truncateSpan(span, false))
+  // ensure span events are encoded as tags
+  if (span.span_events) {
+    span.meta.events = JSON.stringify(span.span_events)
+    delete span.span_events
+  }
+  return span
 }
 
 class AgentEncoder extends BaseEncoder {

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

@@ -48,8 +48,15 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
     this.reset()
   }
 
-  setMetadataTags (tags) {
-    this.metadataTags = tags
+  addMetadataTags (tags) {
+    ALLOWED_CONTENT_TYPES.forEach(type => {
+      if (tags[type]) {
+        this.metadataTags[type] = {
+          ...this.metadataTags[type],
+          ...tags[type]
+        }
+      }
+    })
   }
 
   _encodeTestSuite (bytes, content) {

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

@@ -24,7 +24,8 @@ class AgentExporter {
       prioritySampler,
       lookup,
       protocolVersion,
-      headers
+      headers,
+      config
     })
 
     this._timer = undefined

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

@@ -10,15 +10,16 @@ const BaseWriter = require('../common/writer')
 const METRIC_PREFIX = 'datadog.tracer.node.exporter.agent'
 
 class Writer extends BaseWriter {
-  constructor ({ prioritySampler, lookup, protocolVersion, headers }) {
+  constructor ({ prioritySampler, lookup, protocolVersion, headers, config = {} }) {
     super(...arguments)
     const AgentEncoder = getEncoder(protocolVersion)
 
     this._prioritySampler = prioritySampler
     this._lookup = lookup
     this._protocolVersion = protocolVersion
-    this._encoder = new AgentEncoder(this)
     this._headers = headers
+    this._config = config
+    this._encoder = new AgentEncoder(this)
   }
 
   _sendPayload (data, count, done) {

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

@@ -68,7 +68,7 @@ function setSingleSpanIngestionTags (span, options) {
   addTag({}, span.metrics, SPAN_SAMPLING_MAX_PER_SECOND, options.maxPerSecond)
 }
 
-function extractSpanLinks (trace, span) {
+function extractSpanLinks (formattedSpan, span) {
   const links = []
   if (span._links) {
     for (const link of span._links) {
@@ -87,10 +87,10 @@ function extractSpanLinks (trace, span) {
       links.push(formattedLink)
     }
   }
-  if (links.length > 0) { trace.meta['_dd.span_links'] = JSON.stringify(links) }
+  if (links.length > 0) { formattedSpan.meta['_dd.span_links'] = JSON.stringify(links) }
 }
 
-function extractSpanEvents (trace, span) {
+function extractSpanEvents (formattedSpan, span) {
   const events = []
   if (span._events) {
     for (const event of span._events) {
@@ -103,10 +103,12 @@ function extractSpanEvents (trace, span) {
       events.push(formattedEvent)
     }
   }
-  if (events.length > 0) { trace.meta.events = JSON.stringify(events) }
+  if (events.length > 0) {
+    formattedSpan.span_events = events
+  }
 }
 
-function extractTags (trace, span) {
+function extractTags (formattedSpan, span) {
   const context = span.context()
   const origin = context._trace.origin
   const tags = context._tags
@@ -114,7 +116,7 @@ function extractTags (trace, span) {
   const priority = context._sampling.priority
 
   if (tags['span.kind'] && tags['span.kind'] !== 'internal') {
-    addTag({}, trace.metrics, MEASURED, 1)
+    addTag({}, formattedSpan.metrics, MEASURED, 1)
   }
 
   const tracerService = span.tracer()._service.toLowerCase()
@@ -129,22 +131,22 @@ function extractTags (trace, span) {
       case 'service.name':
       case 'span.type':
       case 'resource.name':
-        addTag(trace, {}, map[tag], tags[tag])
+        addTag(formattedSpan, {}, map[tag], tags[tag])
         break
       // HACK: remove when Datadog supports numeric status code
       case 'http.status_code':
-        addTag(trace.meta, {}, tag, tags[tag] && String(tags[tag]))
+        addTag(formattedSpan.meta, {}, tag, tags[tag] && String(tags[tag]))
         break
       case 'analytics.event':
-        addTag({}, trace.metrics, ANALYTICS, tags[tag] === undefined || tags[tag] ? 1 : 0)
+        addTag({}, formattedSpan.metrics, ANALYTICS, tags[tag] === undefined || tags[tag] ? 1 : 0)
         break
       case HOSTNAME_KEY:
       case MEASURED:
-        addTag({}, trace.metrics, tag, tags[tag] === undefined || tags[tag] ? 1 : 0)
+        addTag({}, formattedSpan.metrics, tag, tags[tag] === undefined || tags[tag] ? 1 : 0)
         break
       case 'error':
         if (context._name !== 'fs.operation') {
-          extractError(trace, tags[tag])
+          extractError(formattedSpan, tags[tag])
         }
         break
       case ERROR_TYPE:
@@ -152,60 +154,60 @@ function extractTags (trace, span) {
       case ERROR_STACK:
         // HACK: remove when implemented in the backend
         if (context._name !== 'fs.operation') {
-          // HACK: to ensure otel.recordException does not influence trace.error
+          // HACK: to ensure otel.recordException does not influence formattedSpan.error
           if (tags.setTraceError) {
-            trace.error = 1
+            formattedSpan.error = 1
           }
         } else {
           break
         }
       default: // eslint-disable-line no-fallthrough
-        addTag(trace.meta, trace.metrics, tag, tags[tag])
+        addTag(formattedSpan.meta, formattedSpan.metrics, tag, tags[tag])
     }
   }
-  setSingleSpanIngestionTags(trace, context._spanSampling)
+  setSingleSpanIngestionTags(formattedSpan, context._spanSampling)
 
-  addTag(trace.meta, trace.metrics, 'language', 'javascript')
-  addTag(trace.meta, trace.metrics, PROCESS_ID, process.pid)
-  addTag(trace.meta, trace.metrics, SAMPLING_PRIORITY_KEY, priority)
-  addTag(trace.meta, trace.metrics, ORIGIN_KEY, origin)
-  addTag(trace.meta, trace.metrics, HOSTNAME_KEY, hostname)
+  addTag(formattedSpan.meta, formattedSpan.metrics, 'language', 'javascript')
+  addTag(formattedSpan.meta, formattedSpan.metrics, PROCESS_ID, process.pid)
+  addTag(formattedSpan.meta, formattedSpan.metrics, SAMPLING_PRIORITY_KEY, priority)
+  addTag(formattedSpan.meta, formattedSpan.metrics, ORIGIN_KEY, origin)
+  addTag(formattedSpan.meta, formattedSpan.metrics, HOSTNAME_KEY, hostname)
 }
 
-function extractRootTags (trace, span) {
+function extractRootTags (formattedSpan, span) {
   const context = span.context()
   const isLocalRoot = span === context._trace.started[0]
   const parentId = context._parentId
 
   if (!isLocalRoot || (parentId && parentId.toString(10) !== '0')) return
 
-  addTag({}, trace.metrics, SAMPLING_RULE_DECISION, context._trace[SAMPLING_RULE_DECISION])
-  addTag({}, trace.metrics, SAMPLING_LIMIT_DECISION, context._trace[SAMPLING_LIMIT_DECISION])
-  addTag({}, trace.metrics, SAMPLING_AGENT_DECISION, context._trace[SAMPLING_AGENT_DECISION])
-  addTag({}, trace.metrics, TOP_LEVEL_KEY, 1)
+  addTag({}, formattedSpan.metrics, SAMPLING_RULE_DECISION, context._trace[SAMPLING_RULE_DECISION])
+  addTag({}, formattedSpan.metrics, SAMPLING_LIMIT_DECISION, context._trace[SAMPLING_LIMIT_DECISION])
+  addTag({}, formattedSpan.metrics, SAMPLING_AGENT_DECISION, context._trace[SAMPLING_AGENT_DECISION])
+  addTag({}, formattedSpan.metrics, TOP_LEVEL_KEY, 1)
 }
 
-function extractChunkTags (trace, span) {
+function extractChunkTags (formattedSpan, 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])
+    addTag(formattedSpan.meta, formattedSpan.metrics, key, context._trace.tags[key])
   }
 }
 
-function extractError (trace, error) {
+function extractError (formattedSpan, error) {
   if (!error) return
 
-  trace.error = 1
+  formattedSpan.error = 1
 
   if (isError(error)) {
     // AggregateError only has a code and no message.
-    addTag(trace.meta, trace.metrics, ERROR_MESSAGE, error.message || error.code)
-    addTag(trace.meta, trace.metrics, ERROR_TYPE, error.name)
-    addTag(trace.meta, trace.metrics, ERROR_STACK, error.stack)
+    addTag(formattedSpan.meta, formattedSpan.metrics, ERROR_MESSAGE, error.message || error.code)
+    addTag(formattedSpan.meta, formattedSpan.metrics, ERROR_TYPE, error.name)
+    addTag(formattedSpan.meta, formattedSpan.metrics, ERROR_STACK, error.stack)
   }
 }
 

package/packages/dd-trace/src/lambda/runtime/patch.js

@@ -2,7 +2,7 @@
 
 const path = require('path')
 
-const { _extractModuleNameAndHandlerPath, _extractModuleRootAndHandler, _getLambdaFilePath } = require('./ritm')
+const { _extractModuleNameAndHandlerPath, _extractModuleRootAndHandler, _getLambdaFilePaths } = require('./ritm')
 const { datadog } = require('../handler')
 const { addHook } = require('../../../../datadog-instrumentations/src/helpers/instrument')
 const shimmer = require('../../../../datadog-shimmer')
@@ -65,9 +65,11 @@ if (originalLambdaHandler !== undefined) {
   const [_module, handlerPath] = _extractModuleNameAndHandlerPath(moduleAndHandler)
 
   const lambdaStylePath = path.resolve(lambdaTaskRoot, moduleRoot, _module)
-  const lambdaFilePath = _getLambdaFilePath(lambdaStylePath)
+  const lambdaFilePaths = _getLambdaFilePaths(lambdaStylePath)
 
-  addHook({ name: lambdaFilePath }, patchLambdaModule(handlerPath))
+  for (const lambdaFilePath of lambdaFilePaths) {
+    addHook({ name: lambdaFilePath }, patchLambdaModule(handlerPath))
+  }
 } else {
   // Instrumentation is done manually.
   addHook({ name: 'datadog-lambda-js' }, patchDatadogLambdaModule)

package/packages/dd-trace/src/lambda/runtime/ritm.js

@@ -7,7 +7,6 @@
  */
 'use strict'
 
-const fs = require('fs')
 const path = require('path')
 
 const log = require('../../log')
@@ -60,23 +59,18 @@ function _extractModuleNameAndHandlerPath (handler) {
 }
 
 /**
- * Returns the correct path of the file to be patched
- * when required.
+ * Returns all possible paths of the files to be patched when required.
  *
  * @param {*} lambdaStylePath the path comprised of the `LAMBDA_TASK_ROOT`,
  * the root of the module of the Lambda handler, and the module name.
- * @returns the lambdaStylePath with the appropiate extension for the hook.
+ * @returns the lambdaStylePath with appropiate extensions for the hook.
  */
-function _getLambdaFilePath (lambdaStylePath) {
-  let lambdaFilePath = lambdaStylePath
-  if (fs.existsSync(lambdaStylePath + '.js')) {
-    lambdaFilePath += '.js'
-  } else if (fs.existsSync(lambdaStylePath + '.mjs')) {
-    lambdaFilePath += '.mjs'
-  } else if (fs.existsSync(lambdaStylePath + '.cjs')) {
-    lambdaFilePath += '.cjs'
-  }
-  return lambdaFilePath
+function _getLambdaFilePaths (lambdaStylePath) {
+  return [
+    `${lambdaStylePath}.js`,
+    `${lambdaStylePath}.mjs`,
+    `${lambdaStylePath}.cjs`
+  ]
 }
 
 /**
@@ -92,12 +86,13 @@ const registerLambdaHook = () => {
     const [_module] = _extractModuleNameAndHandlerPath(moduleAndHandler)
 
     const lambdaStylePath = path.resolve(lambdaTaskRoot, moduleRoot, _module)
-    const lambdaFilePath = _getLambdaFilePath(lambdaStylePath)
+    const lambdaFilePaths = _getLambdaFilePaths(lambdaStylePath)
 
-    Hook([lambdaFilePath], (moduleExports) => {
+    // TODO: Redo this like any other instrumentation.
+    Hook(lambdaFilePaths, (moduleExports, name) => {
       require('./patch')
 
-      for (const { hook } of instrumentations[lambdaFilePath]) {
+      for (const { hook } of instrumentations[name]) {
         try {
           moduleExports = hook(moduleExports)
         } catch (e) {
@@ -133,6 +128,6 @@ const registerLambdaHook = () => {
 module.exports = {
   _extractModuleRootAndHandler,
   _extractModuleNameAndHandlerPath,
-  _getLambdaFilePath,
+  _getLambdaFilePaths,
   registerLambdaHook
 }

package/packages/dd-trace/src/llmobs/plugins/openai.js

@@ -2,6 +2,13 @@
 
 const LLMObsPlugin = require('./base')
 
+function isIterable (obj) {
+  if (obj == null) {
+    return false
+  }
+  return typeof obj[Symbol.iterator] === 'function'
+}
+
 class OpenAiLLMObsPlugin extends LLMObsPlugin {
   static get id () { return 'openai' }
   static get prefix () {
@@ -16,10 +23,13 @@ class OpenAiLLMObsPlugin extends LLMObsPlugin {
     const inputs = ctx.args[0] // completion, chat completion, and embeddings take one argument
     const operation = getOperation(methodName)
     const kind = operation === 'embedding' ? 'embedding' : 'llm'
-    const name = `openai.${methodName}`
+
+    const { modelProvider, client } = this._getModelProviderAndClient(ctx.basePath)
+
+    const name = `${client}.${methodName}`
 
     return {
-      modelProvider: 'openai',
+      modelProvider,
       modelName: inputs.model,
       kind,
       name
@@ -52,6 +62,16 @@ class OpenAiLLMObsPlugin extends LLMObsPlugin {
     }
   }
 
+  _getModelProviderAndClient (baseUrl = '') {
+    if (baseUrl.includes('azure')) {
+      return { modelProvider: 'azure_openai', client: 'AzureOpenAI' }
+    } else if (baseUrl.includes('deepseek')) {
+      return { modelProvider: 'deepseek', client: 'DeepSeek' }
+    } else {
+      return { modelProvider: 'openai', client: 'OpenAI' }
+    }
+  }
+
   _extractMetrics (response) {
     const metrics = {}
     const tokenUsage = response.usage
@@ -122,6 +142,11 @@ class OpenAiLLMObsPlugin extends LLMObsPlugin {
 
     const outputMessages = []
     const { choices } = response
+    if (!isIterable(choices)) {
+      this._tagger.tagLLMIO(span, messages, [{ content: '' }])
+      return
+    }
+
     for (const choice of choices) {
       const message = choice.message || choice.delta
       const content = message.content || ''

package/packages/dd-trace/src/llmobs/sdk.js

@@ -105,12 +105,12 @@ class LLMObs extends NoopLLMObs {
 
     if (fn.length > 1) {
       return this._tracer.trace(name, spanOptions, (span, cb) =>
-        this._activate(span, { kind, options: llmobsOptions }, () => fn(span, cb))
+        this._activate(span, { kind, ...llmobsOptions }, () => fn(span, cb))
       )
     }
 
     return this._tracer.trace(name, spanOptions, span =>
-      this._activate(span, { kind, options: llmobsOptions }, () => fn(span))
+      this._activate(span, { kind, ...llmobsOptions }, () => fn(span))
     )
   }
 
@@ -166,7 +166,7 @@ class LLMObs extends NoopLLMObs {
       }
 
       try {
-        const result = llmobs._activate(span, { kind, options: llmobsOptions }, () => fn.apply(this, fnArgs))
+        const result = llmobs._activate(span, { kind, ...llmobsOptions }, () => fn.apply(this, fnArgs))
 
         if (result && typeof result.then === 'function') {
           return result.then(

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

@@ -6,19 +6,7 @@ const { isTrue } = require('../util')
 const { traceChannel, debugChannel, infoChannel, warnChannel, errorChannel } = require('./channels')
 const logWriter = require('./writer')
 const { Log } = require('./log')
-
-const memoize = func => {
-  const cache = {}
-  const memoized = function (key) {
-    if (!cache[key]) {
-      cache[key] = func.apply(this, arguments)
-    }
-
-    return cache[key]
-  }
-
-  return memoized
-}
+const { memoize } = require('./utils')
 
 const config = {
   enabled: false,

package/packages/dd-trace/src/log/utils.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const memoize = func => {
+  const cache = {}
+  const memoized = function (key) {
+    if (!cache[key]) {
+      cache[key] = func.apply(this, arguments)
+    }
+
+    return cache[key]
+  }
+
+  return memoized
+}
+
+module.exports = { memoize }

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

@@ -143,6 +143,9 @@ class DatadogSpan {
     return `Span${json}`
   }
 
+  /**
+   * @returns {DatadogSpanContext}
+   */
   context () {
     return this._spanContext
   }