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

[MAINTAINER DOC] Define and document a deprecation process #1923

Merged
merged 22 commits into from
Jan 30, 2023

Conversation

marcalff
Copy link
Member

@marcalff marcalff commented Jan 12, 2023

Fixes #1893
Fixes #1892

Changes

This change contains:

  • Documentation for the new deprecation process,
  • Supporting CMake options for the verification build documented in the process,
  • Changed in CI to build the MAINTAINER_MODE code without deprecated items.

Also, it contains the actual deprecation for the Jaeger Exporter:

  • CMake changes to deprecate WITH_JAEGER,
  • C++ changes in headers to deprecate all jaeger related code,
  • Entries in DEPRECATED.md to document the jaeger exporter deprecation.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

Example of deprecation, for jaeger.
@marcalff marcalff requested a review from a team January 12, 2023 23:33
@marcalff marcalff marked this pull request as draft January 12, 2023 23:33
@codecov
Copy link

codecov bot commented Jan 12, 2023

Codecov Report

Merging #1923 (cda221a) into main (65ebdb1) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1923      +/-   ##
==========================================
- Coverage   87.12%   87.10%   -0.02%     
==========================================
  Files         165      165              
  Lines        4596     4596              
==========================================
- Hits         4004     4003       -1     
- Misses        592      593       +1     
Impacted Files Coverage Δ
...i/include/opentelemetry/trace/propagation/jaeger.h 97.68% <ø> (ø)
sdk/src/trace/batch_span_processor.cc 90.70% <0.00%> (-0.77%) ⬇️

@marcalff marcalff marked this pull request as ready for review January 18, 2023 23:43
@lalitb
Copy link
Member

lalitb commented Jan 20, 2023

Thanks, a very well thought-out and documented process. This will indeed smoothen the deprecation process. Have few nit comments :)

docs/deprecation-process.md Outdated Show resolved Hide resolved
docs/deprecation-process.md Outdated Show resolved Hide resolved
docs/deprecation-process.md Outdated Show resolved Hide resolved
docs/deprecation-process.md Outdated Show resolved Hide resolved
docs/deprecation-process.md Show resolved Hide resolved
docs/deprecation-process.md Show resolved Hide resolved
marcalff and others added 3 commits January 20, 2023 13:51
Copy link
Member

@esigo esigo left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks for the PR :)

docs/deprecation-process.md Outdated Show resolved Hide resolved
@marcalff
Copy link
Member Author

Done with the last edits, now ready for formal review and merge.

Copy link
Member

@lalitb lalitb left a comment

Choose a reason for hiding this comment

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

@marcalff
Copy link
Member Author

LGTM. Nit: doc update for Jaeger deprecation -

* https://github.com/open-telemetry/opentelemetry-cpp/blob/main/exporters/jaeger/README.md

Thanks, fixed.

* https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/instrumentation/cpp/exporters.md#jaeger

Actually, this doc needs no changes.

The Jaeger Exporter is deprecated, not Jaeger itself.

This documentation is about setting up Jaeger, and sending traces using OTLP HTTP, which is not affected.

DEPRECATED.md Outdated Show resolved Hide resolved
DEPRECATED.md Outdated Show resolved Hide resolved
@lalitb
Copy link
Member

lalitb commented Jan 26, 2023

This documentation is about setting up Jaeger, and sending traces using OTLP HTTP, which is not affected.

Yes, didn't realize it is using OTLP exporter to send the traces.

@lalitb lalitb merged commit 1ae2fe5 into open-telemetry:main Jan 30, 2023
@marcalff marcalff deleted the doc_deprecation_process_1893 branch July 4, 2023 07:21
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.

[MAINTAINER DOC] Define and document a deprecation process [DEPRECATION] Deprecate jaeger exporter
5 participants