dd-trace 5.70.0 → 5.72.0

package/packages/dd-trace/src/openfeature/writers/util.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const logger = require('../../log')
+const { EVP_PROXY_AGENT_BASE_PATH } = require('../constants/constants')
+
+const AgentInfoExporter = require('../../exporters/common/agent-info-exporter')
+let agentInfoExporter
+
+/**
+ * Determines if the agent supports EVP proxy and sets the writer enabled state accordingly
+ * @param {import('../../config')} config - Tracer configuration object
+ * @param {Function} setWriterEnabledValue - Callback to set the writer enabled state
+ */
+function setAgentStrategy (config, setWriterEnabledValue) {
+  if (!agentInfoExporter) {
+    agentInfoExporter = new AgentInfoExporter(config)
+  }
+
+  agentInfoExporter.getAgentInfo((err, agentInfo) => {
+    if (err) {
+      logger.debug('FFE Writer disabled - error getting agent info:', err.message)
+      setWriterEnabledValue(false)
+      return
+    }
+
+    const endpoints = agentInfo.endpoints
+    const normalizedPath = EVP_PROXY_AGENT_BASE_PATH.replace(/\/+$/, '')
+    const hasEndpoint = Array.isArray(endpoints) &&
+      endpoints.includes(normalizedPath) || endpoints.includes(normalizedPath + '/')
+
+    if (hasEndpoint) {
+      logger.debug('FFE Writer enabled - agent has EVP proxy support')
+      setWriterEnabledValue(true)
+    } else {
+      logger.debug('FFE Writer disabled - agent does not have EVP proxy support')
+      setWriterEnabledValue(false)
+    }
+  })
+}
+
+module.exports = {
+  setAgentStrategy
+}

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

@@ -0,0 +1,100 @@
+'use strict'
+
+/**
+ * @typedef {import('@opentelemetry/api-logs').LogRecord} LogRecord
+ * @typedef {import('@opentelemetry/core').InstrumentationScope} InstrumentationScope
+ */
+
+/**
+ * BatchLogRecordProcessor processes log records in batches for efficient export to Datadog Agent.
+ *
+ * This implementation follows the OpenTelemetry JavaScript SDK BatchLogRecordProcessor:
+ * https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_sdk-logs.BatchLogRecordProcessor.html
+ *
+ * @class BatchLogRecordProcessor
+ */
+class BatchLogRecordProcessor {
+  #logRecords
+  #timer
+  #batchTimeout
+  #maxExportBatchSize
+
+  /**
+   * Creates a new BatchLogRecordProcessor instance.
+   *
+   * @param {OtlpHttpLogExporter} exporter - Log processor for exporting batches to Datadog Agent
+   * @param {number} batchTimeout - Timeout in milliseconds for batch processing
+   * @param {number} maxExportBatchSize - Maximum number of log records per batch
+   */
+  constructor (exporter, batchTimeout, maxExportBatchSize) {
+    this.exporter = exporter
+    this.#batchTimeout = batchTimeout
+    this.#maxExportBatchSize = maxExportBatchSize
+    this.#logRecords = []
+    this.#timer = null
+  }
+
+  /**
+   * Processes a single log record.
+   *
+   * @param {LogRecord} logRecord - The enriched log record with trace correlation and metadata
+   * @param {InstrumentationScope} instrumentationScope - The instrumentation library
+   */
+  onEmit (logRecord, instrumentationScope) {
+    // Store the log record (already enriched by Logger.emit)
+    this.#logRecords.push({ ...logRecord, instrumentationScope })
+
+    if (this.#logRecords.length >= this.#maxExportBatchSize) {
+      this.#export()
+    } else if (this.#logRecords.length === 1) {
+      this.#startTimer()
+    }
+  }
+
+  /**
+   * Forces an immediate flush of all pending log records.
+   * @returns {undefined} Promise that resolves when flush is complete
+   */
+  forceFlush () {
+    this.#export()
+  }
+
+  /**
+   * Starts the batch timeout timer.
+   * @private
+   */
+  #startTimer () {
+    if (this.#timer) {
+      return
+    }
+
+    this.#timer = setTimeout(() => {
+      this.#export()
+    }, this.#batchTimeout)
+  }
+
+  /**
+   * Exports the current batch of log records.
+   * @private
+   */
+  #export () {
+    const logRecords = this.#logRecords.slice(0, this.#maxExportBatchSize)
+    this.#logRecords = this.#logRecords.slice(this.#maxExportBatchSize)
+
+    this.#clearTimer()
+    this.exporter.export(logRecords, () => {})
+  }
+
+  /**
+   * Clears the batch timeout timer.
+   * @private
+   */
+  #clearTimer () {
+    if (this.#timer) {
+      clearTimeout(this.#timer)
+      this.#timer = null
+    }
+  }
+}
+
+module.exports = BatchLogRecordProcessor

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

@@ -0,0 +1,87 @@
+'use strict'
+
+const os = require('os')
+
+/**
+ * @typedef {import('../../config')} Config
+ */
+
+/**
+ * @fileoverview OpenTelemetry Logs Implementation for dd-trace-js
+ *
+ * This package provides a custom OpenTelemetry Logs implementation that integrates
+ * with the Datadog tracing library. It includes all necessary components for
+ * emitting, processing, and exporting log records via OTLP (OpenTelemetry Protocol).
+ *
+ * Key Components:
+ * - LoggerProvider: Main entry point for creating loggers
+ * - Logger: Provides methods to emit log records
+ * - BatchLogRecordProcessor: Processes log records in batches for efficient export
+ * - OtlpHttpLogExporter: Exports log records via OTLP over HTTP
+ * - OtlpTransformer: Transforms log records to OTLP format
+ *
+ * This is a custom implementation to avoid pulling in the full OpenTelemetry SDK,
+ * based on OTLP Protocol v1.7.0. It supports both protobuf and JSON serialization
+ * formats and integrates with Datadog's configuration system.
+ *
+ * @package
+ */
+
+const LoggerProvider = require('./logger_provider')
+const BatchLogRecordProcessor = require('./batch_log_processor')
+const OtlpHttpLogExporter = require('./otlp_http_log_exporter')
+
+/**
+ * Initializes OpenTelemetry Logs support
+ * @param {Config} config - Tracer configuration instance
+ */
+function initializeOpenTelemetryLogs (config) {
+  // Build resource attributes
+  const resourceAttributes = {
+    'service.name': config.service,
+    'service.version': config.version,
+    'deployment.environment': config.env
+  }
+
+  // Add all tracer tags (includes DD_TAGS, OTEL_RESOURCE_ATTRIBUTES, DD_TRACE_TAGS, etc.)
+  // Exclude Datadog-style keys that duplicate OpenTelemetry standard keys
+  if (config.tags) {
+    const filteredTags = { ...config.tags }
+    delete filteredTags.service
+    delete filteredTags.version
+    delete filteredTags.env
+    Object.assign(resourceAttributes, filteredTags)
+  }
+
+  // Add host.name if reportHostname is enabled
+  if (config.reportHostname) {
+    resourceAttributes['host.name'] = os.hostname()
+  }
+
+  // Create OTLP exporter using resolved config values
+  const exporter = new OtlpHttpLogExporter(
+    config.otelLogsUrl,
+    config.otelLogsHeaders,
+    config.otelLogsTimeout,
+    config.otelLogsProtocol,
+    resourceAttributes
+  )
+
+  // Create batch processor for exporting logs to Datadog Agent
+  const processor = new BatchLogRecordProcessor(
+    exporter,
+    config.otelLogsBatchTimeout,
+    config.otelLogsMaxExportBatchSize
+  )
+
+  // Create logger provider with processor for Datadog Agent export
+  const loggerProvider = new LoggerProvider({ processor })
+
+  // Register the logger provider globally with OpenTelemetry API
+  loggerProvider.register()
+}
+
+module.exports = {
+  LoggerProvider,
+  initializeOpenTelemetryLogs
+}

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

@@ -0,0 +1,77 @@
+'use strict'
+
+const { sanitizeAttributes } = require('@opentelemetry/core')
+const { context } = require('@opentelemetry/api')
+const packageVersion = require('../../../../../package.json').version
+/**
+ * @typedef {import('@opentelemetry/api-logs').LogRecord} LogRecord
+ * @typedef {import('@opentelemetry/api').SpanContext} SpanContext
+ * @typedef {import('@opentelemetry/api').Attributes} Attributes
+ * @typedef {import('@opentelemetry/resources').Resource} Resource
+ * @typedef {import('@opentelemetry/core').InstrumentationScope} InstrumentationScope
+ */
+
+/**
+ * Logger provides methods to emit log records.
+ *
+ * This implementation follows the OpenTelemetry JavaScript API Logger:
+ * https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api-logs.Logger.html
+ *
+ * @class Logger
+ */
+class Logger {
+  #instrumentationScope
+
+  /**
+   * Creates a new Logger instance.
+   *
+   * @param {LoggerProvider} loggerProvider - Parent logger provider
+   * @param {InstrumentationScope} [instrumentationScope] - Instrumentation scope information (newer API)
+   * @param {Object} [instrumentationLibrary] - Instrumentation library information (legacy API) [DEPRECATED in v1.3.0]
+   * @param {InstrumentationScope} [instrumentationScope.name] - Library name (defaults to 'dd-trace-js')
+   * @param {InstrumentationScope} [instrumentationScope.version] - Library version (defaults to tracer version)
+   * @param {string} [instrumentationLibrary.name] - Library name (legacy, defaults to 'dd-trace-js')
+   * @param {string} [instrumentationLibrary.version] - Library version (legacy, defaults to tracer version)
+   */
+  constructor (loggerProvider, instrumentationScope, instrumentationLibrary) {
+    this.loggerProvider = loggerProvider
+
+    // Support both newer instrumentationScope and legacy instrumentationLibrary
+    const scope = instrumentationScope || instrumentationLibrary
+    this.#instrumentationScope = {
+      name: scope?.name || 'dd-trace-js',
+      version: scope?.version || packageVersion,
+      schemaUrl: scope?.schemaUrl || '',
+    }
+  }
+
+  /**
+   * Emits a log record.
+   *
+   * @param {LogRecord} logRecord - The log record to emit
+   * @returns {void}
+   */
+  emit (logRecord) {
+    if (this.loggerProvider.isShutdown || !this.loggerProvider.processor) {
+      return
+    }
+
+    if (logRecord.attributes) {
+      logRecord.attributes = sanitizeAttributes(logRecord.attributes)
+    }
+
+    // Note: timestamp is in nanoseconds (as defined by OpenTelemetry LogRecord API)
+    if (!logRecord.timestamp) {
+      logRecord.timestamp = Number(process.hrtime.bigint())
+    }
+
+    if (!logRecord.context) {
+      // Store span context in the log record context for trace correlation
+      logRecord.context = context.active()
+    }
+
+    this.loggerProvider.processor.onEmit(logRecord, this.#instrumentationScope)
+  }
+}
+
+module.exports = Logger

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

@@ -0,0 +1,126 @@
+'use strict'
+const { logs } = require('@opentelemetry/api-logs')
+const { context } = require('@opentelemetry/api')
+const Logger = require('./logger')
+const log = require('../../log')
+const ContextManager = require('../context_manager')
+
+/**
+ * @typedef {import('@opentelemetry/api-logs').Logger} Logger
+ * @typedef {import('./batch_log_processor')} BatchLogRecordProcessor
+ */
+
+/**
+ * LoggerProvider is the main entry point for creating loggers with a single processor for Datadog Agent export.
+ *
+ * This implementation follows the OpenTelemetry JavaScript API LoggerProvider interface:
+ * https://github.com/open-telemetry/opentelemetry-js/blob/a7a36499f70f25201949aeabb84c5fd4ca80e860/experimental/packages/api-logs/src/types/LoggerProvider.ts
+ *
+ * @class LoggerProvider
+ * @implements {import('@opentelemetry/api-logs').LoggerProvider}
+ */
+class LoggerProvider {
+  #loggers
+  #contextManager
+
+  /**
+   * Creates a new LoggerProvider instance with a single processor for Datadog Agent export.
+   *
+   * @param {Object} [options] - LoggerProvider options
+   * @param {BatchLogRecordProcessor} [options.processor] - Single LogRecordProcessor instance for
+   *   exporting logs to Datadog Agent
+   */
+  constructor (options = {}) {
+    this.processor = options.processor
+    this.#loggers = new Map()
+    this.#contextManager = new ContextManager()
+    this.isShutdown = false
+  }
+
+  /**
+   * Gets or creates a logger instance.
+   *
+   * @param {string|Object} nameOrOptions - Logger name or options object
+   * @param {string} [version] - Logger version (when nameOrOptions is a string)
+   * @param {Object} [options] - Additional options (when nameOrOptions is a string)
+   * @returns {Logger} Logger instance
+   */
+  getLogger (nameOrOptions, version, options = {}) {
+    if (this.isShutdown) {
+      return this.#createNoOpLogger()
+    }
+
+    let name, loggerOptions
+    if (typeof nameOrOptions === 'string') {
+      name = nameOrOptions
+      loggerOptions = { version, ...options }
+    } else {
+      name = nameOrOptions.name
+      loggerOptions = nameOrOptions
+    }
+
+    const loggerVersion = loggerOptions.version || ''
+    const loggerSchemaUrl = loggerOptions?.schemaUrl || ''
+    const key = `${name}@${loggerVersion}`
+
+    if (!this.#loggers.has(key)) {
+      this.#loggers.set(key, new Logger(this, { name, version: loggerVersion, schemaUrl: loggerSchemaUrl }))
+    }
+    return this.#loggers.get(key)
+  }
+
+  /**
+   * Registers this logger provider as the global provider.
+   */
+  register () {
+    if (this.isShutdown) {
+      log.warn('Cannot register after shutdown')
+      return
+    }
+    // Set context manager, this is required to correlate logs to spans
+    context.setGlobalContextManager(this.#contextManager)
+    logs.setGlobalLoggerProvider(this)
+  }
+
+  /**
+   * Forces a flush of all pending log records.
+   * @returns {undefined} Promise that resolves when flush is n ssue cncomplete
+   */
+  forceFlush () {
+    if (!this.isShutdown) {
+      return this.processor?.forceFlush()
+    }
+  }
+
+  /**
+   * Shuts down the logger provider and all associated processors.
+   * @returns {undefined} Promise that resolves when shutdown is complete
+   */
+  shutdown () {
+    if (!this.isShutdown) {
+      this.isShutdown = true
+    }
+  }
+
+  /**
+   * Creates a no-op logger for use when the provider is shutdown.
+   * @returns {Logger} A no-op logger instance
+   * @private
+   */
+  #createNoOpLogger () {
+    return {
+      instrumentationScope: {
+        name: 'dd-trace-js',
+        version: ''
+      },
+      emit: () => {},
+      debug: () => {},
+      info: () => {},
+      warn: () => {},
+      error: () => {},
+      fatal: () => {}
+    }
+  }
+}
+
+module.exports = LoggerProvider

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

@@ -0,0 +1,173 @@
+'use strict'
+
+const http = require('http')
+const { URL } = require('url')
+const log = require('../../log')
+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.
+ *
+ * This implementation follows the OTLP HTTP specification:
+ * https://opentelemetry.io/docs/specs/otlp/#otlphttp
+ *
+ * @class OtlpHttpLogExporter
+ */
+class OtlpHttpLogExporter {
+  #telemetryTags
+
+  DEFAULT_LOGS_PATH = '/v1/logs'
+
+  /**
+   * Creates a new OtlpHttpLogExporter instance.
+   *
+   * @param {string} url - OTLP endpoint URL
+   * @param {string} headers - Additional HTTP headers as comma-separated key=value string
+   * @param {number} timeout - Request timeout in milliseconds
+   * @param {string} protocol - OTLP protocol (http/protobuf or http/json)
+   * @param {Resource} resource - Resource attributes
+   */
+  constructor (url, headers, timeout, protocol, resource) {
+    const parsedUrl = new URL(url)
+
+    this.protocol = protocol
+    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'}`
+    ]
+  }
+
+  /**
+   * Exports log records via OTLP over HTTP.
+   *
+   * @param {LogRecord[]} logRecords - Array of enriched log records to export
+   * @param {Function} resultCallback - Callback function for export result
+   */
+  export (logRecords, resultCallback) {
+    if (logRecords.length === 0) {
+      resultCallback({ code: 0 })
+      return
+    }
+
+    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
+  }
+}
+
+module.exports = OtlpHttpLogExporter