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

Add documentation for scope manager omission (ot-shim: document the omission of scope manager #2700) #5039

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Asheklm6
Copy link

@Asheklm6 Asheklm6 commented Oct 4, 2024

Which problem is this PR solving?

This PR addresses the missing documentation related to the omission of the "Scope Manager" in the OpenTelemetry shim for OpenTracing. The scope manager was never implemented, and this PR adds a note about that omission to inform developers.

Fixes #2700.

Short description of the changes

  • Added a new documentation file (SCOPE_MANAGER_OMISSION.md) that describes the omission of the scope manager in the OpenTelemetry shim for OpenTracing.
  • The documentation informs developers that there is no support for a scope manager and provides context to avoid confusion.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

This is a documentation-only change, so no tests were required.

  • No code changes to test

Checklist:

  • Followed the style guidelines of this project
  • [] Unit tests have been added (Not applicable since it's a documentation update)
  • Documentation has been updated

@Asheklm6 Asheklm6 requested a review from a team as a code owner October 4, 2024 08:49
Copy link

linux-foundation-easycla bot commented Oct 4, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@pichlermarc
Copy link
Member

@Asheklm6 thanks for opening this PR. 🙂

Would you mind adding this documentation to packages/opentelemetry-shim-opentracing/README.md instead?
I think there it could be more visible to users.

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.27%. Comparing base (f8ab559) to head (a29d35c).
Report is 28 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5039      +/-   ##
==========================================
- Coverage   93.39%   93.27%   -0.13%     
==========================================
  Files          46      317     +271     
  Lines         712     8194    +7482     
  Branches      120     1640    +1520     
==========================================
+ Hits          665     7643    +6978     
- Misses         47      551     +504     

see 266 files with indirect coverage changes

@Asheklm6
Copy link
Author

Asheklm6 commented Oct 4, 2024 via email

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

Successfully merging this pull request may close these issues.

ot-shim: document the omission of scope manager
2 participants