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

Added limitation in ot-shim readme #5072

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

Conversation

mercybassey
Copy link

Which problem is this PR solving?

This PR informs users that the OpenTracing shim doesn't include a scope manager.

Fixes #2700

Short description of the changes

This PR updates the OpenTracing shim Readme.md file by adding a limitation section; informing users that the OpenTracing shim doesn't include a scope manager.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

No test was created/run

Checklist:

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

@mercybassey mercybassey requested a review from a team as a code owner October 15, 2024 14:29
@mercybassey
Copy link
Author

Hi @pichlermarc I'd appreciate your review. Thanks.

Copy link
Member

@pichlermarc pichlermarc left a comment

Choose a reason for hiding this comment

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

thanks for working on this - a few suggestions as per my understanding of the issue.

packages/opentelemetry-shim-opentracing/README.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.27%. Comparing base (7ed67f9) to head (b6b06a1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5072      +/-   ##
==========================================
+ Coverage   93.26%   93.27%   +0.01%     
==========================================
  Files         317      317              
  Lines        8195     8195              
  Branches     1641     1641              
==========================================
+ Hits         7643     7644       +1     
+ Misses        552      551       -1     

see 1 file with indirect coverage changes

@mercybassey
Copy link
Author

thanks for working on this - a few suggestions as per my understanding of the issue.

@pichlermarc I have committed your suggestions. Thanks.

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