dd-trace 5.72.0 → 5.74.0

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

@@ -2,7 +2,7 @@
 
 const pkg = require('./pkg')
 const { GRPC_CLIENT_ERROR_STATUSES, GRPC_SERVER_ERROR_STATUSES } = require('./constants')
-const { getEnvironmentVariables } = require('./config-helper')
+const { getEnvironmentVariable: getEnv } = require('./config-helper')
 
 // eslint-disable-next-line @stylistic/max-len
 const qsRegex = String.raw`(?:p(?:ass)?w(?:or)?d|pass(?:_?phrase)?|secret|(?:api_?|private_?|public_?|access_?|secret_?)key(?:_?id)?|token|consumer_?(?:id|key|secret)|sign(?:ed|ature)?|auth(?:entication|orization)?)(?:(?:\s|%20)*(?:=|%3D)[^&]+|(?:"|%22)(?:\s|%20)*(?::|%3A)(?:\s|%20)*(?:"|%22)(?:%2[^2]|%[^2]|[^"%])+(?:"|%22))|bearer(?:\s|%20)+[a-z0-9\._\-]+|token(?::|%3A)[a-z0-9]{13}|gh[opsu]_[0-9a-zA-Z]{36}|ey[I-L](?:[\w=-]|%3D)+\.ey[I-L](?:[\w=-]|%3D)+(?:\.(?:[\w.+\/=-]|%3D|%2F|%2B)+)?|[\-]{5}BEGIN(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY[\-]{5}[^\-]+[\-]{5}END(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY|ssh-rsa(?:\s|%20)*(?:[a-z0-9\/\.+]|%2F|%5C|%2B){100,}`
@@ -11,17 +11,10 @@ const defaultWafObfuscatorKeyRegex = String.raw`(?i)pass|pw(?:or)?d|secret|(?:ap
 // eslint-disable-next-line @stylistic/max-len
 const defaultWafObfuscatorValueRegex = String.raw`(?i)(?:p(?:ass)?w(?:or)?d|pass(?:[_-]?phrase)?|secret(?:[_-]?key)?|(?:(?:api|private|public|access)[_-]?)key(?:[_-]?id)?|(?:(?:auth|access|id|refresh)[_-]?)?token|consumer[_-]?(?:id|key|secret)|sign(?:ed|ature)?|auth(?:entication|orization)?|jsessionid|phpsessid|asp\.net(?:[_-]|-)sessionid|sid|jwt)(?:\s*=([^;&]+)|"\s*:\s*("[^"]+"|\d+))|bearer\s+([a-z0-9\._\-]+)|token\s*:\s*([a-z0-9]{13})|gh[opsu]_([0-9a-zA-Z]{36})|ey[I-L][\w=-]+\.(ey[I-L][\w=-]+(?:\.[\w.+\/=-]+)?)|[\-]{5}BEGIN[a-z\s]+PRIVATE\sKEY[\-]{5}([^\-]+)[\-]{5}END[a-z\s]+PRIVATE\sKEY|ssh-rsa\s*([a-z0-9\/\.+]{100,})`
 
-const {
-  AWS_LAMBDA_FUNCTION_NAME,
-  FUNCTION_NAME,
-  K_SERVICE,
-  WEBSITE_SITE_NAME
-} = getEnvironmentVariables()
-
-const service = AWS_LAMBDA_FUNCTION_NAME ||
-  FUNCTION_NAME || // Google Cloud Function Name set by deprecated runtimes
-  K_SERVICE || // Google Cloud Function Name set by newer runtimes
-  WEBSITE_SITE_NAME || // set by Azure Functions
+const service = getEnv('AWS_LAMBDA_FUNCTION_NAME') ||
+  getEnv('FUNCTION_NAME') || // Google Cloud Function Name set by deprecated runtimes
+  getEnv('K_SERVICE') || // Google Cloud Function Name set by newer runtimes
+  getEnv('WEBSITE_SITE_NAME') || // set by Azure Functions
   pkg.name ||
   'node'
 

package/packages/dd-trace/src/llmobs/plugins/ai/util.js

@@ -45,19 +45,24 @@ function getOperation (span) {
 
 /**
  * Get the LLM token usage from the span tags
+ * Supports both AI SDK v4 (promptTokens/completionTokens) and v5 (inputTokens/outputTokens)
  * @template T extends {inputTokens: number, outputTokens: number, totalTokens: number}
  * @param {T} tags
  * @returns {Pick<T, 'inputTokens' | 'outputTokens' | 'totalTokens'>}
  */
 function getUsage (tags) {
   const usage = {}
-  const inputTokens = tags['ai.usage.promptTokens']
-  const outputTokens = tags['ai.usage.completionTokens']
+
+  // AI SDK v5 uses inputTokens/outputTokens, v4 uses promptTokens/completionTokens
+  // Check v5 properties first, fall back to v4
+  const inputTokens = tags['ai.usage.inputTokens'] ?? tags['ai.usage.promptTokens']
+  const outputTokens = tags['ai.usage.outputTokens'] ?? tags['ai.usage.completionTokens']
 
   if (inputTokens != null) usage.inputTokens = inputTokens
   if (outputTokens != null) usage.outputTokens = outputTokens
 
-  const totalTokens = inputTokens + outputTokens
+  // v5 provides totalTokens directly, v4 requires computation
+  const totalTokens = tags['ai.usage.totalTokens'] ?? (inputTokens + outputTokens)
   if (!Number.isNaN(totalTokens)) usage.totalTokens = totalTokens
 
   return usage

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

@@ -28,7 +28,7 @@ class LLMObsPlugin extends TracingPlugin {
     const enabled = this._tracerConfig.llmobs.enabled
     if (!enabled) return
 
-    const parent = this.getLLMObsParent(ctx)
+    const parentStore = llmobsStorage.getStore()
     const apmStore = ctx.currentStore
     const span = apmStore?.span
 
@@ -40,10 +40,14 @@ class LLMObsPlugin extends TracingPlugin {
       telemetry.incrementLLMObsSpanStartCount({ autoinstrumented: true, integration: this.constructor.integration })
 
       ctx.llmobs = {} // initialize context-based namespace
-      llmobsStorage.enterWith({ span })
-      ctx.llmobs.parent = parent
-
-      this._tagger.registerLLMObsSpan(span, { parent, integration: this.constructor.integration, ...registerOptions })
+      llmobsStorage.enterWith({ ...parentStore, span })
+      ctx.llmobs.parent = parentStore
+
+      this._tagger.registerLLMObsSpan(span, {
+        parent: parentStore?.span,
+        integration: this.constructor.integration,
+        ...registerOptions
+      })
     }
   }
 
@@ -56,8 +60,8 @@ class LLMObsPlugin extends TracingPlugin {
     const span = apmStore?.span
     if (!LLMObsTagger.tagMap.has(span)) return
 
-    const parent = ctx.llmobs.parent
-    llmobsStorage.enterWith({ span: parent })
+    const parentStore = ctx.llmobs.parent
+    llmobsStorage.enterWith(parentStore)
   }
 
   asyncEnd (ctx) {
@@ -87,11 +91,6 @@ class LLMObsPlugin extends TracingPlugin {
     }
     super.configure(config)
   }
-
-  getLLMObsParent () {
-    const store = llmobsStorage.getStore()
-    return store?.span
-  }
 }
 
 module.exports = LLMObsPlugin

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

@@ -422,6 +422,22 @@ class LLMObs extends NoopLLMObs {
     }
   }
 
+  annotationContext (options, fn) {
+    if (!this.enabled) return fn()
+
+    const currentStore = storage.getStore()
+
+    const store = {
+      ...currentStore,
+      annotationContext: {
+        ...currentStore?.annotationContext,
+        ...options
+      }
+    }
+
+    return storage.run(store, fn)
+  }
+
   flush () {
     if (!this.enabled) return
 
@@ -447,20 +463,20 @@ class LLMObs extends NoopLLMObs {
   }
 
   _activate (span, options, fn) {
-    const parent = this._active()
-    if (this.enabled) storage.enterWith({ span })
+    const parentStore = storage.getStore()
+    if (this.enabled) storage.enterWith({ ...parentStore, span })
 
     if (options) {
       this._tagger.registerLLMObsSpan(span, {
         ...options,
-        parent
+        parent: parentStore?.span
       })
     }
 
     try {
       return fn()
     } finally {
-      if (this.enabled) storage.enterWith({ span: parent })
+      if (this.enabled) storage.enterWith(parentStore)
     }
   }
 

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

@@ -29,6 +29,7 @@ const {
   DECORATOR,
   PROPAGATED_ML_APP_KEY
 } = require('./constants/tags')
+const { storage } = require('./storage')
 
 // global registry of LLMObs spans
 // maps LLMObs spans to their annotations
@@ -97,6 +98,17 @@ class LLMObsTagger {
       span.context()._trace.tags[PROPAGATED_PARENT_ID_KEY] ??
       ROOT_PARENT_ID
     this._setTag(span, PARENT_ID_KEY, parentId)
+
+    // apply annotation context
+    const annotationContext = storage.getStore()?.annotationContext
+
+    // apply annotation context tags
+    const tags = annotationContext?.tags
+    if (tags) this.tagSpanTags(span, tags)
+
+    // apply annotation context name
+    const annotationContextName = annotationContext?.name
+    if (annotationContextName) this._setTag(span, NAME, annotationContextName)
   }
 
   // TODO: similarly for the following `tag` methods,

package/packages/dd-trace/src/opentelemetry/logs/otlp_http_log_exporter.js

@@ -1,18 +1,12 @@
 'use strict'
 
-const http = require('http')
-const { URL } = require('url')
-const log = require('../../log')
+const OtlpHttpExporterBase = require('../otlp/otlp_http_exporter_base')
 const OtlpTransformer = require('./otlp_transformer')
-const telemetryMetrics = require('../../telemetry/metrics')
 
 /**
  * @typedef {import('@opentelemetry/resources').Resource} Resource
  * @typedef {import('@opentelemetry/api-logs').LogRecord} LogRecord
- *
-*/
-
-const tracerMetrics = telemetryMetrics.manager.namespace('tracers')
+ */
 
 /**
  * OtlpHttpLogExporter exports log records via OTLP over HTTP.
@@ -21,12 +15,9 @@ const tracerMetrics = telemetryMetrics.manager.namespace('tracers')
  * https://opentelemetry.io/docs/specs/otlp/#otlphttp
  *
  * @class OtlpHttpLogExporter
+ * @extends OtlpHttpExporterBase
  */
-class OtlpHttpLogExporter {
-  #telemetryTags
-
-  DEFAULT_LOGS_PATH = '/v1/logs'
-
+class OtlpHttpLogExporter extends OtlpHttpExporterBase {
   /**
    * Creates a new OtlpHttpLogExporter instance.
    *
@@ -37,28 +28,8 @@ class OtlpHttpLogExporter {
    * @param {Resource} resource - Resource attributes
    */
   constructor (url, headers, timeout, protocol, resource) {
-    const parsedUrl = new URL(url)
-
-    this.protocol = protocol
+    super(url, headers, timeout, protocol, '/v1/logs', 'logs')
     this.transformer = new OtlpTransformer(resource, protocol)
-    // If no path is provided, use default path
-    const path = parsedUrl.pathname === '/' ? this.DEFAULT_LOGS_PATH : parsedUrl.pathname
-    const isJson = protocol === 'http/json'
-    this.options = {
-      hostname: parsedUrl.hostname,
-      port: parsedUrl.port,
-      path: path + parsedUrl.search,
-      method: 'POST',
-      timeout,
-      headers: {
-        'Content-Type': isJson ? 'application/json' : 'application/x-protobuf',
-        ...this.#parseAdditionalHeaders(headers)
-      }
-    }
-    this.#telemetryTags = [
-      'protocol:http',
-      `encoding:${isJson ? 'json' : 'protobuf'}`
-    ]
   }
 
   /**
@@ -74,99 +45,8 @@ class OtlpHttpLogExporter {
     }
 
     const payload = this.transformer.transformLogRecords(logRecords)
-    this.#sendPayload(payload, resultCallback)
-    tracerMetrics.count('otel.log_records', this.#telemetryTags).inc(logRecords.length)
-  }
-
-  /**
-   * Sends the payload via HTTP request.
-   * @param {Buffer|string} payload - The payload to send
-   * @param {Function} resultCallback - Callback for the result
-   * @private
-   */
-  #sendPayload (payload, resultCallback) {
-    const options = {
-      ...this.options,
-      headers: {
-        ...this.options.headers,
-        'Content-Length': payload.length
-      }
-    }
-
-    const req = http.request(options, (res) => {
-      let data = ''
-
-      res.on('data', (chunk) => {
-        data += chunk
-      })
-
-      res.on('end', () => {
-        if (res.statusCode >= 200 && res.statusCode < 300) {
-          resultCallback({ code: 0 })
-        } else {
-          const error = new Error(`HTTP ${res.statusCode}: ${data}`)
-          resultCallback({ code: 1, error })
-        }
-      })
-    })
-
-    req.on('error', (error) => {
-      log.error('Error sending OTLP logs:', error)
-      resultCallback({ code: 1, error })
-    })
-
-    req.on('timeout', () => {
-      req.destroy()
-      const error = new Error('Request timeout')
-      resultCallback({ code: 1, error })
-    })
-
-    req.write(payload)
-    req.end()
-  }
-
-  /**
-   * Parses additional HTTP headers from a comma-separated string.
-   * @param {string} headersString - Comma-separated key=value pairs
-   * @returns {Record<string, string>} Parsed headers object
-   * @private
-   */
-  #parseAdditionalHeaders (headersString) {
-    const headers = {}
-    let key = ''
-    let value = ''
-    let readingKey = true
-
-    for (const char of headersString) {
-      if (readingKey) {
-        if (char === '=') {
-          readingKey = false
-          key = key.trim()
-        } else {
-          key += char
-        }
-      } else if (char === ',') {
-        value = value.trim()
-        if (key && value) {
-          headers[key] = value
-        }
-        key = ''
-        value = ''
-        readingKey = true
-      } else {
-        value += char
-      }
-    }
-
-    // Add the last pair if present
-    if (!readingKey) {
-      value = value.trim()
-      if (value) {
-        headers[key] = value
-      }
-    }
-
-    return headers
+    this._sendPayload(payload, resultCallback)
+    this._recordTelemetry('otel.log_records', logRecords.length)
   }
 }
 

package/packages/dd-trace/src/opentelemetry/logs/otlp_transformer.js

@@ -1,14 +1,12 @@
 'use strict'
 
+const OtlpTransformerBase = require('../otlp/otlp_transformer_base')
 const { SeverityNumber } = require('@opentelemetry/api-logs')
-const { getProtobufTypes } = require('../protos/protobuf_loader')
+const { getProtobufTypes } = require('../otlp/protobuf_loader')
 const { trace } = require('@opentelemetry/api')
-const log = require('../../log')
 
 /**
- * @typedef {import('@opentelemetry/api').Attributes} Attributes
  * @typedef {import('@opentelemetry/api-logs').LogRecord} LogRecord
- * @typedef {import('@opentelemetry/resources').Resource} Resource
  */
 
 // Global severity mapping constant - no need to regenerate
@@ -46,24 +44,17 @@ const SEVERITY_MAP = {
  * https://opentelemetry.io/docs/specs/otlp/#log-data-model
  *
  * @class OtlpTransformer
+ * @extends OtlpTransformerBase
  */
-class OtlpTransformer {
-  #resourceAttributes
-
+class OtlpTransformer extends OtlpTransformerBase {
   /**
    * Creates a new OtlpTransformer instance.
    *
-   * @param {Attributes} resourceAttributes - Resource attributes
+   * @param {import('@opentelemetry/api').Attributes} resourceAttributes - Resource attributes
    * @param {string} protocol - OTLP protocol (http/protobuf or http/json)
    */
   constructor (resourceAttributes, protocol) {
-    this.#resourceAttributes = this.#transformAttributes(resourceAttributes)
-    if (protocol === 'grpc') {
-      log.warn('OTLP gRPC protocol is not supported for logs. ' +
-        'Defaulting to http/protobuf. gRPC protobuf support may be added in a future release.')
-      protocol = 'http/protobuf'
-    }
-    this.protocol = protocol
+    super(resourceAttributes, protocol, 'logs')
   }
 
   /**
@@ -72,37 +63,12 @@ class OtlpTransformer {
    * @returns {Buffer} Transformed log records in the appropriate format
    */
   transformLogRecords (logRecords) {
-    // Use the configured protocol to determine serialization format
     if (this.protocol === 'http/json') {
       return this.#transformToJson(logRecords)
     }
-    // Default to protobuf for http/protobuf or any other protocol
     return this.#transformToProtobuf(logRecords)
   }
 
-  /**
-   * Groups log records by instrumentation library (name and version).
-   * @param {LogRecord[]} logRecords - Array of log records to group
-   * @returns {Map<string, LogRecord[]>} Map of instrumentation library key to log records
-   * @private
-   */
-  #groupByInstrumentationScope (logRecords) {
-    const grouped = new Map()
-
-    for (const record of logRecords) {
-      const instrumentationScope = record.instrumentationScope || { name: '', version: '0.0.0', schemaUrl: '' }
-      const key = `${instrumentationScope.name}@${instrumentationScope.version}@${instrumentationScope.schemaUrl}`
-
-      const group = grouped.get(key)
-      if (group === undefined) {
-        grouped.set(key, [record])
-      } else {
-        group.push(record)
-      }
-    }
-    return grouped
-  }
-
   /**
    * Transforms log records to protobuf format.
    * @param {LogRecord[]} logRecords - Array of enriched log records to transform
@@ -111,19 +77,15 @@ class OtlpTransformer {
    */
   #transformToProtobuf (logRecords) {
     const { protoLogsService } = getProtobufTypes()
-    // Create the OTLP LogsData structure
+
     const logsData = {
       resourceLogs: [{
-        resource: this.#transformResource(),
+        resource: this._transformResource(),
         scopeLogs: this.#transformScope(logRecords),
       }]
     }
 
-    // Serialize to protobuf
-    const message = protoLogsService.create(logsData)
-    const buffer = protoLogsService.encode(message).finish()
-
-    return buffer
+    return this._serializeToProtobuf(protoLogsService, logsData)
   }
 
   /**
@@ -135,11 +97,11 @@ class OtlpTransformer {
   #transformToJson (logRecords) {
     const logsData = {
       resourceLogs: [{
-        resource: this.#transformResource(),
+        resource: this._transformResource(),
         scopeLogs: this.#transformScope(logRecords)
       }]
     }
-    return Buffer.from(JSON.stringify(logsData))
+    return this._serializeToJson(logsData)
   }
 
   /**
@@ -149,10 +111,7 @@ class OtlpTransformer {
    * @private
    */
   #transformScope (logRecords) {
-    // Group log records by instrumentation library
-    const groupedRecords = this.#groupByInstrumentationScope(logRecords)
-
-    // Create scope logs for each instrumentation library
+    const groupedRecords = this._groupByInstrumentationScope(logRecords)
     const scopeLogs = []
 
     for (const records of groupedRecords.values()) {
@@ -161,7 +120,6 @@ class OtlpTransformer {
         scope: {
           name: records[0]?.instrumentationScope?.name || 'dd-trace-js',
           version: records[0]?.instrumentationScope?.version || '',
-          // TODO: Support setting attributes on instrumentation scope
           attributes: [],
           droppedAttributesCount: 0
         },
@@ -173,18 +131,6 @@ class OtlpTransformer {
     return scopeLogs
   }
 
-  /**
-   * Transforms resource attributes to OTLP resource format.
-   * @returns {Resource} OTLP resource object
-   * @private
-   */
-  #transformResource () {
-    return {
-      attributes: this.#resourceAttributes,
-      droppedAttributesCount: 0
-    }
-  }
-
   /**
    * Transforms a single log record to OTLP format.
    * @param {LogRecord} logRecord - Log record to transform
@@ -192,14 +138,10 @@ class OtlpTransformer {
    * @private
    */
   #transformLogRecord (logRecord) {
-    const timestamp = logRecord.timestamp
-
-    // Extract span context from the log record's context
     const spanContext = this.#extractSpanContext(logRecord.context)
 
-    // Only timeUnixNano and body are required
     const result = {
-      timeUnixNano: timestamp,
+      timeUnixNano: logRecord.timestamp,
       body: this.#transformBody(logRecord.body)
     }
 
@@ -217,14 +159,14 @@ class OtlpTransformer {
     }
 
     if (logRecord.attributes) {
-      result.attributes = this.#transformAttributes(logRecord.attributes)
+      result.attributes = this._transformAttributes(logRecord.attributes)
     }
 
     if (spanContext?.traceFlags !== undefined) {
       result.flags = spanContext.traceFlags
     }
 
-    // Only include traceId and spanId if they are valid (not empty, undefined, or all zeros)
+    // Only include traceId and spanId if they are valid
     if (spanContext?.traceId && spanContext.traceId !== '00000000000000000000000000000000') {
       result.traceId = this.#hexToBytes(spanContext.traceId)
     }
@@ -285,82 +227,25 @@ class OtlpTransformer {
    */
   #transformBody (body) {
     if (typeof body === 'string') {
-      return {
-        stringValue: body
-      }
+      return { stringValue: body }
     } else if (typeof body === 'number') {
       if (Number.isInteger(body)) {
         return { intValue: body }
       }
       return { doubleValue: body }
     } else if (typeof body === 'boolean') {
-      return {
-        boolValue: body
-      }
+      return { boolValue: body }
     } else if (body && typeof body === 'object') {
       return {
         kvlistValue: {
           values: Object.entries(body).map(([key, value]) => ({
             key,
-            value: this.#transformAnyValue(value)
-          }))
-        }
-      }
-    }
-    return {
-      stringValue: String(body)
-    }
-  }
-
-  /**
-   * Transforms attributes to OTLP KeyValue format.
-   * @param {Object} attributes - Attributes to transform
-   * @returns {Object[]} Array of OTLP KeyValue objects
-   * @private
-   */
-  #transformAttributes (attributes) {
-    if (!attributes) {
-      return {}
-    }
-    return Object.entries(attributes).map(([key, value]) => ({
-      key,
-      value: this.#transformAnyValue(value)
-    }))
-  }
-
-  /**
-   * Transforms any value to OTLP AnyValue format.
-   * @param {any} value - Value to transform
-   * @returns {Object} OTLP AnyValue object
-   * @private
-   */
-  #transformAnyValue (value) {
-    if (typeof value === 'string') {
-      return { stringValue: value }
-    } else if (typeof value === 'number') {
-      if (Number.isInteger(value)) {
-        return { intValue: value }
-      }
-      return { doubleValue: value }
-    } else if (typeof value === 'boolean') {
-      return { boolValue: value }
-    } else if (Array.isArray(value)) {
-      return {
-        arrayValue: {
-          values: value.map(v => this.#transformAnyValue(v))
-        }
-      }
-    } else if (value && typeof value === 'object') {
-      return {
-        kvlistValue: {
-          values: Object.entries(value).map(([k, v]) => ({
-            key: k,
-            value: this.#transformAnyValue(v)
+            value: this._transformAnyValue(value)
           }))
         }
       }
     }
-    return { stringValue: String(value) }
+    return { stringValue: String(body) }
   }
 }