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

Enable doc generation for testing module for InMemory*Exporters. #1503

Merged
merged 8 commits into from Feb 1, 2024

Conversation

lalitb
Copy link
Member

@lalitb lalitb commented Jan 31, 2024

Fixes #1466
Design discussion issue (if applicable) #

Changes

Enable doc generation for InMemory*Exporter when built with the testing feature. As it should be possible for users to use these exporters for testing purpose.

The screenshot of the doc from this PR:
image

image

Please provide a brief description of the changes here.

Merge requirement checklist

  • CONTRIBUTING guidelines followed
  • Unit tests added/updated (if applicable)
  • Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
  • Changes in public API reviewed (if applicable)

@lalitb lalitb requested a review from a team as a code owner January 31, 2024 01:13
Copy link

codecov bot commented Jan 31, 2024

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (d4a6b3e) 63.8% compared to head (fc02a9f) 63.7%.
Report is 1 commits behind head on main.

Files Patch % Lines
...ntelemetry-sdk/src/testing/trace/span_exporters.rs 80.8% 18 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##            main   #1503     +/-   ##
=======================================
- Coverage   63.8%   63.7%   -0.1%     
=======================================
  Files        144     144             
  Lines      19983   19983             
=======================================
- Hits       12750   12741      -9     
- Misses      7233    7242      +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@hdost hdost left a comment

Choose a reason for hiding this comment

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

Looks good for the most part will have to run docs locally to double check.

@lalitb
Copy link
Member Author

lalitb commented Jan 31, 2024

Looks good for the most part will have to run docs locally to double check.

Yes agree, have validated locally and shared the screenshot of the generated docs in the PR description.

@cijothomas
Copy link
Member

Looks good for the most part will have to run docs locally to double check.

Okay to merge?

Copy link
Contributor

@TommyCpp TommyCpp left a comment

Choose a reason for hiding this comment

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

testing used to be a collection of helpers that used by other crates in this repo for unit tests. I understand it maybe helpful to open it up so users can test their custom exporters. But I think we should make sure every helper has basic documentation before merging this

@lalitb
Copy link
Member Author

lalitb commented Feb 1, 2024

testing used to be a collection of helpers that used by other crates in this repo for unit tests. I understand it maybe helpful to open it up so users can test their custom exporters. But I think we should make sure every helper has basic documentation before merging this

Currently, only the memory exporters are made open for external users, as required by the specs. Apart from that, the testing module has TestSpanExporter and TestMetricReader. I believe it should be possible to replace them in unit-tests with the in-memory exporters as separate PR. So kept their docs hidden. Let me know if there are other thoughts.

Copy link
Contributor

@TommyCpp TommyCpp left a comment

Choose a reason for hiding this comment

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

Sounds good! Thanks for fixing it

@cijothomas cijothomas merged commit 57c3aa3 into open-telemetry:main Feb 1, 2024
15 checks passed
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.

[Feature]: Add an Arc to ManualReader or make SharedReader public
4 participants