Skip to content

Improve README formatting consistency across repository #2

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Improve README formatting consistency across repository #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67c4750
Initial plan
Copilot Jun 27, 2025
7b5f9fd
Fix README formatting issues
Copilot Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# OpenTelemetry Rust

![OpenTelemetry — An observability framework for cloud-native software.][splash]

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

The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.

[![Crates.io: opentelemetry](https://img.shields.io/crates/v/opentelemetry.svg)](https://crates.io/crates/opentelemetry)
Expand Down Expand Up @@ -98,15 +102,15 @@ The following crates are maintained in this repo:
[Prometheus](https://prometheus.io/docs/prometheus/latest/feature_flags/#otlp-receiver)
or [vendor specific endpoints](https://opentelemetry.io/ecosystem/vendors/).
* [`opentelemetry-stdout`] exporter for sending logs, metrics and traces to
stdout, for learning/debugging purposes.
stdout, for learning/debugging purposes.
* [`opentelemetry-http`] This crate contains utility functions to help with
exporting telemetry, propagation, over [`http`].
* [`opentelemetry-appender-log`] This crate provides logging appender to route
logs emitted using the [log](https://docs.rs/log/latest/log/) crate to
opentelemetry.
* [`opentelemetry-appender-tracing`] This crate provides logging appender to
route logs emitted using the [tracing](https://crates.io/crates/tracing) crate
to opentelemetry.
to opentelemetry.
* [`opentelemetry-jaeger-propagator`] provides context propagation using [jaeger
propagation
format](https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format).
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

This directory contains some examples that should help you get start crates from `opentelemetry-rust`.
This directory contains some examples that should help you get started with crates from `opentelemetry-rust`.

## log-basic

Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-otlp/tests/integration_test/actual/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Output from the otel-collector goes here.
Output from the otel-collector goes here.
4 changes: 2 additions & 2 deletions opentelemetry-prometheus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

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

[`Prometheus`] integration for applications instrumented with [`OpenTelemetry`].
[`Prometheus`] integration for applications instrumented with [`OpenTelemetry`].

**The development of prometheus exporter has halt until the Opentelemetry metrics API and SDK reaches 1.0. Current
**The development of prometheus exporter has halt until the Opentelemetry metrics API and SDK reaches 1.0. Current
implementation is based on Opentelemetry API and SDK 0.27**.

[![Crates.io: opentelemetry-prometheus](https://img.shields.io/crates/v/opentelemetry-prometheus.svg)](https://crates.io/crates/opentelemetry-prometheus)
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-zipkin/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Sends spans to a zipkin-compatible collector.

## Usage
## Usage

First run the zipkin collector:

Expand Down