feat(otlp-transformer)!: use factory functions over constants to better allow keeping state in the future

Author: pichlermarc

experimental/CHANGELOG.md

@@ -10,6 +10,23 @@ All notable changes to experimental packages in this project will be documented
 ### :rocket: (Enhancement)
 
 * feat(opentelemetry-sdk-node): automatically configure metrics exporter based on environment variables [#5168](https://github.com/open-telemetry/opentelemetry-js/pull/5168) @bhaskarbanerjee
+* feat(oltp-transformer)!: move each serializer to its own entrypoint
+  * This package depends on all signals, as well as `protobuf.js`, so some bundlers like rollup would issue warnings even if the user made a conscious decision to not use a protobuf exporter
+  * (user-facing) All types except for `ISerializer` were removed from the main entrypoint, to get previously exported types, use the following entrypoints
+    * `@opentelemetry/otlp-transformer/metrics`: metrics export service return types
+    * `@opentelemetry/otlp-transformer/metrics/json`: metrics json serializer
+    * `@opentelemetry/otlp-transformer/metrics/protobuf`: metrics protobuf serializer
+    * `@opentelemetry/otlp-transformer/trace`: trace export service return types
+    * `@opentelemetry/otlp-transformer/trace/trace`: trace json serializer
+    * `@opentelemetry/otlp-transformer/trace/protobuf`: trace protobuf serializer
+    * `@opentelemetry/otlp-transformer/logs`: logs export service return types
+    * `@opentelemetry/otlp-transformer/logs/trace`: logs export service return types
+    * `@opentelemetry/otlp-transformer/logs/protobuf`: logs export service return types
+* feat(otlp-transformer)!: change serializer acquisition from constant to factory function
+  * (user-facing) serializer constant export have now been removed and replaced by factory functions
+    * to acquire a serializer, replace `<ExportType><Signal>Serializer` with `create<ExportType><Signal>Serializer()`
+      * example: `ProtobufMetricsSerializer` -> `createProtobufMetricsSerializer()`
+    * this was done to simplify future performance improvements without having to introduce additional APIs
 
 ### :bug: (Bug Fix)
 

experimental/packages/exporter-logs-otlp-grpc/src/OTLPLogExporter.ts

@@ -20,7 +20,7 @@ import {
   createOtlpGrpcExportDelegate,
   OTLPGRPCExporterConfigNode,
 } from '@opentelemetry/otlp-grpc-exporter-base';
-import { ProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
+import { createProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
 import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
 
 /**
@@ -34,7 +34,7 @@ export class OTLPLogExporter
     super(
       createOtlpGrpcExportDelegate(
         convertLegacyOtlpGrpcOptions(config, 'LOGS'),
-        ProtobufLogsSerializer,
+        createProtobufLogsSerializer(),
         'LogsExportService',
         '/opentelemetry.proto.collector.logs.v1.LogsService/Export'
       )

experimental/packages/exporter-logs-otlp-http/src/platform/browser/OTLPLogExporter.ts

@@ -21,7 +21,7 @@ import type {
 import type { OTLPExporterConfigBase } from '@opentelemetry/otlp-exporter-base';
 import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
 import { createLegacyOtlpBrowserExportDelegate } from '@opentelemetry/otlp-exporter-base/browser-http';
-import { JsonLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/json';
+import { createJsonLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/json';
 
 /**
  * Collector Logs Exporter for Web
@@ -34,7 +34,7 @@ export class OTLPLogExporter
     super(
       createLegacyOtlpBrowserExportDelegate(
         config,
-        JsonLogsSerializer,
+        createJsonLogsSerializer(),
         'v1/logs',
         { 'Content-Type': 'application/json' }
       )

experimental/packages/exporter-logs-otlp-http/src/platform/node/OTLPLogExporter.ts

@@ -20,7 +20,7 @@ import type {
 } from '@opentelemetry/sdk-logs';
 import type { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
 import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
-import { JsonLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/json';
+import { createJsonLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/json';
 import { VERSION } from '../../version';
 import {
   convertLegacyHttpOptions,
@@ -41,7 +41,7 @@ export class OTLPLogExporter
           'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
           'Content-Type': 'application/json',
         }),
-        JsonLogsSerializer
+        createJsonLogsSerializer()
       )
     );
   }

experimental/packages/exporter-logs-otlp-proto/src/platform/browser/OTLPLogExporter.ts

@@ -18,7 +18,7 @@ import {
   OTLPExporterConfigBase,
   OTLPExporterBase,
 } from '@opentelemetry/otlp-exporter-base';
-import { ProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
+import { createProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
 
 import { ReadableLogRecord, LogRecordExporter } from '@opentelemetry/sdk-logs';
 import { createLegacyOtlpBrowserExportDelegate } from '@opentelemetry/otlp-exporter-base/browser-http';
@@ -34,7 +34,7 @@ export class OTLPLogExporter
     super(
       createLegacyOtlpBrowserExportDelegate(
         config,
-        ProtobufLogsSerializer,
+        createProtobufLogsSerializer(),
         'v1/logs',
         { 'Content-Type': 'application/x-protobuf' }
       )

experimental/packages/exporter-logs-otlp-proto/src/platform/node/OTLPLogExporter.ts

@@ -18,7 +18,7 @@ import {
   OTLPExporterBase,
   OTLPExporterNodeConfigBase,
 } from '@opentelemetry/otlp-exporter-base';
-import { ProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
+import { createProtobufLogsSerializer } from '@opentelemetry/otlp-transformer/experimental/logs/protobuf';
 import {
   convertLegacyHttpOptions,
   createOtlpHttpExportDelegate,
@@ -41,7 +41,7 @@ export class OTLPLogExporter
           'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
           'Content-Type': 'application/x-protobuf',
         }),
-        ProtobufLogsSerializer
+        createProtobufLogsSerializer()
       )
     );
   }

experimental/packages/exporter-trace-otlp-grpc/src/OTLPTraceExporter.ts

@@ -20,7 +20,7 @@ import {
   createOtlpGrpcExportDelegate,
   OTLPGRPCExporterConfigNode,
 } from '@opentelemetry/otlp-grpc-exporter-base';
-import { ProtobufTraceSerializer } from '@opentelemetry/otlp-transformer/trace/protobuf';
+import { createProtobufTraceSerializer } from '@opentelemetry/otlp-transformer/trace/protobuf';
 import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
 
 /**
@@ -34,7 +34,7 @@ export class OTLPTraceExporter
     super(
       createOtlpGrpcExportDelegate(
         convertLegacyOtlpGrpcOptions(config, 'TRACES'),
-        ProtobufTraceSerializer,
+        createProtobufTraceSerializer(),
         'TraceExportService',
         '/opentelemetry.proto.collector.trace.v1.TraceService/Export'
       )

experimental/packages/exporter-trace-otlp-http/src/platform/browser/OTLPTraceExporter.ts

@@ -19,7 +19,7 @@ import {
   OTLPExporterConfigBase,
   OTLPExporterBase,
 } from '@opentelemetry/otlp-exporter-base';
-import { JsonTraceSerializer } from '@opentelemetry/otlp-transformer/trace/json';
+import { createJsonTraceSerializer } from '@opentelemetry/otlp-transformer/trace/json';
 import { createLegacyOtlpBrowserExportDelegate } from '@opentelemetry/otlp-exporter-base/browser-http';
 
 /**
@@ -33,7 +33,7 @@ export class OTLPTraceExporter
     super(
       createLegacyOtlpBrowserExportDelegate(
         config,
-        JsonTraceSerializer,
+        createJsonTraceSerializer(),
         'v1/traces',
         { 'Content-Type': 'application/json' }
       )

experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts

@@ -20,7 +20,7 @@ import {
   OTLPExporterBase,
 } from '@opentelemetry/otlp-exporter-base';
 import { VERSION } from '../../version';
-import { JsonTraceSerializer } from '@opentelemetry/otlp-transformer/trace/json';
+import { createJsonTraceSerializer } from '@opentelemetry/otlp-transformer/trace/json';
 import {
   convertLegacyHttpOptions,
   createOtlpHttpExportDelegate,
@@ -40,7 +40,7 @@ export class OTLPTraceExporter
           'User-Agent': `OTel-OTLP-Exporter-JavaScript/${VERSION}`,
           'Content-Type': 'application/json',
         }),
-        JsonTraceSerializer
+        createJsonTraceSerializer()
       )
     );
   }

experimental/packages/exporter-trace-otlp-proto/src/platform/browser/OTLPTraceExporter.ts

@@ -19,7 +19,7 @@ import {
   OTLPExporterConfigBase,
   OTLPExporterBase,
 } from '@opentelemetry/otlp-exporter-base';
-import { ProtobufTraceSerializer } from '@opentelemetry/otlp-transformer/trace/protobuf';
+import { createProtobufTraceSerializer } from '@opentelemetry/otlp-transformer/trace/protobuf';
 import { createLegacyOtlpBrowserExportDelegate } from '@opentelemetry/otlp-exporter-base/browser-http';
 
 const DEFAULT_COLLECTOR_RESOURCE_PATH = 'v1/traces';
@@ -35,7 +35,7 @@ export class OTLPTraceExporter
     super(
       createLegacyOtlpBrowserExportDelegate(
         config,
-        ProtobufTraceSerializer,
+        createProtobufTraceSerializer(),
         DEFAULT_COLLECTOR_RESOURCE_PATH,
         { 'Content-Type': 'application/x-protobuf' }
       )