Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[otlp-transformer] stabilization plan #4582

Open
pichlermarc opened this issue Mar 26, 2024 · 0 comments
Open

[otlp-transformer] stabilization plan #4582

pichlermarc opened this issue Mar 26, 2024 · 0 comments
Assignees
Labels
pkg:otlp-transformer type:feature-tracking A feature with sub-issues that need to be addressed

Comments

@pichlermarc
Copy link
Member

pichlermarc commented Mar 26, 2024

Description

The @opentelemetry/otlp-transformer package contains utilities to serialize signals data to and from OTLP (binary protobuf) or OTLP (json). As all OTLP exporters depend on this package, stabilization of @opentelemetry/otlp-transformer is required for exporter stability.

The package may be moved to stable once the below issues are resolved.

Currently the following issues prevent stabilization:

Large API surface:

The API surface currently consists of 40+ types and functions. By moving the complete serialization process to @opentelemetry/otlp-transformer we will be able to reduce the API surface to an interface ISerializer, one serializer implementation per signal (metrics, logs, traces) and type (binary protobuf, json), as well as one response type per signal.

Reducing the API surface is required to enable optimizations in the serialization process in terms memory use, performance, and bundle size without being constrained by a large stable public API.

This will be addressed by #4583

Non-stable dependencies:

@opentelemetry/otlp-transformer depends on @opentelemetry/sdk-logs and @opentelemetry/api-logs which may not be stable by the time we want to stabilize the @opentelemetry/otlp-transformer package. In this case, after reducing the API surface, we should mark all types and functions that use experimental types as @experimental

This will be addressed by #4584

@pichlermarc pichlermarc added pkg:otlp-transformer type:feature-tracking A feature with sub-issues that need to be addressed labels Mar 26, 2024
@pichlermarc pichlermarc self-assigned this Mar 26, 2024
@pichlermarc pichlermarc added needs:refinement This issue needs to be refined/broken apart into sub-issues before implementation and removed needs:refinement This issue needs to be refined/broken apart into sub-issues before implementation labels Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:otlp-transformer type:feature-tracking A feature with sub-issues that need to be addressed
Projects
None yet
Development

No branches or pull requests

1 participant