[Azure Monitor OpenTelemetry] Add OTLP Exporters (Azure#26460)

Packages updated by this PR: @azure/monitor-opentelemetry

Add support for OTLP HTTP exporters

Author: hectorhdzg

.vscode/cspell.json

@@ -77,6 +77,7 @@
     "Idrg",
     "IDRG",
     "IMDS",
+    "OTLP",
     "Kubernetes",
     "kusto",
     "lcov",

common/config/rush/pnpm-lock.yaml

@@ -108,13 +108,13 @@
     "@azure/core-auth": "^1.3.0",
     "@azure/core-rest-pipeline": "^1.1.0",
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/api-logs": "^0.40.0",
-    "@opentelemetry/core": "^1.14.0",
-    "@opentelemetry/resources": "^1.14.0",
-    "@opentelemetry/sdk-metrics": "^1.14.0",
-    "@opentelemetry/sdk-trace-base": "^1.14.0",
-    "@opentelemetry/semantic-conventions": "^1.14.0",
-    "@opentelemetry/sdk-logs": "^0.40.0",
+    "@opentelemetry/api-logs": "^0.41.0",
+    "@opentelemetry/core": "^1.15.0",
+    "@opentelemetry/resources": "^1.15.0",
+    "@opentelemetry/sdk-metrics": "^1.15.0",
+    "@opentelemetry/sdk-trace-base": "^1.15.0",
+    "@opentelemetry/semantic-conventions": "^1.15.0",
+    "@opentelemetry/sdk-logs": "^0.41.0",
     "tslib": "^2.2.0"
   },
   "sideEffects": false,

sdk/monitor/monitor-opentelemetry-exporter/package.json

@@ -90,21 +90,25 @@
     "@azure/monitor-opentelemetry-exporter": "1.0.0-beta.14",
     "@azure/opentelemetry-instrumentation-azure-sdk": "^1.0.0-beta.3",
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/api-logs": "^0.40.0",
-    "@opentelemetry/core": "^1.14.0",
-    "@opentelemetry/instrumentation": "^0.40.0",
-    "@opentelemetry/instrumentation-http": "^0.40.0",
-    "@opentelemetry/instrumentation-mongodb": "^0.34.3",
+    "@opentelemetry/api-logs": "^0.41.0",
+    "@opentelemetry/core": "^1.15.0",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.41.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.41.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.41.0",
+    "@opentelemetry/instrumentation": "^0.41.0",
+    "@opentelemetry/instrumentation-http": "^0.41.0",
+    "@opentelemetry/instrumentation-mongodb": "^0.35.0",
     "@opentelemetry/instrumentation-mysql": "^0.33.3",
     "@opentelemetry/instrumentation-pg": "^0.35.3",
     "@opentelemetry/instrumentation-redis": "^0.34.7",
     "@opentelemetry/instrumentation-redis-4": "^0.34.6",
-    "@opentelemetry/resources": "^1.14.0",
-    "@opentelemetry/sdk-logs": "^0.40.0",
-    "@opentelemetry/sdk-metrics": "^1.14.0",
-    "@opentelemetry/sdk-trace-base": "^1.14.0",
-    "@opentelemetry/sdk-trace-node": "^1.14.0",
-    "@opentelemetry/semantic-conventions": "^1.14.0",
+    "@opentelemetry/otlp-exporter-base": "^0.41.0",
+    "@opentelemetry/resources": "^1.15.0",
+    "@opentelemetry/sdk-logs": "^0.41.0",
+    "@opentelemetry/sdk-metrics": "^1.15.0",
+    "@opentelemetry/sdk-trace-base": "^1.15.0",
+    "@opentelemetry/sdk-trace-node": "^1.15.0",
+    "@opentelemetry/semantic-conventions": "^1.15.0",
     "tslib": "^2.2.0"
   },
   "sideEffects": false,

sdk/monitor/monitor-opentelemetry/package.json

@@ -10,6 +10,7 @@ import { Logger } from '@opentelemetry/sdk-logs';
 import { LoggerProvider } from '@opentelemetry/sdk-logs';
 import { Meter } from '@opentelemetry/api';
 import { MeterProvider } from '@opentelemetry/sdk-metrics';
+import { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
 import { Resource } from '@opentelemetry/resources';
 import { Tracer } from '@opentelemetry/sdk-trace-base';
 import { TracerProvider } from '@opentelemetry/api';
@@ -33,6 +34,9 @@ export interface AzureMonitorOpenTelemetryOptions {
     enableAutoCollectPerformance?: boolean;
     enableAutoCollectStandardMetrics?: boolean;
     instrumentationOptions?: InstrumentationOptions;
+    otlpLogExporterConfig?: OTLPExporterConfig;
+    otlpMetricExporterConfig?: OTLPExporterConfig;
+    otlpTraceExporterConfig?: OTLPExporterConfig;
     resource?: Resource;
     samplingRatio?: number;
 }
@@ -48,6 +52,11 @@ export interface InstrumentationOptions {
     redis4?: InstrumentationConfig;
 }
 
+// @public
+export interface OTLPExporterConfig extends OTLPExporterNodeConfigBase {
+    enabled?: boolean;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

sdk/monitor/monitor-opentelemetry/review/monitor-opentelemetry.api.md

@@ -2,4 +2,8 @@
 // Licensed under the MIT license.
 
 export { AzureMonitorOpenTelemetryClient } from "./client";
-export { AzureMonitorOpenTelemetryOptions, InstrumentationOptions } from "./shared/types";
+export {
+  AzureMonitorOpenTelemetryOptions,
+  InstrumentationOptions,
+  OTLPExporterConfig,
+} from "./shared/types";

sdk/monitor/monitor-opentelemetry/src/index.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 import { AzureMonitorLogExporter } from "@azure/monitor-opentelemetry-exporter";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
 import {
   LoggerProvider,
   BatchLogRecordProcessor,
@@ -19,6 +20,7 @@ export class LogHandler {
   private _loggerProvider: LoggerProvider;
   private _logger: OtelLogger;
   private _azureExporter: AzureMonitorLogExporter;
+  private _otlpExporter?: OTLPLogExporter;
   private _logRecordProcessor: BatchLogRecordProcessor;
   private _config: AzureMonitorOpenTelemetryConfig;
   private _metricHandler?: MetricHandler;
@@ -43,6 +45,13 @@ export class LogHandler {
     this._loggerProvider.addLogRecordProcessor(this._logRecordProcessor);
     this._azureLogProccessor = new AzureLogRecordProcessor(this._metricHandler);
     this._loggerProvider.addLogRecordProcessor(this._azureLogProccessor);
+
+    if (config.otlpLogExporterConfig?.enabled) {
+      this._otlpExporter = new OTLPLogExporter(config.otlpLogExporterConfig);
+      const otlpLogProcessor = new BatchLogRecordProcessor(this._otlpExporter);
+      this._loggerProvider.addLogRecordProcessor(otlpLogProcessor);
+    }
+
     this._logger = this._loggerProvider.getLogger("AzureMonitorLogger", undefined) as OtelLogger;
   }
 

sdk/monitor/monitor-opentelemetry/src/logs/handler.ts

@@ -3,6 +3,7 @@
 
 import { AzureMonitorMetricExporter } from "@azure/monitor-opentelemetry-exporter";
 import { Meter } from "@opentelemetry/api";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
 import {
   MeterProvider,
   MeterProviderOptions,
@@ -22,6 +23,7 @@ export class MetricHandler {
   private _collectionInterval = 60000; // 60 seconds
   private _meterProvider: MeterProvider;
   private _azureExporter: AzureMonitorMetricExporter;
+  private _otlpExporter?: OTLPMetricExporter;
   private _metricReader: PeriodicExportingMetricReader;
   private _meter: Meter;
   private _perfCounterMetrics?: PerformanceCounterMetrics;
@@ -46,12 +48,30 @@ export class MetricHandler {
     };
     this._meterProvider = new MeterProvider(meterProviderConfig);
     this._azureExporter = new AzureMonitorMetricExporter(this._config.azureMonitorExporterConfig);
-    const metricReaderOptions: PeriodicExportingMetricReaderOptions = {
+    let metricReaderOptions: PeriodicExportingMetricReaderOptions = {
       exporter: this._azureExporter as any,
       exportIntervalMillis: options?.collectionInterval || this._collectionInterval,
     };
     this._metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
     this._meterProvider.addMetricReader(this._metricReader);
+
+    const metricExporter = new OTLPMetricExporter({});
+    metricReaderOptions = {
+      exporter: metricExporter,
+      exportIntervalMillis: options?.collectionInterval || this._collectionInterval,
+    };
+    this._metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
+    this._meterProvider.addMetricReader(this._metricReader);
+
+    if (config.otlpMetricExporterConfig?.enabled) {
+      this._otlpExporter = new OTLPMetricExporter(config.otlpMetricExporterConfig);
+      const otlpMetricReader = new PeriodicExportingMetricReader({
+        exporter: this._otlpExporter,
+        exportIntervalMillis: options?.collectionInterval || this._collectionInterval,
+      });
+      this._meterProvider.addMetricReader(otlpMetricReader);
+    }
+
     this._meter = this._meterProvider.getMeter("AzureMonitorMeter");
   }
 

sdk/monitor/monitor-opentelemetry/src/metrics/handler.ts

@@ -7,7 +7,11 @@ import {
   detectResourcesSync,
   envDetectorSync,
 } from "@opentelemetry/resources";
-import { AzureMonitorOpenTelemetryOptions, InstrumentationOptions } from "./types";
+import {
+  AzureMonitorOpenTelemetryOptions,
+  InstrumentationOptions,
+  OTLPExporterConfig,
+} from "./types";
 import { AzureMonitorExporterOptions } from "@azure/monitor-opentelemetry-exporter";
 import { JsonConfig } from "./jsonConfig";
 import { Logger } from "./logging";
@@ -20,6 +24,12 @@ export class AzureMonitorOpenTelemetryConfig implements AzureMonitorOpenTelemetr
   public samplingRatio: number;
   /** Azure Monitor Exporter Configuration */
   public azureMonitorExporterConfig: AzureMonitorExporterOptions;
+  /** OTLP Trace Exporter Configuration */
+  public otlpTraceExporterConfig: OTLPExporterConfig;
+  /** OTLP Metric Exporter Configuration */
+  public otlpMetricExporterConfig: OTLPExporterConfig;
+  /** OTLP Log Exporter Configuration */
+  public otlpLogExporterConfig: OTLPExporterConfig;
   /**
    * Sets the state of performance tracking (enabled by default)
    * if true performance counters will be collected every second and sent to Azure Monitor
@@ -54,6 +64,9 @@ export class AzureMonitorOpenTelemetryConfig implements AzureMonitorOpenTelemetr
   constructor(options?: AzureMonitorOpenTelemetryOptions) {
     // Default values
     this.azureMonitorExporterConfig = {};
+    this.otlpLogExporterConfig = {};
+    this.otlpMetricExporterConfig = {};
+    this.otlpTraceExporterConfig = {};
     this.enableAutoCollectPerformance = true;
     this.enableAutoCollectStandardMetrics = true;
     this.samplingRatio = 1;
@@ -77,6 +90,18 @@ export class AzureMonitorOpenTelemetryConfig implements AzureMonitorOpenTelemetr
         this.azureMonitorExporterConfig,
         options.azureMonitorExporterConfig
       );
+      this.otlpTraceExporterConfig = Object.assign(
+        this.otlpTraceExporterConfig,
+        options.otlpTraceExporterConfig
+      );
+      this.otlpMetricExporterConfig = Object.assign(
+        this.otlpMetricExporterConfig,
+        options.otlpMetricExporterConfig
+      );
+      this.otlpLogExporterConfig = Object.assign(
+        this.otlpLogExporterConfig,
+        options.otlpLogExporterConfig
+      );
       this.instrumentationOptions = Object.assign(
         this.instrumentationOptions,
         options.instrumentationOptions
@@ -109,6 +134,18 @@ export class AzureMonitorOpenTelemetryConfig implements AzureMonitorOpenTelemetr
         this.azureMonitorExporterConfig,
         jsonConfig.azureMonitorExporterConfig
       );
+      this.otlpTraceExporterConfig = Object.assign(
+        this.otlpTraceExporterConfig,
+        jsonConfig.otlpTraceExporterConfig
+      );
+      this.otlpMetricExporterConfig = Object.assign(
+        this.otlpMetricExporterConfig,
+        jsonConfig.otlpMetricExporterConfig
+      );
+      this.otlpLogExporterConfig = Object.assign(
+        this.otlpLogExporterConfig,
+        jsonConfig.otlpLogExporterConfig
+      );
       this.instrumentationOptions = Object.assign(
         this.instrumentationOptions,
         jsonConfig.instrumentationOptions

sdk/monitor/monitor-opentelemetry/src/shared/config.ts

@@ -3,7 +3,11 @@
 
 import * as fs from "fs";
 import * as path from "path";
-import { AzureMonitorOpenTelemetryOptions, InstrumentationOptions } from "./types";
+import {
+  AzureMonitorOpenTelemetryOptions,
+  InstrumentationOptions,
+  OTLPExporterConfig,
+} from "./types";
 import { AzureMonitorExporterOptions } from "@azure/monitor-opentelemetry-exporter";
 import { Logger } from "./logging";
 
@@ -19,6 +23,12 @@ export class JsonConfig implements AzureMonitorOpenTelemetryOptions {
   public samplingRatio?: number;
   /** Azure Monitor Exporter Configuration */
   public azureMonitorExporterConfig?: AzureMonitorExporterOptions;
+  /** OTLP Trace Exporter Configuration */
+  public otlpTraceExporterConfig?: OTLPExporterConfig;
+  /** OTLP Metric Exporter Configuration */
+  public otlpMetricExporterConfig?: OTLPExporterConfig;
+  /** OTLP Log Exporter Configuration */
+  public otlpLogExporterConfig?: OTLPExporterConfig;
   /**
    * Sets the state of performance tracking (enabled by default)
    * if true performance counters will be collected every second and sent to Azure Monitor
@@ -80,6 +90,9 @@ export class JsonConfig implements AzureMonitorOpenTelemetryOptions {
     try {
       const jsonConfig: AzureMonitorOpenTelemetryOptions = JSON.parse(jsonString);
       this.azureMonitorExporterConfig = jsonConfig.azureMonitorExporterConfig;
+      this.otlpLogExporterConfig = jsonConfig.otlpLogExporterConfig;
+      this.otlpMetricExporterConfig = jsonConfig.otlpMetricExporterConfig;
+      this.otlpTraceExporterConfig = jsonConfig.otlpTraceExporterConfig;
       this.samplingRatio = jsonConfig.samplingRatio;
       this.enableAutoCollectPerformance = jsonConfig.enableAutoCollectPerformance;
       this.enableAutoCollectStandardMetrics = jsonConfig.enableAutoCollectStandardMetrics;