fix(otlp-transformer): include esm and esnext in package files and up…

…date README (#2992)

Co-authored-by: Daniel Dyla <[email protected]>

experimental/CHANGELOG.md

@@ -26,6 +26,7 @@ All notable changes to experimental packages in this project will be documented
 * fix(opentelemetry-instrumentation-http): use correct origin when port is `null` #2948 @danielgblanco
 * fix(otlp-exporter-base): include esm and esnext in package files #2952 @dyladan
 * fix(otlp-http-exporter): update endpoint to match spec #2895 @svetlanabrennan
+* fix(otlp-transformer): include esm and esnext in package files and update README #2992 @pichlermarc
 
 ### :books: (Refine Doc)
 

experimental/packages/otlp-transformer/README.md

@@ -3,9 +3,9 @@
 [![NPM Published Version][npm-img]][npm-url]
 [![Apache License][license-image]][license-image]
 
-This package provides everything needed to serialize [OpenTelemetry SDK][sdk] traces and metrics into the [OpenTelemetry Protocol][otlp] format using [protocol buffers][protobuf] or JSON.
-It also contains service clients for exporting traces and metrics to the OpenTelemetry Collector or a compatible receiver using using OTLP over [gRPC][grpc].
-This module uses [`protobufjs`][protobufjs] for serialization and is compatible with [`@grpc/grpc-js`][grpc-js].
+**NOTE: This package is intended for internal use only.**
+
+This package provides everything needed to serialize [OpenTelemetry SDK][sdk] traces and metrics into the [OpenTelemetry Protocol][otlp] format.
 
 ## Quick Start
 
@@ -14,9 +14,7 @@ To get started you will need to install a compatible OpenTelemetry API.
 ### Install Peer Dependencies
 
 ```sh
-npm install \
-    @opentelemetry/api \
-    @grpc/grpc-js # only required if you are using gRPC
+npm install @opentelemetry/api
 ```
 
 ### Serialize Traces and Metrics
@@ -30,65 +28,6 @@ const serializedSpans = createExportTraceServiceRequest(readableSpans);
 const serializedMetrics = createExportMetricsServiceRequest(readableMetrics);
 ```
 
-### Create gRPC Service Clients
-
-This module also contains gRPC service clients for exporting traces and metrics to an OpenTelemetry collector or compatible receiver over gRPC.
-In order to avoid bundling a gRPC module with this module, it is required to construct an RPC implementation to pass to the constructor of the service clients.
-Any RPC implementation compatible with `grpc` or `@grpc/grpc-js` may be used, but `@grpc/grpc-js` is recommended.
-
-```typescript
-import type { RPCImpl } from 'protobufjs';
-import { makeGenericClientConstructor, credentials } from '@gprc/grpc-js';
-import { MetricServiceClient, TraceServiceClient } from "@opentelemetry/otlp-transformer";
-
-// Construct a RPC Implementation according to protobufjs docs
-const GrpcClientConstructor = makeGenericClientConstructor({});
-
-const metricGRPCClient = new GrpcClientConstructor(
-    "http://localhost:4317/v1/metrics", // default collector metrics endpoint
-    credentials.createInsecure(),
-);
-
-const traceGRPCClient = new GrpcClientConstructor(
-    "http://localhost:4317/v1/traces", // default collector traces endpoint
-    credentials.createInsecure(),
-);
-
-const metricRpc: RPCImpl = function(method, requestData, callback) {
-  metricGRPCClient.makeUnaryRequest(
-    method.name,
-    arg => arg,
-    arg => arg,
-    requestData,
-    callback
-  );
-}
-
-const traceRpc: RPCImpl = function(method, requestData, callback) {
-  traceGRPCClient.makeUnaryRequest(
-    method.name,
-    arg => arg,
-    arg => arg,
-    requestData,
-    callback
-  );
-}
-
-// Construct service clients to use RPC Implementations
-const metricServiceClient = new MetricServiceClient({
-    rpcImpl: metricRpc,
-    startTime: Date.now(), // exporter start time in milliseconds
-});
-
-const traceServiceClient = new TraceServiceClient({
-    rpcImpl: traceRpc,
-});
-
-// Export ReadableSpan[] and ReadableMetric[] over gRPC
-await metricServiceClient.export(readableMetrics);
-await traceServiceClient.export(readableSpans);
-```
-
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
@@ -107,9 +46,3 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 
 [sdk]: https://github.com/open-telemetry/opentelemetry-js
 [otlp]: https://github.com/open-telemetry/opentelemetry-proto
-
-[protobuf]: https://developers.google.com/protocol-buffers
-[grpc]: https://grpc.io/
-
-[protobufjs]: https://www.npmjs.com/package/protobufjs
-[grpc-js]: https://www.npmjs.com/package/@grpc/grpc-js

experimental/packages/otlp-transformer/package.json

@@ -38,6 +38,12 @@
     "node": ">=8.12.0"
   },
   "files": [
+    "build/esm/**/*.js",
+    "build/esm/**/*.js.map",
+    "build/esm/**/*.d.ts",
+    "build/esnext/**/*.js",
+    "build/esnext/**/*.js.map",
+    "build/esnext/**/*.d.ts",
     "build/src/**/*.js",
     "build/src/**/*.js.map",
     "build/src/**/*.d.ts",