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] reduce public API surface #4583

Open
Tracked by #4582
pichlermarc opened this issue Mar 26, 2024 · 3 comments · May be fixed by #5200
Open
Tracked by #4582

[otlp-transformer] reduce public API surface #4583

pichlermarc opened this issue Mar 26, 2024 · 3 comments · May be fixed by #5200
Assignees
Labels
never-stale pkg:otlp-transformer type:feature A feature with no sub-issues to address

Comments

@pichlermarc
Copy link
Member

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 OTLP exporter stability.

The API surface currently consists of 40+ types and functions. 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.

Goal of this issue is to:

Move the full serialization process to @opentelemetry/otlp-transformer, this way we will be able to reduce the API surface to:

  • an ISerializer interface
  • one serializer implementation per signal (metrics, logs, traces) and type (binary protobuf, json)
  • one response type per signal.
Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@pichlermarc
Copy link
Member Author

Most usages for the types that will be removed are in tests, I'm working on changing the tests so that they are not used anymore. (the start of that is #5196)

@pichlermarc
Copy link
Member Author

See also open-telemetry/opentelemetry-js-contrib#2565 for a follow-up in contrib to replace usage of types that will be removed by completing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
never-stale pkg:otlp-transformer type:feature A feature with no sub-issues to address
Projects
None yet
1 participant