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

Pre-v9: Prepare for OTELv2 #14570

Closed
1 task
lforst opened this issue Dec 4, 2024 · 2 comments
Closed
1 task

Pre-v9: Prepare for OTELv2 #14570

lforst opened this issue Dec 4, 2024 · 2 comments
Assignees
Milestone

Comments

@lforst
Copy link
Member

lforst commented Dec 4, 2024

Description

As preparation for OTEL v2 we need to do the following:

  • Make sure we don't re-export any OTEL TS declarations in any way shape or form because they will bump to 5.6ish which is way above our desired pain threshold for our users. The only way we can stay compatible is if our .d.ts files don't reference any @opentelemetry/* packages at all. If we do so, we need to deprecate them immediately.
@lforst lforst added this to the 9.0.0 milestone Dec 4, 2024
@lforst lforst self-assigned this Dec 4, 2024
@lforst
Copy link
Member Author

lforst commented Dec 5, 2024

As for the TypeScript version bump, we seem to have multiple options:

  1. Bump our minimum supported version to the same version as OTEL. Currently, this seems to be 5.0 and they would like to follow DT's support policy.
  2. Try to avoid referencing any types as defined in @opentelemetry/* packages in our .d.ts files.
  3. Bundle types with something like https://www.npmjs.com/package/rollup-plugin-dts and downlevel them.

My personal view on these:

  1. Aligning with DT's policy actually seems quite reasonable to me and it would be a reasonable amount of maintenance going forward. I am only worried about what this means process-wise when DT and/or OTEL bump their minimum version. Do we always need to inform users? Will things break? Potentially, this would allow us to stop downleveling our types because we have a policy to follow.
  2. Superficially trying this it seems rather tedious and error-prone. If possible I'd like to avoid this.
  3. There are a lot of question marks tied to the exact details of this approach. Does it work reliably? Does it work at all? We would also need to start forking downlevel-dts.

@lforst
Copy link
Member Author

lforst commented Dec 5, 2024

Decision made: As long as OTEL's plans don't change we will bump our support to 5.0 and also follow DefinitelyTyped's support schedule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant