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 basic doc comments for opentelemetry-http #1528

Merged
merged 3 commits into from
Feb 14, 2024

Conversation

cijothomas
Copy link
Member

Basic doc comments, as it was never clear what was the purpose of opentelemetry-http crate.
Related issue #1427 (This PR is in no way fixing that issue!)

@cijothomas cijothomas requested a review from a team as a code owner February 13, 2024 03:56
@@ -7,6 +7,10 @@ pub use bytes::Bytes;
pub use http::{Request, Response};
use opentelemetry::propagation::{Extractor, Injector};

/// Helper for injecting headers into HTTP Requests. This is used for OpenTelemetry context
Copy link
Member Author

Choose a reason for hiding this comment

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

From a quick glance, this can be moved out to its own crate, as this does not require any particular httpclient implementation, so can move quickly.

Would it help anyone if we move this to own crate? I guess there are users who need this part (for context propagation over http), but does not need an exporting mechanism over http (as they can use alternatives like gRPC)?

Copy link
Member Author

Choose a reason for hiding this comment

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

@TommyCpp suggested its better to keep crate count low, but we can achieve this via feature flags.. Will have to follow up separately for that.

Copy link

codecov bot commented Feb 13, 2024

Codecov Report

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

Comparison is base (8688e7e) 61.8% compared to head (3731667) 61.9%.
Report is 5 commits behind head on main.

Files Patch % Lines
opentelemetry-sdk/src/metrics/periodic_reader.rs 92.3% 4 Missing ⚠️
opentelemetry-sdk/src/logs/log_emitter.rs 90.9% 1 Missing ⚠️
opentelemetry/src/logs/noop.rs 0.0% 1 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##            main   #1528   +/-   ##
=====================================
  Coverage   61.8%   61.9%           
=====================================
  Files        144     144           
  Lines      19810   19862   +52     
=====================================
+ Hits       12256   12303   +47     
- Misses      7554    7559    +5     

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

@cijothomas cijothomas merged commit 49f1be6 into open-telemetry:main Feb 14, 2024
14 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.

None yet

2 participants