Skip to content

Commit f9302c7

Browse files
committed
docs(otlp-transformer): add entrypoints to readme.md
1 parent 16252fe commit f9302c7

File tree

1 file changed

+16
-0
lines changed
  • experimental/packages/otlp-transformer

1 file changed

+16
-0
lines changed

experimental/packages/otlp-transformer/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,22 @@ To get started you will need to install a compatible OpenTelemetry API.
1919
npm install @opentelemetry/api
2020
```
2121

22+
### Entrypoints
23+
24+
Since this package depends on all signals, and protobuf.js for serialization,
25+
this package offers multiple entrypoints to avoid polluting the app during bundling.
26+
27+
- `@opentelmetry/otlp-transformer` interfaces used by every signal
28+
- `@opentelmetry/otlp-transformer/metrics` interfaces used by metrics
29+
- `@opentelmetry/otlp-transformer/metrics/protobuf` OTLP protobuf serialization for metrics
30+
- `@opentelmetry/otlp-transformer/metrics/json` OTLP JSON serialization for metrics
31+
- `@opentelmetry/otlp-transformer/trace` interfaces used by trace
32+
- `@opentelmetry/otlp-transformer/trace/protobuf` OTLP protobuf serialization for trace
33+
- `@opentelmetry/otlp-transformer/trace/json` OTLP JSON serialization for trace
34+
- `@opentelmetry/otlp-transformer/experimental/logs` interfaces used by logs
35+
- `@opentelmetry/otlp-transformer/experimental/logs/protobuf` OTLP protobuf serialization for logs
36+
- `@opentelmetry/otlp-transformer/experimental/logs/json` OTLP JSON serialization for logs
37+
2238
### Serialize Traces/Metrics/Logs
2339

2440
This module exports serializers to serialize traces, metrics and logs from the OpenTelemetry SDK into protocol buffers

0 commit comments

Comments
 (0)