feat!:move serializers to otlp-transformer

Author: pichlermarc

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "experimental/packages/otlp-grpc-exporter-base/protos"]
-	path = experimental/packages/otlp-grpc-exporter-base/protos
-	url = https://github.com/open-telemetry/opentelemetry-proto.git
 [submodule "experimental/packages/otlp-proto-exporter-base/protos"]
 	path = experimental/packages/otlp-proto-exporter-base/protos
 	url = https://github.com/open-telemetry/opentelemetry-proto.git
+[submodule "experimental/packages/otlp-transformer/protos"]
+	path = experimental/packages/otlp-transformer/protos
+	url = https://github.com/open-telemetry/opentelemetry-proto.git

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

@@ -21,12 +21,11 @@ import {
   OTLPGRPCExporterNodeBase,
   validateAndNormalizeUrl,
   DEFAULT_COLLECTOR_URL,
-  LogsSerializer,
 } from '@opentelemetry/otlp-grpc-exporter-base';
 import {
-  createExportLogsServiceRequest,
   IExportLogsServiceRequest,
   IExportLogsServiceResponse,
+  ProtobufLogsSerializer,
 } from '@opentelemetry/otlp-transformer';
 import { VERSION } from './version';
 
@@ -57,14 +56,10 @@ export class OTLPLogExporter
       signalSpecificMetadata,
       'LogsExportService',
       '/opentelemetry.proto.collector.logs.v1.LogsService/Export',
-      LogsSerializer
+      ProtobufLogsSerializer
     );
   }
 
-  convert(logRecords: ReadableLogRecord[]): IExportLogsServiceRequest {
-    return createExportLogsServiceRequest(logRecords);
-  }
-
   getDefaultUrl(config: OTLPGRPCExporterConfigNode) {
     return validateAndNormalizeUrl(this.getUrlFromConfig(config));
   }

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

@@ -40,9 +40,7 @@ import { VERSION } from '../src/version';
 
 const logsServiceProtoPath =
   'opentelemetry/proto/collector/logs/v1/logs_service.proto';
-const includeDirs = [
-  path.resolve(__dirname, '../../otlp-grpc-exporter-base/protos'),
-];
+const includeDirs = [path.resolve(__dirname, '../../otlp-transformer/protos')];
 
 const httpAddr = 'https://localhost:1503';
 const udsAddr = 'unix:///tmp/otlp-logs.sock';

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

@@ -21,12 +21,11 @@ import {
   OTLPGRPCExporterNodeBase,
   validateAndNormalizeUrl,
   DEFAULT_COLLECTOR_URL,
-  TraceSerializer,
 } from '@opentelemetry/otlp-grpc-exporter-base';
 import {
-  createExportTraceServiceRequest,
   IExportTraceServiceRequest,
   IExportTraceServiceResponse,
+  ProtobufTraceSerializer,
 } from '@opentelemetry/otlp-transformer';
 import { VERSION } from './version';
 
@@ -57,14 +56,10 @@ export class OTLPTraceExporter
       signalSpecificMetadata,
       'TraceExportService',
       '/opentelemetry.proto.collector.trace.v1.TraceService/Export',
-      TraceSerializer
+      ProtobufTraceSerializer
     );
   }
 
-  convert(spans: ReadableSpan[]): IExportTraceServiceRequest {
-    return createExportTraceServiceRequest(spans);
-  }
-
   getDefaultUrl(config: OTLPGRPCExporterConfigNode) {
     return validateAndNormalizeUrl(this.getUrlFromConfig(config));
   }

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

@@ -44,9 +44,7 @@ import {
 
 const traceServiceProtoPath =
   'opentelemetry/proto/collector/trace/v1/trace_service.proto';
-const includeDirs = [
-  path.resolve(__dirname, '../../otlp-grpc-exporter-base/protos'),
-];
+const includeDirs = [path.resolve(__dirname, '../../otlp-transformer/protos')];
 
 const httpAddr = 'https://localhost:1501';
 const udsAddr = 'unix:///tmp/otlp-traces.sock';

experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/src/OTLPMetricExporter.ts

@@ -24,13 +24,12 @@ import {
   OTLPGRPCExporterNodeBase,
   validateAndNormalizeUrl,
   DEFAULT_COLLECTOR_URL,
-  MetricsSerializer,
 } from '@opentelemetry/otlp-grpc-exporter-base';
 import { baggageUtils, getEnv } from '@opentelemetry/core';
 import {
-  createExportMetricsServiceRequest,
   IExportMetricsServiceRequest,
   IExportMetricsServiceResponse,
+  ProtobufMetricsSerializer,
 } from '@opentelemetry/otlp-transformer';
 import { VERSION } from './version';
 
@@ -56,18 +55,14 @@ class OTLPMetricExporterProxy extends OTLPGRPCExporterNodeBase<
       signalSpecificMetadata,
       'MetricsExportService',
       '/opentelemetry.proto.collector.metrics.v1.MetricsService/Export',
-      MetricsSerializer
+      ProtobufMetricsSerializer
     );
   }
 
   getDefaultUrl(config: OTLPGRPCExporterConfigNode): string {
     return validateAndNormalizeUrl(this.getUrlFromConfig(config));
   }
 
-  convert(metrics: ResourceMetrics[]): IExportMetricsServiceRequest {
-    return createExportMetricsServiceRequest(metrics);
-  }
-
   getUrlFromConfig(config: OTLPGRPCExporterConfigNode): string {
     if (typeof config.url === 'string') {
       return config.url;

experimental/packages/opentelemetry-exporter-metrics-otlp-grpc/test/OTLPMetricExporter.test.ts

@@ -45,9 +45,7 @@ import { AggregationTemporalityPreference } from '@opentelemetry/exporter-metric
 
 const metricsServiceProtoPath =
   'opentelemetry/proto/collector/metrics/v1/metrics_service.proto';
-const includeDirs = [
-  path.resolve(__dirname, '../../otlp-grpc-exporter-base/protos'),
-];
+const includeDirs = [path.resolve(__dirname, '../../otlp-transformer/protos')];
 
 const httpAddr = 'https://localhost:1502';
 const udsAddr = 'unix:///tmp/otlp-metrics.sock';

experimental/packages/otlp-grpc-exporter-base/package.json

@@ -8,17 +8,14 @@
   "scripts": {
     "prepublishOnly": "npm run compile",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../",
-    "compile": "npm run protos && tsc --build",
+    "compile": "tsc --build",
     "clean": "tsc --build --clean",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "protos": "npm run submodule && npm run protos:generate",
-    "protos:generate": "node ../../../scripts/generate-protos.js",
-    "submodule": "git submodule sync --recursive && git submodule update --init --recursive",
     "tdd": "npm run test -- --watch-extensions ts --watch",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "version": "node ../../../scripts/version-update.js",
-    "watch": "npm run protos && tsc -w",
+    "watch": "tsc -w",
     "precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies",
     "prewatch": "npm run precompile"
   },

experimental/packages/otlp-grpc-exporter-base/src/OTLPGRPCExporterNodeBase.ts

@@ -27,7 +27,7 @@ import {
   GrpcExporterTransport,
 } from './grpc-exporter-transport';
 import { configureCompression, configureCredentials } from './util';
-import { ISerializer } from './serializers';
+import { ISerializer } from '@opentelemetry/otlp-transformer';
 import { IExporterTransport } from './exporter-transport';
 
 /**
@@ -45,14 +45,14 @@ export abstract class OTLPGRPCExporterNodeBase<
   grpcQueue: GRPCQueueItem<ExportItem>[] = [];
   compression: CompressionAlgorithm;
   private _transport: IExporterTransport;
-  private _serializer: ISerializer<ServiceRequest, ServiceResponse>;
+  private _serializer: ISerializer<ExportItem[], ServiceResponse>;
 
   constructor(
     config: OTLPGRPCExporterConfigNode = {},
     signalSpecificMetadata: Record<string, string>,
     grpcName: string,
     grpcPath: string,
-    serializer: ISerializer<ServiceRequest, ServiceResponse>
+    serializer: ISerializer<ExportItem[], ServiceResponse>
   ) {
     super(config);
     this._serializer = serializer;
@@ -114,6 +114,11 @@ export abstract class OTLPGRPCExporterNodeBase<
     this._transport.shutdown();
   }
 
+  override convert(_objects: ExportItem[]): ServiceRequest {
+    // Not used, nothing to do.
+    return {} as ServiceRequest;
+  }
+
   send(
     objects: ExportItem[],
     onSuccess: () => void,
@@ -124,8 +129,7 @@ export abstract class OTLPGRPCExporterNodeBase<
       return;
     }
 
-    const converted = this.convert(objects);
-    const data = this._serializer.serializeRequest(converted);
+    const data = this._serializer.serializeRequest(objects);
 
     if (data == null) {
       onError(new Error('Could not serialize message'));

experimental/packages/otlp-grpc-exporter-base/src/index.ts

@@ -17,9 +17,3 @@
 export { OTLPGRPCExporterNodeBase } from './OTLPGRPCExporterNodeBase';
 export { OTLPGRPCExporterConfigNode } from './types';
 export { DEFAULT_COLLECTOR_URL, validateAndNormalizeUrl } from './util';
-export {
-  MetricsSerializer,
-  TraceSerializer,
-  LogsSerializer,
-  ISerializer,
-} from './serializers';

experimental/packages/otlp-grpc-exporter-base/test/OTLPGRPCExporterNodeBase.test.ts

@@ -21,7 +21,7 @@ import { OTLPGRPCExporterConfigNode } from '../src/types';
 import { mockedReadableSpan } from './traceHelper';
 import { ExportResponse, ExportResponseSuccess } from '../src/export-response';
 import { IExporterTransport } from '../src/exporter-transport';
-import { ISerializer } from '../src';
+import { ISerializer } from '@opentelemetry/otlp-transformer';
 import sinon = require('sinon');
 
 class MockCollectorExporter extends OTLPGRPCExporterNodeBase<
@@ -33,10 +33,6 @@ class MockCollectorExporter extends OTLPGRPCExporterNodeBase<
     return '';
   }
 
-  convert(spans: ReadableSpan[]): ReadableSpan[] {
-    return spans;
-  }
-
   getUrlFromConfig(config: OTLPGRPCExporterConfigNode): string {
     return '';
   }

experimental/packages/otlp-grpc-exporter-base/tsconfig.json

@@ -1,14 +1,11 @@
 {
   "extends": "../../../tsconfig.base.json",
   "compilerOptions": {
-    "allowJs": true,
     "outDir": "build",
     "rootDir": "."
   },
   "include": [
     "src/**/*.ts",
-    "src/generated/**/*.js",
-    "src/generated/**/*.ts",
     "test/**/*.ts"
   ],
   "references": [

experimental/packages/otlp-transformer/.gitignore

@@ -1,2 +1,3 @@
-src/generated
-!src/logs
+src/generated/*
+!src/generated/.gitkeep
+!src/logs

experimental/packages/otlp-transformer/package.json

@@ -14,16 +14,19 @@
   "scripts": {
     "prepublishOnly": "npm run compile",
     "precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies",
-    "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
+    "compile": "npm run protos && tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
     "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
+    "protos": "npm run submodule && npm run protos:generate",
+    "protos:generate": "node ../../../scripts/generate-protos.js",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "tdd": "npm run test -- --watch-extensions ts --watch",
+    "submodule": "git submodule sync --recursive && git submodule update --init --recursive",
     "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'",
     "test:browser": "karma start --single-run",
     "test:bench": "node test/performance/benchmark/index.js | tee .benchmark-results.txt",
     "prewatch": "node ../../../scripts/version-update.js",
-    "watch": "tsc --build -w tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
+    "watch": "npm run protos && tsc -w tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
     "peer-api-check": "node ../../../scripts/peer-api-check.js",
     "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../../"
   },
@@ -76,15 +79,17 @@
     "ts-loader": "8.4.0",
     "ts-mocha": "10.0.0",
     "typescript": "4.4.4",
-    "webpack": "5.89.0"
+    "webpack": "5.89.0",
+    "protobufjs-cli": "1.1.2"
   },
   "dependencies": {
     "@opentelemetry/api-logs": "0.49.1",
     "@opentelemetry/core": "1.22.0",
     "@opentelemetry/resources": "1.22.0",
     "@opentelemetry/sdk-logs": "0.49.1",
     "@opentelemetry/sdk-metrics": "1.22.0",
-    "@opentelemetry/sdk-trace-base": "1.22.0"
+    "@opentelemetry/sdk-trace-base": "1.22.0",
+    "protobufjs": "^7.2.3"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/otlp-transformer",
   "sideEffects": false

experimental/packages/otlp-grpc-exporter-base/protos renamed to experimental/packages/otlp-transformer/protos

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Serializes and deserializes the OTLP request/response to and from {@link Uint8Array}
+ */
+export interface ISerializer<Request, Response> {
+  serializeRequest(request: Request): Uint8Array | undefined;
+  deserializeResponse(data: Uint8Array): Response;
+}

experimental/packages/otlp-transformer/src/common/i-serializer.ts

@@ -24,3 +24,11 @@ export * from './logs/types';
 export { createExportTraceServiceRequest } from './trace';
 export { createExportMetricsServiceRequest } from './metrics';
 export { createExportLogsServiceRequest } from './logs';
+
+export {
+  ProtobufLogsSerializer,
+  ProtobufMetricsSerializer,
+  ProtobufTraceSerializer,
+} from './protobuf/serializers';
+
+export { ISerializer } from './common/i-serializer';