Skip to content

Commit bf28d41

Browse files
jtescherfrigus02
andauthored
Add logos and overview section to crate readmes (#311)
Co-authored-by: Jan Kühle <jkuehle90@gmail.com>
1 parent a0f92eb commit bf28d41

File tree

15 files changed

+187
-19
lines changed

15 files changed

+187
-19
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1-
# OpenTelemetry-Rust
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
5+
# OpenTelemetry Rust
6+
7+
The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
28

39
[![Crates.io: opentelemetry](https://img.shields.io/crates/v/opentelemetry.svg)](https://crates.io/crates/opentelemetry)
410
[![Documentation](https://docs.rs/opentelemetry/badge.svg)](https://docs.rs/opentelemetry)
5-
[![Crates.io](https://img.shields.io/crates/l/opentelemetry)](./LICENSE)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry)](./LICENSE)
612
[![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%3Amaster)
713
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
814

9-
The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
15+
[Website](https://opentelemetry.io/) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust) |
17+
[Documentation](https://docs.rs/opentelemetry)
18+
19+
## Overview
1020

11-
OpenTelemetry provides a single set of APIs, libraries, agents, and collector
12-
services to capture distributed traces and metrics from your application. You
13-
can analyze them using [Prometheus], [Jaeger], and other observability tools.
21+
OpenTelemetry is a collection of tools, APIs, and SDKs used to instrument,
22+
generate, collect, and export telemetry data (metrics, logs, and traces) for
23+
analysis in order to understand your software's performance and behavior. You
24+
can export and analyze them using [Prometheus], [Jaeger], and other
25+
observability tools.
1426

1527
*Compiler support: [requires `rustc` 1.42+][msrv]*
1628

assets/logo-text.png

12 KB
Loading

assets/logo.svg

+1
Loading

opentelemetry-contrib/README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Contrib
26

3-
Contrib repo for OpenTelemetry Rust implementation.
7+
Community supported vendor integrations for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-contrib](https://img.shields.io/crates/v/opentelemetry-contrib.svg)](https://crates.io/crates/opentelemetry-contrib)
10+
[![Documentation](https://docs.rs/opentelemetry-contrib/badge.svg)](https://docs.rs/opentelemetry-contrib)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-contrib)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-contrib) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior. This
23+
crate provides additional propagators and exporters for sending telemetry data
24+
to vendors like [`Datadog`].
25+
26+
[`Datadog`]: https://www.datadoghq.com/
27+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry

opentelemetry-contrib/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
unused
1515
)]
1616
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
17+
#![doc(
18+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
19+
)]
1720
#![cfg_attr(test, deny(warnings))]
1821

1922
#[cfg(feature = "datadog")]

opentelemetry-jaeger/README.md

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Jaeger
26

3-
Collects OpenTelemetry spans and reports them to a given Jaeger `agent` or
4-
`collector` endpoint. See the [Jaeger Docs] for details about Jaeger and
5-
deployment information.
7+
[`Jaeger`] integration for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-jaeger](https://img.shields.io/crates/v/opentelemetry-jaeger.svg)](https://crates.io/crates/opentelemetry-jaeger)
10+
[![Documentation](https://docs.rs/opentelemetry-jaeger/badge.svg)](https://docs.rs/opentelemetry-jaeger)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-jaeger)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-jaeger) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior. This
23+
crate provides a trace pipeline and exporter for sending span information to a
24+
Jaeger `agent` or `collector` endpoint for processing and visualization.
625

726
*Compiler support: [requires `rustc` 1.42+][msrv]*
827

9-
[Jaeger Docs]: https://www.jaegertracing.io/docs/
28+
[`Jaeger`]: https://www.jaegertracing.io/
29+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
1030
[msrv]: #supported-rust-versions
1131

1232
### Quickstart
@@ -35,7 +55,7 @@ fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
3555
}
3656
```
3757

38-
![Jaeger UI](trace.png)
58+
![Jaeger UI](https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/opentelemetry-jaeger/trace.png)
3959

4060
## Performance
4161

opentelemetry-jaeger/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,9 @@
167167
unused
168168
)]
169169
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
170+
#![doc(
171+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
172+
)]
170173
#![cfg_attr(test, deny(warnings))]
171174

172175
mod agent;

opentelemetry-otlp/README.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,37 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Collector Rust Exporter
26

3-
The OTLP Exporter supports exporting trace and metric data in the OTLP format to
4-
the OpenTelemetry collector. The OpenTelemetry Collector offers a
7+
[`OTLP`] integration for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-otlp](https://img.shields.io/crates/v/opentelemetry-otlp.svg)](https://crates.io/crates/opentelemetry-otlp)
10+
[![Documentation](https://docs.rs/opentelemetry-otlp/badge.svg)](https://docs.rs/opentelemetry-otlp)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-otlp)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-otlp) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior.
23+
24+
This crate provides an exporter for sending trace and metric data in the OTLP
25+
format to the OpenTelemetry collector. The OpenTelemetry Collector offers a
526
vendor-agnostic implementation on how to receive, process, and export telemetry
627
data. In addition, it removes the need to run, operate, and maintain multiple
728
agents/collectors in order to support open-source telemetry data formats (e.g.
829
Jaeger, Prometheus, etc.) sending to multiple open-source or commercial
930
back-ends.
1031

32+
[`OTLP`]: https://github.com/open-telemetry/opentelemetry-collector
33+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
34+
1135
## Quickstart
1236

1337
First make sure you have a running version of the opentelemetry collector you

opentelemetry-prometheus/README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Prometheus
26

3-
A Prometheus exporter implementation for OpenTelemetry Rust.
7+
[`Prometheus`] integration for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-prometheus](https://img.shields.io/crates/v/opentelemetry-prometheus.svg)](https://crates.io/crates/opentelemetry-prometheus)
10+
[![Documentation](https://docs.rs/opentelemetry-prometheus/badge.svg)](https://docs.rs/opentelemetry-prometheus)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-prometheus)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-prometheus) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior. This
23+
crate provides a pipeline and exporter for exposing metrics information to
24+
Prometheus for processing and visualization.
25+
26+
[`Prometheus`]: https://prometheus.io
27+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry

opentelemetry-prometheus/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@
5959
unused
6060
)]
6161
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
62+
#![doc(
63+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
64+
)]
6265
#![cfg_attr(test, deny(warnings))]
6366

6467
use opentelemetry::global;
+25-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Semantic Conventions
26

3-
OpenTelemetry semantic conventions are agreed standardized naming patterns for OpenTelemetry things. This crate aims to be the centralized place to interact with these conventions.
7+
Semantic conventions for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-semantic-conventions](https://img.shields.io/crates/v/opentelemetry-semantic-conventions.svg)](https://crates.io/crates/opentelemetry-semantic-conventions)
10+
[![Documentation](https://docs.rs/opentelemetry-semantic-conventions/badge.svg)](https://docs.rs/opentelemetry-semantic-conventions)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-semantic-conventions)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-semantic-conventions) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior. This
23+
crate provides standardized naming patterns for attributes, labels, and
24+
resources to help facilitate interoperability and compatibility with processing
25+
and visualization tools.
26+
27+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry

opentelemetry-semantic-conventions/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
unused
1414
)]
1515
#![cfg_attr(test, deny(warnings))]
16+
#![doc(
17+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
18+
)]
1619

1720
pub mod resource;
1821
pub mod trace;

opentelemetry-zipkin/README.md

+24-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
1+
![OpenTelemetry — An observability framework for cloud-native software.][splash]
2+
3+
[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo-text.png
4+
15
# OpenTelemetry Zipkin
26

3-
Collects OpenTelemetry spans and reports them to a given Zipkin collector
4-
endpoint. See the [Zipkin Docs] for details and deployment information.
7+
[`Zipkin`] integration for applications instrumented with [`OpenTelemetry`].
8+
9+
[![Crates.io: opentelemetry-zipkin](https://img.shields.io/crates/v/opentelemetry-zipkin.svg)](https://crates.io/crates/opentelemetry-zipkin)
10+
[![Documentation](https://docs.rs/opentelemetry-zipkin/badge.svg)](https://docs.rs/opentelemetry-zipkin)
11+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-zipkin)](./LICENSE)
12+
[![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%3Amaster)
13+
[![Gitter chat](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/open-telemetry/opentelemetry-rust)
14+
15+
[Documentation](https://docs.rs/opentelemetry-zipkin) |
16+
[Chat](https://gitter.im/open-telemetry/opentelemetry-rust)
17+
18+
## Overview
19+
20+
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
21+
generate, collect, and export telemetry data (metrics, logs, and traces) for
22+
analysis in order to understand your software's performance and behavior. This
23+
crate provides a trace pipeline and exporter for sending span information to a
24+
Zipkin collector for processing and visualization.
525

626
*Compiler support: [requires `rustc` 1.42+][msrv]*
727

8-
[Zipkin Docs]: https://zipkin.io/
28+
[`Zipkin`]: https://zipkin.io/
29+
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
930
[msrv]: #supported-rust-versions
1031

1132
## Quickstart

opentelemetry-zipkin/src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@
148148
unused
149149
)]
150150
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
151+
#![doc(
152+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
153+
)]
151154
#![cfg_attr(test, deny(warnings))]
152155

153156
#[macro_use]

src/lib.rs

+3
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
)]
5555
#![allow(clippy::needless_doctest_main)]
5656
#![cfg_attr(docsrs, feature(doc_cfg), deny(broken_intra_doc_links))]
57+
#![doc(
58+
html_logo_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/master/assets/logo.svg"
59+
)]
5760
#![cfg_attr(test, deny(warnings))]
5861

5962
mod api;

0 commit comments

Comments
 (0)