Add support for OpenTelemetry Logs API #6465
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
mabdinur marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * | ||
| * @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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| 'use strict' | ||
|
|
||
| /** | ||
| * @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 Logger = require('./logger') | ||
| const BatchLogRecordProcessor = require('./batch_log_processor') | ||
| const OtlpHttpLogExporter = require('./otlp_http_log_exporter') | ||
| const OtlpTransformer = require('./otlp_transformer') | ||
|
|
||
| module.exports = { | ||
| LoggerProvider, | ||
| Logger, | ||
| BatchLogRecordProcessor, | ||
| OtlpHttpLogExporter, | ||
| OtlpTransformer | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -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) | ||||||||
| } | ||||||||
mabdinur marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
|
|
||||||||
| // Note: timestamp is in nanoseconds (as defined by OpenTelemetry LogRecord API) | ||||||||
| if (!logRecord.timestamp) { | ||||||||
| logRecord.timestamp = Number(process.hrtime.bigint()) | ||||||||
|
There was a problem hiding this comment.
Suggested change
Is it possible to rename the property to include that information? There was a problem hiding this comment. This type is defined by otel. We can't modify it here: https://github.com/open-telemetry/opentelemetry-js/blob/bfede5741ce2744b2653cdbff633a6dec03f22f7/experimental/packages/api-logs/src/types/LogRecord.ts#L60 There was a problem hiding this comment. Makes sense. I thought it might just be good to add the comment for clarity :) |
||||||||
| } | ||||||||
|
|
||||||||
| 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 | ||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.