feat(configuration): set logger provider exporter type from env variable (#6104)

Author: maryliag

experimental/CHANGELOG.md

@@ -11,7 +11,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
 ### :rocket: Features
 
 * feat(exporter-prometheus): support withoutScopeInfo option [#5993](https://github.com/open-telemetry/opentelemetry-js/pull/5993) @cjihrig
-* feat(configuration): improvements on package [#6101](https://github.com/open-telemetry/opentelemetry-js/pull/6101) @maryliag
+* refactor(configuration): improvements on package [#6101](https://github.com/open-telemetry/opentelemetry-js/pull/6101) @maryliag
+* feat(configuration): set logger provider exporter type from env variable [#6104](https://github.com/open-telemetry/opentelemetry-js/pull/6104) @maryliag
 
 ### :bug: Bug Fixes
 

experimental/packages/configuration/src/EnvironmentConfigFactory.ts

@@ -31,6 +31,8 @@ import {
   ExporterDefaultHistogramAggregation,
   ExporterTemporalityPreference,
 } from './models/meterProviderModel';
+import { OtlpHttpEncoding } from './models/commonModel';
+import { diag } from '@opentelemetry/api';
 
 /**
  * EnvironmentConfigProvider provides a configuration based on environment variables.
@@ -456,57 +458,123 @@ export function setLoggerProvider(config: ConfigurationModel): void {
       batch.max_export_batch_size = maxExportBatchSize;
     }
 
-    const endpoint =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_ENDPOINT') ??
-      (getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT')
-        ? `${getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT')}/v1/logs`
-        : null);
-    if (endpoint && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.endpoint = endpoint;
-    }
-
-    const certificateFile =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE') ??
-      getStringFromEnv('OTEL_EXPORTER_OTLP_CERTIFICATE');
-    if (certificateFile && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.certificate_file = certificateFile;
-    }
-
-    const clientKeyFile =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY') ??
-      getStringFromEnv('OTEL_EXPORTER_OTLP_CLIENT_KEY');
-    if (clientKeyFile && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.client_key_file = clientKeyFile;
-    }
-
-    const clientCertificateFile =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE') ??
-      getStringFromEnv('OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE');
-    if (clientCertificateFile && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.client_certificate_file = clientCertificateFile;
-    }
-
-    const compression =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_COMPRESSION') ??
-      getStringFromEnv('OTEL_EXPORTER_OTLP_COMPRESSION');
-    if (compression && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.compression = compression;
-    }
-
-    const timeout =
-      getNumberFromEnv('OTEL_EXPORTER_OTLP_LOGS_TIMEOUT') ??
-      getNumberFromEnv('OTEL_EXPORTER_OTLP_TIMEOUT');
-    if (timeout && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.timeout = timeout;
-    }
-
-    const headersList =
-      getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_HEADERS') ??
-      getStringFromEnv('OTEL_EXPORTER_OTLP_HEADERS');
-    if (headersList && batch.exporter.otlp_http) {
-      batch.exporter.otlp_http.headers_list = headersList;
+    const exportersType = Array.from(
+      new Set(getStringListFromEnv('OTEL_LOGS_EXPORTER'))
+    );
+    if (exportersType.length === 0) {
+      exportersType.push('otlp');
+    }
+
+    config.logger_provider.processors = [];
+    if (exportersType.includes('none')) {
+      diag.info(
+        `OTEL_LOGS_EXPORTER contains "none". Logger provider will not be initialized.`
+      );
+      return;
+    }
+
+    for (let i = 0; i < exportersType.length; i++) {
+      const exporterType = exportersType[i];
+      const batchInfo = { ...batch };
+      if (exporterType === 'console') {
+        config.logger_provider.processors.push({
+          simple: { exporter: { console: {} } },
+        });
+      } else {
+        // 'otlp' and default
+        const protocol =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_PROTOCOL') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_PROTOCOL') ??
+          'http/protobuf';
+        const certificateFile =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_CERTIFICATE');
+        const clientKeyFile =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_CLIENT_KEY');
+        const clientCertificateFile =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE');
+        const compression =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_COMPRESSION') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_COMPRESSION');
+        const timeout =
+          getNumberFromEnv('OTEL_EXPORTER_OTLP_LOGS_TIMEOUT') ??
+          getNumberFromEnv('OTEL_EXPORTER_OTLP_TIMEOUT') ??
+          10000;
+        const headersList =
+          getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_HEADERS') ??
+          getStringFromEnv('OTEL_EXPORTER_OTLP_HEADERS');
+
+        if (protocol === 'grpc') {
+          delete batchInfo.exporter.otlp_http;
+          batchInfo.exporter.otlp_grpc = {};
+          const endpoint =
+            getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_ENDPOINT') ??
+            getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT') ??
+            'http://localhost:4317';
+          if (endpoint) {
+            batchInfo.exporter.otlp_grpc.endpoint = endpoint;
+          }
+          if (certificateFile) {
+            batchInfo.exporter.otlp_grpc.certificate_file = certificateFile;
+          }
+          if (clientKeyFile) {
+            batchInfo.exporter.otlp_grpc.client_key_file = clientKeyFile;
+          }
+          if (clientCertificateFile) {
+            batchInfo.exporter.otlp_grpc.client_certificate_file =
+              clientCertificateFile;
+          }
+          if (compression) {
+            batchInfo.exporter.otlp_grpc.compression = compression;
+          }
+          if (timeout) {
+            batchInfo.exporter.otlp_grpc.timeout = timeout;
+          }
+          if (headersList) {
+            batchInfo.exporter.otlp_grpc.headers_list = headersList;
+          }
+        } else {
+          if (batchInfo.exporter.otlp_http == null) {
+            batchInfo.exporter.otlp_http = {};
+          }
+          const endpoint =
+            getStringFromEnv('OTEL_EXPORTER_OTLP_LOGS_ENDPOINT') ??
+            (getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT')
+              ? `${getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT')}/v1/logs`
+              : null);
+          if (endpoint) {
+            batchInfo.exporter.otlp_http.endpoint = endpoint;
+          }
+          if (certificateFile) {
+            batchInfo.exporter.otlp_http.certificate_file = certificateFile;
+          }
+          if (clientKeyFile) {
+            batchInfo.exporter.otlp_http.client_key_file = clientKeyFile;
+          }
+          if (clientCertificateFile) {
+            batchInfo.exporter.otlp_http.client_certificate_file =
+              clientCertificateFile;
+          }
+          if (compression) {
+            batchInfo.exporter.otlp_http.compression = compression;
+          }
+          if (timeout) {
+            batchInfo.exporter.otlp_http.timeout = timeout;
+          }
+          if (headersList) {
+            batchInfo.exporter.otlp_http.headers_list = headersList;
+          }
+
+          if (protocol === 'http/json') {
+            batchInfo.exporter.otlp_http.encoding = OtlpHttpEncoding.JSON;
+          } else if (protocol === 'http/protobuf') {
+            batchInfo.exporter.otlp_http.encoding = OtlpHttpEncoding.Protobuf;
+          }
+        }
+        config.logger_provider.processors.push({ batch: batchInfo });
+      }
     }
-
-    config.logger_provider.processors[0].batch = batch;
   }
 }

experimental/packages/configuration/src/index.ts

@@ -16,4 +16,5 @@
 
 export type { ConfigFactory } from './IConfigFactory';
 export type { ConfigurationModel } from './models/configModel';
+export type { LogRecordExporter as LogRecordExporterModel } from './models/loggerProviderModel';
 export { createConfigFactory } from './ConfigFactory';

experimental/packages/configuration/test/ConfigProvider.test.ts renamed to experimental/packages/configuration/test/ConfigFactory.test.ts

@@ -1030,6 +1030,158 @@ describe('ConfigProvider', function () {
       assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
     });
 
+    it('should return config with logger_provider with console exporter', function () {
+      process.env.OTEL_LOGS_EXPORTER = 'console';
+      const expectedConfig: ConfigurationModel = {
+        ...defaultConfig,
+        logger_provider: {
+          limits: {
+            attribute_count_limit: 128,
+          },
+          processors: [
+            {
+              simple: {
+                exporter: {
+                  console: {},
+                },
+              },
+            },
+          ],
+        },
+      };
+      const configProvider = createConfigFactory();
+      assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
+    });
+
+    it('should return config with logger_provider with no exporter', function () {
+      process.env.OTEL_LOGS_EXPORTER = 'none,console';
+      const expectedConfig: ConfigurationModel = {
+        ...defaultConfig,
+        logger_provider: {
+          limits: {
+            attribute_count_limit: 128,
+          },
+          processors: [],
+        },
+      };
+      const configProvider = createConfigFactory();
+      assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
+    });
+
+    it('should return config with logger_provider with exporter list', function () {
+      process.env.OTEL_LOGS_EXPORTER = 'otlp,console';
+      const expectedConfig: ConfigurationModel = {
+        ...defaultConfig,
+        logger_provider: {
+          limits: {
+            attribute_count_limit: 128,
+          },
+          processors: [
+            {
+              batch: {
+                schedule_delay: 1000,
+                export_timeout: 30000,
+                max_queue_size: 2048,
+                max_export_batch_size: 512,
+                exporter: {
+                  otlp_http: {
+                    endpoint: 'http://localhost:4318/v1/logs',
+                    timeout: 10000,
+                    encoding: OtlpHttpEncoding.Protobuf,
+                  },
+                },
+              },
+            },
+            {
+              simple: {
+                exporter: {
+                  console: {},
+                },
+              },
+            },
+          ],
+        },
+      };
+      const configProvider = createConfigFactory();
+      assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
+    });
+
+    it('should return config with logger_provider with otlp grpc exporter', function () {
+      process.env.OTEL_LOGS_EXPORTER = 'otlp';
+      process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'grpc';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = 'http://localhost:4317';
+      process.env.OTEL_EXPORTER_OTLP_TIMEOUT = '10000';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE = 'log-cert.pem';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY = 'log-key.pem';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE =
+        'log-client-cert.pem';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS = 'host=localhost';
+      process.env.OTEL_EXPORTER_OTLP_LOGS_COMPRESSION = 'gzip';
+      const expectedConfig: ConfigurationModel = {
+        ...defaultConfig,
+        logger_provider: {
+          limits: {
+            attribute_count_limit: 128,
+          },
+          processors: [
+            {
+              batch: {
+                schedule_delay: 1000,
+                export_timeout: 30000,
+                max_queue_size: 2048,
+                max_export_batch_size: 512,
+                exporter: {
+                  otlp_grpc: {
+                    endpoint: 'http://localhost:4317',
+                    timeout: 10000,
+                    certificate_file: 'log-cert.pem',
+                    client_key_file: 'log-key.pem',
+                    client_certificate_file: 'log-client-cert.pem',
+                    headers_list: 'host=localhost',
+                    compression: 'gzip',
+                  },
+                },
+              },
+            },
+          ],
+        },
+      };
+      const configProvider = createConfigFactory();
+      assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
+    });
+
+    it('should return config with logger_provider with otlp http/json exporter', function () {
+      process.env.OTEL_LOGS_EXPORTER = 'otlp';
+      process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'http/json';
+      const expectedConfig: ConfigurationModel = {
+        ...defaultConfig,
+        logger_provider: {
+          limits: {
+            attribute_count_limit: 128,
+          },
+          processors: [
+            {
+              batch: {
+                schedule_delay: 1000,
+                export_timeout: 30000,
+                max_queue_size: 2048,
+                max_export_batch_size: 512,
+                exporter: {
+                  otlp_http: {
+                    endpoint: 'http://localhost:4318/v1/logs',
+                    timeout: 10000,
+                    encoding: OtlpHttpEncoding.JSON,
+                  },
+                },
+              },
+            },
+          ],
+        },
+      };
+      const configProvider = createConfigFactory();
+      assert.deepStrictEqual(configProvider.getConfigModel(), expectedConfig);
+    });
+
     it('should use backup options for exporters', function () {
       process.env.OTEL_EXPORTER_OTLP_CERTIFICATE =
         'backup_certificate_file.pem';