Skip to content

Commit 49f1be6

Browse files
authored
Add basic doc comments for opentelemetry-http (#1528)
1 parent 64b11e0 commit 49f1be6

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@
44
**/*.rs.bk
55
Cargo.lock
66
/.idea/
7+
8+
.cosine

opentelemetry-http/Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[package]
22
name = "opentelemetry-http"
33
version = "0.10.0"
4-
description = "Helper implementations for exchange of traces and metrics over HTTP"
4+
description = "Helper implementations for sending HTTP requests. Uses include propagating and extracting context over http, exporting telemetry, requesting sampling strategies."
55
homepage = "https://github.com/open-telemetry/opentelemetry-rust"
66
repository = "https://github.com/open-telemetry/opentelemetry-rust"
7-
keywords = ["opentelemetry", "tracing", "metrics"]
7+
keywords = ["opentelemetry", "tracing", "context", "propagation"]
88
license = "Apache-2.0"
99
edition = "2021"
1010
rust-version = "1.65"

opentelemetry-http/src/lib.rs

+11-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ pub use bytes::Bytes;
77
pub use http::{Request, Response};
88
use opentelemetry::propagation::{Extractor, Injector};
99

10+
/// Helper for injecting headers into HTTP Requests. This is used for OpenTelemetry context
11+
/// propagation over HTTP.
12+
/// See [this](https://github.com/open-telemetry/opentelemetry-rust/blob/main/examples/tracing-http-propagator/README.md)
13+
/// for example usage.
1014
pub struct HeaderInjector<'a>(pub &'a mut http::HeaderMap);
1115

1216
impl<'a> Injector for HeaderInjector<'a> {
@@ -20,6 +24,10 @@ impl<'a> Injector for HeaderInjector<'a> {
2024
}
2125
}
2226

27+
/// Helper for extracting headers from HTTP Requests. This is used for OpenTelemetry context
28+
/// propagation over HTTP.
29+
/// See [this](https://github.com/open-telemetry/opentelemetry-rust/blob/main/examples/tracing-http-propagator/README.md)
30+
/// for example usage.
2331
pub struct HeaderExtractor<'a>(pub &'a http::HeaderMap);
2432

2533
impl<'a> Extractor for HeaderExtractor<'a> {
@@ -39,7 +47,9 @@ impl<'a> Extractor for HeaderExtractor<'a> {
3947

4048
pub type HttpError = Box<dyn std::error::Error + Send + Sync + 'static>;
4149

42-
/// A minimal interface necessary for export spans over HTTP.
50+
/// A minimal interface necessary for sending requests over HTTP.
51+
/// Used primarily for exporting telemetry over HTTP. Also used for fetching
52+
/// sampling strategies for JaegerRemoteSampler
4353
///
4454
/// Users sometime choose HTTP clients that relay on a certain async runtime. This trait allows
4555
/// users to bring their choice of HTTP client.

0 commit comments

Comments
 (0)