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

chore(jeager-exporter): deprecate jaeger exporter #3585

Conversation

pichlermarc
Copy link
Member

@pichlermarc pichlermarc commented Feb 3, 2023

Which problem is this PR solving?

The end of the Jaeger exporter support was announced in the spec (open-telemetry/opentelemetry-specification#2858). From July 2023 onwards, having a Jaeger Exporter will be optional. This PR adds a deprecation notice to the jsdoc of the exporter, as well as to the README.

The intention of this PR is to gather feedback if deprecating the exporter is something that we'd want to do. 🙂

Fixes #2618

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@codecov
Copy link

codecov bot commented Feb 3, 2023

Codecov Report

Merging #3585 (67c09aa) into main (2f715bd) will decrease coverage by 0.02%.
The diff coverage is n/a.

❗ Current head 67c09aa differs from pull request most recent head 10a5fe6. Consider uploading reports for the commit 10a5fe6 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3585      +/-   ##
==========================================
- Coverage   93.64%   93.63%   -0.02%     
==========================================
  Files         275      275              
  Lines        8090     8076      -14     
  Branches     1679     1675       -4     
==========================================
- Hits         7576     7562      -14     
  Misses        514      514              
Impacted Files Coverage Δ
...ckages/opentelemetry-exporter-jaeger/src/jaeger.ts 94.93% <ø> (ø)
...elemetry-instrumentation-grpc/src/grpc-js/index.ts 92.30% <0.00%> (-0.44%) ⬇️
...entelemetry-instrumentation-grpc/src/grpc/index.ts 93.98% <0.00%> (-0.31%) ⬇️

@pichlermarc pichlermarc marked this pull request as ready for review February 3, 2023 10:07
@pichlermarc pichlermarc requested a review from a team February 3, 2023 10:07
@Flarna
Copy link
Member

Flarna commented Feb 3, 2023

I think we should deprecate it and also aim to remove it from the distribution/repo.

Do we have a defined deprecation cycle for GAed components?

Currently there is a pinned dependency to core and sdk-trace-base which is problematic in case we just stop releasing new versions. Maybe exclude it from lerna project and change these deps to ranges and then stop releasing it?

Copy link
Member

@blumamir blumamir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the first step is to add the deprecation warning now.

In July 2023 it makes sense to have one last release with caret dependency and then deprecate it in npm. Do we need to keep it in the codebase after July 2023?

Copy link
Member

@naseemkullah naseemkullah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created #3590 to track @Flarna's point of defining a deprecation strategy for GAed components, which we will apply to Jaeger exporter eventually

@pichlermarc
Copy link
Member Author

I've now set the EOL date to March 2024 following the discussion in #3590, and have not set it to private: true.
It will be included in released until that date, then we can set private: true. WDYT @open-telemetry/javascript-approvers? 🙂

@dyladan
Copy link
Member

dyladan commented Mar 3, 2023

I think the deprecation warning is enough

@pichlermarc pichlermarc merged commit ebc8575 into open-telemetry:main Mar 6, 2023
@pichlermarc pichlermarc deleted the chore/deprecate-jaeger-exporter branch March 6, 2023 05:48
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

Successfully merging this pull request may close these issues.

6 participants