Skip to content

Commit 6f990f5

Browse files
Copilotcijothomas
andcommitted
Update README consistency for remaining OpenTelemetry crates
Co-authored-by: cijothomas <[email protected]>
1 parent 7da8d44 commit 6f990f5

File tree

5 files changed

+87
-1
lines changed

5 files changed

+87
-1
lines changed

opentelemetry-appender-tracing/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ of telemetry is intentionally left to other tools.
3535

3636
*[Supported Rust Versions](#supported-rust-versions)*
3737

38+
### What does this crate contain?
39+
40+
This crate provides a bridge for integrating the [tracing crate](https://tracing.rs/) with OpenTelemetry's logging pipeline. It includes:
41+
42+
- **Log Appender**: A component that captures log events from tracing and forwards them to OpenTelemetry's logging system
43+
- **Event Bridge**: Converts tracing events into OpenTelemetry log records while preserving metadata and context
44+
- **Integration Support**: Seamless integration with existing tracing-based applications to enable OpenTelemetry log collection
45+
46+
This appender is specifically designed for scenarios where you want to collect logs through OpenTelemetry while using the tracing crate for instrumentation.
47+
48+
## Getting started
49+
50+
See the [docs](https://docs.rs/opentelemetry-appender-tracing) for detailed examples and API reference.
51+
3852
## Release Notes
3953

4054
You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-appender-tracing/CHANGELOG.md).

opentelemetry-jaeger-propagator/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,21 @@ of telemetry is intentionally left to other tools.
3131

3232
*[Supported Rust Versions](#supported-rust-versions)*
3333

34+
### What does this crate contain?
35+
36+
This crate provides Jaeger-specific context propagation for OpenTelemetry applications. It includes:
37+
38+
- **Jaeger Propagator**: Implementation of Jaeger's text map propagation format for distributed tracing
39+
- **Context Extraction**: Ability to extract Jaeger trace context from HTTP headers and other carriers
40+
- **Context Injection**: Functionality to inject OpenTelemetry trace context into Jaeger format for downstream services
41+
- **Legacy Compatibility**: Support for applications that need to interoperate with existing Jaeger-instrumented services
42+
43+
Note: This crate is specifically for context propagation. To export telemetry data to Jaeger, use the `opentelemetry-otlp` crate.
44+
45+
## Getting started
46+
47+
See the [docs](https://docs.rs/opentelemetry-jaeger-propagator) for detailed examples and API reference.
48+
3449
## Release Notes
3550

3651
You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-jaeger-propagator/CHANGELOG.md).

opentelemetry-otlp/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ of telemetry is intentionally left to other tools.
3535
[Prometheus]: https://prometheus.io
3636
[Jaeger]: https://www.jaegertracing.io
3737

38+
### What does this crate contain?
39+
40+
This crate provides OTLP (OpenTelemetry Protocol) exporter implementations for sending telemetry data to OTLP-compatible backends. It includes:
41+
42+
- **Trace Exporter**: Export distributed tracing data in OTLP format
43+
- **Metrics Exporter**: Export metrics data to OTLP endpoints
44+
- **Logs Exporter**: Export log data using the OTLP protocol
45+
- **HTTP Transport**: Send telemetry over HTTP/1.1 and HTTP/2 with configurable compression
46+
- **gRPC Transport**: Send telemetry using gRPC protocol for high-performance scenarios
47+
- **Authentication Support**: Built-in support for various authentication mechanisms (headers, mTLS, etc.)
48+
- **Batch Processing**: Efficient batching and retry mechanisms for reliable telemetry delivery
49+
50+
The OTLP format is the recommended way to export telemetry as it's vendor-neutral and supported by many observability backends including Jaeger, Prometheus, and commercial vendors.
51+
3852
## Getting started
3953

4054
See [docs](https://docs.rs/opentelemetry-otlp).

opentelemetry-prometheus/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,36 @@ of telemetry is intentionally left to other tools.
4444
[`Prometheus`]: https://prometheus.io
4545
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
4646

47+
### What does this crate contain?
48+
49+
**⚠️ This crate is deprecated and no longer recommended for use.**
50+
51+
This crate previously provided direct Prometheus metrics export functionality, but has been discontinued due to:
52+
- Dependency on unmaintained `protobuf` crate
53+
- Unresolved security vulnerabilities
54+
- Limited maintenance resources
55+
56+
For new projects, use the [OTLP exporter](https://docs.rs/opentelemetry-otlp/) instead, as Prometheus now natively supports OTLP.
57+
58+
## Getting started
59+
60+
**For new projects:** Use the [opentelemetry-otlp](https://docs.rs/opentelemetry-otlp/) crate instead. See the [Prometheus OTLP documentation](https://prometheus.io/docs/guides/opentelemetry/#enable-the-otlp-receiver) for integration details.
61+
62+
**For existing projects:** See the [docs](https://docs.rs/opentelemetry-prometheus) for legacy API reference, but plan migration to OTLP.
63+
4764
## Release Notes
4865

4966
You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-prometheus/CHANGELOG.md).
67+
68+
## Supported Rust Versions
69+
70+
OpenTelemetry is built against the latest stable release. The minimum supported
71+
version is 1.75.0. The current OpenTelemetry version is not guaranteed to build
72+
on Rust versions earlier than the minimum supported version.
73+
74+
The current stable Rust compiler and the three most recent minor versions
75+
before it will always be supported. For example, if the current stable compiler
76+
version is 1.49, the minimum supported version will not be increased past 1.46,
77+
three minor versions prior. Increasing the minimum supported compiler version
78+
is not considered a semver breaking change as long as doing so complies with
79+
this policy.

opentelemetry-zipkin/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,20 @@ of telemetry is intentionally left to other tools.
3232

3333
*[Supported Rust Versions](#supported-rust-versions)*
3434

35-
## Quickstart
35+
### What does this crate contain?
36+
37+
This crate provides a Zipkin exporter for OpenTelemetry trace data. It includes:
38+
39+
- **Zipkin Exporter**: Export OpenTelemetry traces to Zipkin-compatible backends
40+
- **HTTP Transport**: Send trace data via HTTP/JSON to Zipkin endpoints
41+
- **Span Conversion**: Convert OpenTelemetry spans to Zipkin's data model while preserving trace relationships
42+
- **Batch Processing**: Efficient batching of spans for optimized network usage
43+
- **HTTP Client Flexibility**: Support for multiple HTTP client implementations (reqwest, surf, etc.)
44+
- **Async Support**: Full async/await compatibility for non-blocking telemetry export
45+
46+
Note: This exporter only supports traces. For metrics and logs, use the OTLP exporter or other appropriate exporters.
47+
48+
## Getting started
3649

3750
First make sure you have a running version of the zipkin process you want to
3851
send data to:

0 commit comments

Comments
 (0)