Skip to content

Commit 7da8d44

Browse files
Copilotcijothomas
andcommitted
Enhance README consistency across OpenTelemetry components
Co-authored-by: cijothomas <[email protected]>
1 parent e5acfc5 commit 7da8d44

File tree

5 files changed

+101
-13
lines changed

5 files changed

+101
-13
lines changed

opentelemetry-appender-log/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,28 @@ can easily instrument your applications or systems, no matter their language,
2727
infrastructure, or runtime environment. Crucially, the storage and visualization
2828
of telemetry is intentionally left to other tools.
2929

30+
*[Supported Rust Versions](#supported-rust-versions)*
31+
32+
[Prometheus]: https://prometheus.io
33+
[Jaeger]: https://www.jaegertracing.io
34+
35+
## Getting started
36+
37+
See [docs](https://docs.rs/opentelemetry-appender-log).
38+
3039
## Release Notes
3140

3241
You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-appender-log/CHANGELOG.md).
42+
43+
## Supported Rust Versions
44+
45+
OpenTelemetry is built against the latest stable release. The minimum supported
46+
version is 1.75.0. The current OpenTelemetry version is not guaranteed to build
47+
on Rust versions earlier than the minimum supported version.
48+
49+
The current stable Rust compiler and the three most recent minor versions
50+
before it will always be supported. For example, if the current stable compiler
51+
version is 1.49, the minimum supported version will not be increased past 1.46,
52+
three minor versions prior. Increasing the minimum supported compiler version
53+
is not considered a semver breaking change as long as doing so complies with
54+
this policy.

opentelemetry-http/README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@
44

55
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
66

7-
This crate contains helper implementations for sending HTTP requests. Uses
8-
include propagating and extracting context over http, exporting telemetry,
9-
requesting sampling strategies.
7+
This crate contains helper implementations for sending HTTP requests with
8+
[OpenTelemetry](https://opentelemetry.io/) integration. Uses include propagating
9+
and extracting context over HTTP, exporting telemetry data, and requesting
10+
sampling strategies.
1011

1112
[![Crates.io: opentelemetry-http](https://img.shields.io/crates/v/opentelemetry-http.svg)](https://crates.io/crates/opentelemetry-http)
1213
[![Documentation](https://docs.rs/opentelemetry-http/badge.svg)](https://docs.rs/opentelemetry-http)
1314
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-http)](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-http/LICENSE)
1415
[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain)
1516
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1617

17-
## OpenTelemetry Overview
18+
## Overview
1819

1920
OpenTelemetry is an Observability framework and toolkit designed to create and
2021
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
@@ -31,6 +32,40 @@ of telemetry is intentionally left to other tools.
3132

3233
*[Supported Rust Versions](#supported-rust-versions)*
3334

35+
[Prometheus]: https://prometheus.io
36+
[Jaeger]: https://www.jaegertracing.io
37+
38+
### What does this crate contain?
39+
40+
This crate provides HTTP utilities and integrations for OpenTelemetry,
41+
including:
42+
43+
- **Context Propagation**: Helper implementations for propagating and extracting
44+
OpenTelemetry context over HTTP headers, enabling distributed tracing across
45+
service boundaries.
46+
- **HTTP Client Support**: Integration with popular HTTP clients like `reqwest`
47+
and `hyper` for automatic instrumentation and context propagation.
48+
- **Exporter Utilities**: Common HTTP functionality used by exporters to send
49+
telemetry data to collection endpoints.
50+
- **Sampling Strategy Support**: Helper functions for requesting sampling
51+
strategies from remote endpoints.
52+
53+
This crate is typically used as a dependency by other OpenTelemetry components
54+
rather than directly by end users, though it can be useful for custom
55+
instrumentation scenarios.
56+
57+
### Related crates
58+
59+
This crate is commonly used alongside:
60+
61+
- **[opentelemetry](https://crates.io/crates/opentelemetry):** The core OpenTelemetry API.
62+
- **[opentelemetry-sdk](https://crates.io/crates/opentelemetry-sdk):** The OpenTelemetry SDK implementation.
63+
- **[opentelemetry-otlp](https://crates.io/crates/opentelemetry-otlp):** OTLP exporter that uses this crate for HTTP transport.
64+
65+
## Getting started
66+
67+
See [docs](https://docs.rs/opentelemetry-http).
68+
3469
## Release Notes
3570

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

opentelemetry-proto/README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
1+
# OpenTelemetry Proto
2+
13
![OpenTelemetry — An observability framework for cloud-native software.][splash]
24

35
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
46

5-
# OpenTelemetry Proto
6-
This crate contains generated files from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
7-
repository and transformation between types from generated files and types defined in [opentelemetry](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry).
7+
This crate contains generated Rust code from the
8+
[opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
9+
repository and provides transformation functions between the generated protobuf
10+
types and the types defined in the
11+
[opentelemetry](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry)
12+
API crate.
13+
14+
[![Crates.io: opentelemetry-proto](https://img.shields.io/crates/v/opentelemetry-proto.svg)](https://crates.io/crates/opentelemetry-proto)
15+
[![Documentation](https://docs.rs/opentelemetry-proto/badge.svg)](https://docs.rs/opentelemetry-proto)
16+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-proto)](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-proto/LICENSE)
17+
[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain)
18+
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
819

920
*[Supported Rust Versions](#supported-rust-versions)*
1021

22+
## Getting started
23+
24+
See [docs](https://docs.rs/opentelemetry-proto).
25+
1126
## Release Notes
1227

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

opentelemetry-semantic-conventions/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ and visualization tools.
2525

2626
*[Supported Rust Versions](#supported-rust-versions)*
2727

28+
## Getting started
29+
30+
See [docs](https://docs.rs/opentelemetry-semantic-conventions).
31+
2832
## Release Notes
2933

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

opentelemetry-stdout/README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
66

77
This crate contains an [OpenTelemetry](https://opentelemetry.io/) exporter that
8-
prints telemetry (logs, metrics and traces) to the standard output.
8+
outputs telemetry data (logs, metrics, and traces) to standard output in a
9+
human-readable format. It is designed for educational purposes, debugging, and
10+
development workflows where you want to quickly inspect telemetry data without
11+
setting up external observability infrastructure.
912

1013
[![Crates.io: opentelemetry-stdout](https://img.shields.io/crates/v/opentelemetry-stdout.svg)](https://crates.io/crates/opentelemetry-stdout)
1114
[![Documentation](https://docs.rs/opentelemetry-stdout/badge.svg)](https://docs.rs/opentelemetry-stdout)
@@ -36,11 +39,20 @@ of telemetry is intentionally left to other tools.
3639

3740
### What does this crate contain?
3841

39-
This crate includes exporters that support all three signals - Logs, Metrics,
40-
and Traces — to standard output. It is intended solely for educational and
41-
debugging purposes. Please note, this crate is not optimized for performance,
42-
and the format of the output may change, making it unsuitable for production
43-
environments
42+
This crate provides exporters that support all three OpenTelemetry signals:
43+
44+
- **Trace Exporter**: Outputs distributed tracing data showing request flows
45+
and timing information across services.
46+
- **Metrics Exporter**: Outputs measurement data such as counters, gauges, and
47+
histograms for monitoring application performance.
48+
- **Logs Exporter**: Outputs structured log data with OpenTelemetry context
49+
information.
50+
51+
All exporters format the telemetry data in a human-readable way and write it to
52+
standard output. This crate is intended solely for educational and debugging
53+
purposes. Please note, this crate is not optimized for performance, and the
54+
format of the output may change, making it unsuitable for production
55+
environments.
4456

4557
## Getting started
4658

0 commit comments

Comments
 (0)