Skip to content

Commit 595ad05

Browse files
cijothomascijothomas
authored
Minor cleanups of readme files (#1785)
1 parent 426a1dd commit 595ad05

File tree

9 files changed

+112
-109
lines changed

9 files changed

+112
-109
lines changed

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@ body:
2121
id: api-version
2222
attributes:
2323
label: API Version
24-
description: What version of the OpenTelemetry API are you using?
24+
description: What version of the `opentelemetry` crate are you using?
2525
placeholder: 0.x, 1.x, etc.
2626
validations:
2727
required: true
2828
- type: textarea
2929
id: sdk-version
3030
attributes:
3131
label: SDK Version
32-
description: What version of the OpenTelemetry SDK are you using?
32+
description: What version of the `opentelemetry_sdk` crate are you using?
3333
placeholder: 0.x, 1.x, etc.
3434
validations:
3535
required: true
3636
- type: dropdown
3737
id: browsers
3838
attributes:
39-
label: What Exporters are you seeing the problem on?
39+
label: What Exporter(s) are you seeing the problem on?
4040
multiple: true
4141
options:
4242
- OTLP
4343
- Zipkin
44-
- Jaeger (Deprecated)
44+
- Prometheus
4545
- N/A
4646
- type: textarea
4747
id: logs

‎opentelemetry-appender-log/README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
1+
# OpenTelemetry Log Appender for `log` crate
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 Log Appender
6-
7-
A [Log Appender](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#log-appender--bridge) that bridges logs from the [log crate](https://docs.rs/log/latest/log/) to OpenTelemetry.
7+
This crate contains a [Log Appender](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#log-appender--bridge) that bridges logs from the [log crate](https://docs.rs/log/latest/log/) to OpenTelemetry.
88

99
[![Crates.io: opentelemetry-appender-log](https://img.shields.io/crates/v/opentelemetry-appender-log.svg)](https://crates.io/crates/opentelemetry-appender-log)
1010
[![Documentation](https://docs.rs/opentelemetry-appender-log/badge.svg)](https://docs.rs/opentelemetry-appender-log)
1111
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-appender-log)](./LICENSE)
1212
[![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)
1313
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1414

15-
## Overview
15+
## OpenTelemetry Overview
1616

17-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
18-
generate, collect, and export telemetry data (metrics, logs, and traces) for
19-
analysis in order to understand your software's performance and behavior. This
20-
crate provides additional propagators and exporters for sending telemetry data
21-
to vendors or using experimental propagators like `base64`.
17+
OpenTelemetry is an Observability framework and toolkit designed to create and
18+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
19+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
20+
Observability backends, including open source tools like [Jaeger] and
21+
[Prometheus], as well as commercial offerings.
2222

23-
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
23+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
24+
commercial vendors. OpenTelemetry is focused on the generation, collection,
25+
management, and export of telemetry. A major goal of OpenTelemetry is that you
26+
can easily instrument your applications or systems, no matter their language,
27+
infrastructure, or runtime environment. Crucially, the storage and visualization
28+
of telemetry is intentionally left to other tools.

‎opentelemetry-appender-tracing/README.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
1+
# OpenTelemetry Log Appender for `tracing` crate
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 Log Appender for Tracing
6-
7-
A [Log
7+
This crate contains a [Log
88
Appender](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#log-appender--bridge)
99
that bridges logs from the [tracing crate](https://tracing.rs/tracing/#events)
10-
to OpenTelemetry logs. Note that this is different from the existing
10+
to OpenTelemetry. Note that this is different from the existing
1111
[tracing-opentelemetry](https://github.com/tokio-rs/tracing-opentelemetry)
1212
project, which supports bridging traces and logs from tracing into OpenTelemetry
13-
traces. This is an experimental component, and could be merged with the
14-
tracing-opentelemetry crate itself.
13+
traces.
1514

1615
[![Crates.io: opentelemetry-appender-tracing](https://img.shields.io/crates/v/opentelemetry-appender-tracing.svg)](https://crates.io/crates/opentelemetry-appender-tracing)
1716
[![Documentation](https://docs.rs/opentelemetry-appender-tracing/badge.svg)](https://docs.rs/opentelemetry-appender-tracing)
1817
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-appender-tracing)](./LICENSE)
1918
[![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)
2019
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
2120

22-
## Overview
21+
## OpenTelemetry Overview
2322

24-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
25-
generate, collect, and export telemetry data (metrics, logs, and traces) for
26-
analysis in order to understand your software's performance and behavior. This
27-
crate provides additional propagators and exporters for sending telemetry data
28-
to vendors or using experimental propagators like `base64`.
23+
OpenTelemetry is an Observability framework and toolkit designed to create and
24+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
25+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
26+
Observability backends, including open source tools like [Jaeger] and
27+
[Prometheus], as well as commercial offerings.
2928

30-
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
29+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
30+
commercial vendors. OpenTelemetry is focused on the generation, collection,
31+
management, and export of telemetry. A major goal of OpenTelemetry is that you
32+
can easily instrument your applications or systems, no matter their language,
33+
infrastructure, or runtime environment. Crucially, the storage and visualization
34+
of telemetry is intentionally left to other tools.

‎opentelemetry-http/README.md

+20-27
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1+
# OpenTelemetry HTTP
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 HTTP
6-
7-
The Rust [OpenTelemetry](https://opentelemetry.io/) implementation.
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.
810

9-
[![LICENSE](https://img.shields.io/crates/l/opentelemetry)](./LICENSE)
11+
[![Crates.io: opentelemetry-http](https://img.shields.io/crates/v/opentelemetry-http.svg)](https://crates.io/crates/opentelemetry-http)
12+
[![Documentation](https://docs.rs/opentelemetry-http/badge.svg)](https://docs.rs/opentelemetry-http)
13+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-http)](./LICENSE)
1014
[![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)
1115
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1216

13-
## Overview
14-
15-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
16-
generate, collect, and export telemetry data (metrics, logs, and traces) for
17-
analysis in order to understand your software's performance and behavior. This
18-
crate provides a HTTP client interface for use by trace exporters, as well as
19-
helper types to inject and extract key value pairs into/from HTTP headers.
20-
21-
*Compiler support: [requires `rustc` 1.65+][msrv]*
22-
23-
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
24-
[msrv]: #supported-rust-versions
25-
26-
## Supported Rust Versions
17+
## OpenTelemetry Overview
2718

28-
OpenTelemetry is built against the latest stable release. The minimum supported
29-
version is 1.65. The current OpenTelemetry version is not guaranteed to build
30-
on Rust versions earlier than the minimum supported version.
19+
OpenTelemetry is an Observability framework and toolkit designed to create and
20+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
21+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
22+
Observability backends, including open source tools like [Jaeger] and
23+
[Prometheus], as well as commercial offerings.
3124

32-
The current stable Rust compiler and the three most recent minor versions
33-
before it will always be supported. For example, if the current stable compiler
34-
version is 1.49, the minimum supported version will not be increased past 1.46,
35-
three minor versions prior. Increasing the minimum supported compiler version
36-
is not considered a semver breaking change as long as doing so complies with
37-
this policy.
25+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
26+
commercial vendors. OpenTelemetry is focused on the generation, collection,
27+
management, and export of telemetry. A major goal of OpenTelemetry is that you
28+
can easily instrument your applications or systems, no matter their language,
29+
infrastructure, or runtime environment. Crucially, the storage and visualization
30+
of telemetry is intentionally left to other tools.

‎opentelemetry-jaeger-propagator/README.md

+20-29
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,30 @@
1+
# OpenTelemetry Jaeger Propagator
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 Jaeger Propagator
6-
7-
[`Jaeger`] propagator integration for applications instrumented with [`OpenTelemetry`]. To export telemetry to Jaeger, use the opentelemetry-otlp crate.
7+
This crate contains [`Jaeger`] propagator integration for applications
8+
instrumented with [`OpenTelemetry`]. To export telemetry to Jaeger, use the
9+
opentelemetry-otlp crate.
810

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)
11+
[![Crates.io: opentelemetry-jaeger-propagator](https://img.shields.io/crates/v/opentelemetry-jaeger-propagator.svg)](https://crates.io/crates/opentelemetry-jaeger-propagator)
12+
[![Documentation](https://docs.rs/opentelemetry-jaeger-propagator/badge.svg)](https://docs.rs/opentelemetry-jaeger-propagator)
13+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-jaeger-propagator)](./LICENSE)
1214
[![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)
1315
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1416

15-
## Overview
16-
17-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
18-
generate, collect, and export telemetry data (metrics, logs, and traces) for
19-
analysis in order to understand your software's performance and behavior. This
20-
crate provides the ability to create and interact with a Jaeger propagator.
21-
22-
*Compiler support: [requires `rustc` 1.65+][msrv]*
23-
24-
[`Jaeger`]: https://www.jaegertracing.io/
25-
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
26-
[msrv]: #supported-rust-versions
27-
28-
## Supported Rust Versions
17+
## OpenTelemetry Overview
2918

30-
OpenTelemetry is built against the latest stable release. The minimum supported
31-
version is 1.65. The current OpenTelemetry version is not guaranteed to build
32-
on Rust versions earlier than the minimum supported version.
19+
OpenTelemetry is an Observability framework and toolkit designed to create and
20+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
21+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
22+
Observability backends, including open source tools like [Jaeger] and
23+
[Prometheus], as well as commercial offerings.
3324

34-
The current stable Rust compiler and the three most recent minor versions
35-
before it will always be supported. For example, if the current stable compiler
36-
version is 1.49, the minimum supported version will not be increased past 1.46,
37-
three minor versions prior. Increasing the minimum supported compiler version
38-
is not considered a semver breaking change as long as doing so complies with
39-
this policy.
25+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
26+
commercial vendors. OpenTelemetry is focused on the generation, collection,
27+
management, and export of telemetry. A major goal of OpenTelemetry is that you
28+
can easily instrument your applications or systems, no matter their language,
29+
infrastructure, or runtime environment. Crucially, the storage and visualization
30+
of telemetry is intentionally left to other tools.

‎opentelemetry-prometheus/README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
# OpenTelemetry Prometheus Exporter
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 Prometheus
6-
77
[`Prometheus`] integration for applications instrumented with [`OpenTelemetry`].
88

99
[![Crates.io: opentelemetry-prometheus](https://img.shields.io/crates/v/opentelemetry-prometheus.svg)](https://crates.io/crates/opentelemetry-prometheus)
@@ -12,13 +12,20 @@
1212
[![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)
1313
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1414

15-
## Overview
15+
## OpenTelemetry Overview
16+
17+
OpenTelemetry is an Observability framework and toolkit designed to create and
18+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
19+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
20+
Observability backends, including open source tools like [Jaeger] and
21+
[Prometheus], as well as commercial offerings.
1622

17-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
18-
generate, collect, and export telemetry data (metrics, logs, and traces) for
19-
analysis in order to understand your software's performance and behavior. This
20-
crate provides a pipeline and exporter for exposing metrics information to
21-
Prometheus for processing and visualization.
23+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
24+
commercial vendors. OpenTelemetry is focused on the generation, collection,
25+
management, and export of telemetry. A major goal of OpenTelemetry is that you
26+
can easily instrument your applications or systems, no matter their language,
27+
infrastructure, or runtime environment. Crucially, the storage and visualization
28+
of telemetry is intentionally left to other tools.
2229

2330
[`Prometheus`]: https://prometheus.io
2431
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry

‎opentelemetry-sdk/src/trace/span_processor.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
//! +-----+--------------+ +-----------------------+ +-------------------+
2121
//! | | | | | | |
2222
//! | | | | (Batch)SpanProcessor | | SpanExporter |
23-
//! | | +---> (Simple)SpanProcessor +---> (JaegerExporter) |
23+
//! | | +---> (Simple)SpanProcessor +---> (OTLPExporter) |
2424
//! | | | | | | |
2525
//! | SDK | Tracer.span()| +-----------------------+ +-------------------+
2626
//! | | Span.end() |
27-
//! | | | +---------------------+
28-
//! | | | | |
29-
//! | | +---> ZPagesProcessor |
30-
//! | | | | |
31-
//! +-----+--------------+ +---------------------+
27+
//! | | |
28+
//! | | |
29+
//! | | |
30+
//! | | |
31+
//! +-----+--------------+
3232
//! ```
3333
//!
3434
//! [`is_recording`]: opentelemetry::trace::Span::is_recording()

‎opentelemetry-zipkin/README.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
# OpenTelemetry Zipkin Exporter
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 Zipkin
6-
77
[`Zipkin`] integration for applications instrumented with [`OpenTelemetry`].
88

99
[![Crates.io: opentelemetry-zipkin](https://img.shields.io/crates/v/opentelemetry-zipkin.svg)](https://crates.io/crates/opentelemetry-zipkin)
@@ -12,20 +12,23 @@
1212
[![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)
1313
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
1414

15+
## OpenTelemetry Overview
1516

16-
## Overview
17-
18-
[`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument,
19-
generate, collect, and export telemetry data (metrics, logs, and traces) for
20-
analysis in order to understand your software's performance and behavior. This
21-
crate provides a trace pipeline and exporter for sending span information to a
22-
Zipkin collector for processing and visualization.
17+
OpenTelemetry is an Observability framework and toolkit designed to create and
18+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
19+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
20+
Observability backends, including open source tools like [Jaeger] and
21+
[Prometheus], as well as commercial offerings.
2322

24-
*Compiler support: [requires `rustc` 1.65+][msrv]*
23+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
24+
commercial vendors. OpenTelemetry is focused on the generation, collection,
25+
management, and export of telemetry. A major goal of OpenTelemetry is that you
26+
can easily instrument your applications or systems, no matter their language,
27+
infrastructure, or runtime environment. Crucially, the storage and visualization
28+
of telemetry is intentionally left to other tools.
2529

2630
[`Zipkin`]: https://zipkin.io/
2731
[`OpenTelemetry`]: https://crates.io/crates/opentelemetry
28-
[msrv]: #supported-rust-versions
2932

3033
## Quickstart
3134

‎RELEASING.md ‎scripts/RELEASING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ A draft PR can be created, but before releasing consider the following:
4242
5. [Publish](#publishing-crates) to crates.io using the version as of the release commit
4343
6. Post to [#otel-rust](https://cloud-native.slack.com/archives/C03GDP0H023) on CNCF Slack.
4444

45-
[Publish.sh](./scripts/publish.sh) may be used to automate steps 3 and 5.
45+
[Publish.sh](./publish.sh) may be used to automate steps 3 and 5.
4646

4747
## Tagging Convention
4848

0 commit comments

Comments
 (0)