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] introduce separate entry-points for OTLP serializers #5216

Open
3 tasks
Tracked by #4582
pichlermarc opened this issue Nov 28, 2024 · 0 comments · May be fixed by #5263
Open
3 tasks
Tracked by #4582

[otlp-transformer] introduce separate entry-points for OTLP serializers #5216

pichlermarc opened this issue Nov 28, 2024 · 0 comments · May be fixed by #5263
Assignees
Labels
pkg:otlp-transformer type:feature A feature with no sub-issues to address

Comments

@pichlermarc
Copy link
Member

pichlermarc commented Nov 28, 2024

Description

In preparation of marking @opentelemetry/otlp-transformer as stable (#4582) we should introduce separate entry-points to ensure that

This issue is considered done when

  • Experimental types/functions are available via @opentelemetry/otlp-transformer/experimental
  • JSON and Protobuf serializers can be required from seperate entrypoints
    -example: @opentelemetry/otlp-transformer/json, @opentelemetry/otlp-transformer/protobuf
  • entrypoints and stability expectations for each entrypoint have been documented in README.md
@pichlermarc pichlermarc added pkg:otlp-transformer type:feature A feature with no sub-issues to address labels Nov 28, 2024
@pichlermarc pichlermarc added this to the OTLP Exporter GA milestone Nov 28, 2024
@pichlermarc pichlermarc self-assigned this Nov 28, 2024
@pichlermarc pichlermarc changed the title [otlp-transformer] introduce multiple entry-points for OTLP serializers [otlp-transformer] introduce separate entry-points for OTLP serializers Nov 28, 2024
chancancode added a commit to tildeio/opentelemetry-js that referenced this issue Dec 12, 2024
In preparation of stabilizing `@opentelemetry/otlp-transformer`,
this commit introduces some new entrypoints for the package:

* `@opentelemetry/otlp-transformer/proto`: utilities for working
  with the OTLP binary protobuf format
* `@opentelemetry/otlp-transformer/json`: utilities for working
  with the OTLP JSON format
* `@opentelemetry/otlp-transformer/experimental`: features to
  remain in experimental status post-stabilization

The intent of separating out the first two entrypoints is to both
aid bundlers with tree-shaking, but also to prevent the irrelevant
code from running at all, since the generated prtobuf code is known
to cause problems in certain environments (e.g. see open-telemetry#4987, open-telemetry#5096).

The last of those entrypoints is currently empty, but expected to
be utilized in future commits as features are triaged as part of
the stabilization effort.

Fixes open-telemetry#5216
chancancode added a commit to tildeio/opentelemetry-js that referenced this issue Dec 12, 2024
In preparation of stabilizing `@opentelemetry/otlp-transformer`,
this commit introduces some new entrypoints for the package:

* `@opentelemetry/otlp-transformer/proto`: utilities for working
  with the OTLP binary protobuf format
* `@opentelemetry/otlp-transformer/json`: utilities for working
  with the OTLP JSON format
* `@opentelemetry/otlp-transformer/experimental`: features to
  remain in experimental status post-stabilization

The intent of separating out the first two entrypoints is to both
aid bundlers with tree-shaking, but also to prevent the irrelevant
code from running at all, since the generated prtobuf code is known
to cause problems in certain environments (e.g. see open-telemetry#4987, open-telemetry#5096).

The last of those entrypoints is currently empty, but expected to
be utilized in future commits as features are triaged as part of
the stabilization effort.

Fixes open-telemetry#5216
chancancode added a commit to tildeio/opentelemetry-js that referenced this issue Dec 12, 2024
In preparation of stabilizing `@opentelemetry/otlp-transformer`,
this commit introduces some new entrypoints for the package:

* `@opentelemetry/otlp-transformer/proto`: utilities for working
  with the OTLP binary protobuf format
* `@opentelemetry/otlp-transformer/json`: utilities for working
  with the OTLP JSON format
* `@opentelemetry/otlp-transformer/experimental`: features to
  remain in experimental status post-stabilization

The intent of separating out the first two entrypoints is to both
aid bundlers with tree-shaking, but also to prevent the irrelevant
code from running at all, since the generated prtobuf code is known
to cause problems in certain environments (e.g. see open-telemetry#4987, open-telemetry#5096).

The last of those entrypoints is currently empty, but expected to
be utilized in future commits as features are triaged as part of
the stabilization effort.

Fixes open-telemetry#5216
chancancode added a commit to tildeio/opentelemetry-js that referenced this issue Dec 13, 2024
In preparation of stabilizing `@opentelemetry/otlp-transformer`,
this commit introduces some new entrypoints for the package:

* `@opentelemetry/otlp-transformer/protobuf`: utilities for working
  with the OTLP binary protobuf format
* `@opentelemetry/otlp-transformer/json`: utilities for working
  with the OTLP JSON format
* `@opentelemetry/otlp-transformer/experimental`: features to
  remain in experimental status post-stabilization

The intent of separating out the first two entrypoints is to both
aid bundlers with tree-shaking, but also to prevent the irrelevant
code from running at all, since the generated prtobuf code is known
to cause problems in certain environments (e.g. see open-telemetry#4987, open-telemetry#5096).

The last of those entrypoints is currently empty, but expected to
be utilized in future commits as features are triaged as part of
the stabilization effort.

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