forked from open-telemetry/opentelemetry-rust
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor cleanups of readme files (open-telemetry#1785)
- Loading branch information
1 parent
426a1dd
commit 595ad05
Showing
9 changed files
with
112 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,28 @@ | ||
| # OpenTelemetry Log Appender for `log` crate | ||
|
|
||
| ![OpenTelemetry — An observability framework for cloud-native software.][splash] | ||
|
|
||
| [splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png | ||
|
|
||
| # OpenTelemetry Log Appender | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| [](https://crates.io/crates/opentelemetry-appender-log) | ||
| [](https://docs.rs/opentelemetry-appender-log) | ||
| [](./LICENSE) | ||
| [](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain) | ||
| [](https://cloud-native.slack.com/archives/C03GDP0H023) | ||
|
|
||
| ## Overview | ||
| ## OpenTelemetry Overview | ||
|
|
||
| [`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument, | ||
| generate, collect, and export telemetry data (metrics, logs, and traces) for | ||
| analysis in order to understand your software's performance and behavior. This | ||
| crate provides additional propagators and exporters for sending telemetry data | ||
| to vendors or using experimental propagators like `base64`. | ||
| OpenTelemetry is an Observability framework and toolkit designed to create and | ||
| manage telemetry data such as traces, metrics, and logs. OpenTelemetry is | ||
| vendor- and tool-agnostic, meaning that it can be used with a broad variety of | ||
| Observability backends, including open source tools like [Jaeger] and | ||
| [Prometheus], as well as commercial offerings. | ||
|
|
||
| [`OpenTelemetry`]: https://crates.io/crates/opentelemetry | ||
| OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other | ||
| commercial vendors. OpenTelemetry is focused on the generation, collection, | ||
| management, and export of telemetry. A major goal of OpenTelemetry is that you | ||
| can easily instrument your applications or systems, no matter their language, | ||
| infrastructure, or runtime environment. Crucially, the storage and visualization | ||
| of telemetry is intentionally left to other tools. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,34 @@ | ||
| # OpenTelemetry Log Appender for `tracing` crate | ||
|
|
||
| ![OpenTelemetry — An observability framework for cloud-native software.][splash] | ||
|
|
||
| [splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png | ||
|
|
||
| # OpenTelemetry Log Appender for Tracing | ||
|
|
||
| A [Log | ||
| 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 [tracing crate](https://tracing.rs/tracing/#events) | ||
| to OpenTelemetry logs. Note that this is different from the existing | ||
| to OpenTelemetry. Note that this is different from the existing | ||
| [tracing-opentelemetry](https://github.com/tokio-rs/tracing-opentelemetry) | ||
| project, which supports bridging traces and logs from tracing into OpenTelemetry | ||
| traces. This is an experimental component, and could be merged with the | ||
| tracing-opentelemetry crate itself. | ||
| traces. | ||
|
|
||
| [](https://crates.io/crates/opentelemetry-appender-tracing) | ||
| [](https://docs.rs/opentelemetry-appender-tracing) | ||
| [](./LICENSE) | ||
| [](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain) | ||
| [](https://cloud-native.slack.com/archives/C03GDP0H023) | ||
|
|
||
| ## Overview | ||
| ## OpenTelemetry Overview | ||
|
|
||
| [`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument, | ||
| generate, collect, and export telemetry data (metrics, logs, and traces) for | ||
| analysis in order to understand your software's performance and behavior. This | ||
| crate provides additional propagators and exporters for sending telemetry data | ||
| to vendors or using experimental propagators like `base64`. | ||
| OpenTelemetry is an Observability framework and toolkit designed to create and | ||
| manage telemetry data such as traces, metrics, and logs. OpenTelemetry is | ||
| vendor- and tool-agnostic, meaning that it can be used with a broad variety of | ||
| Observability backends, including open source tools like [Jaeger] and | ||
| [Prometheus], as well as commercial offerings. | ||
|
|
||
| [`OpenTelemetry`]: https://crates.io/crates/opentelemetry | ||
| OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other | ||
| commercial vendors. OpenTelemetry is focused on the generation, collection, | ||
| management, and export of telemetry. A major goal of OpenTelemetry is that you | ||
| can easily instrument your applications or systems, no matter their language, | ||
| infrastructure, or runtime environment. Crucially, the storage and visualization | ||
| of telemetry is intentionally left to other tools. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,30 @@ | ||
| # OpenTelemetry HTTP | ||
|
|
||
| ![OpenTelemetry — An observability framework for cloud-native software.][splash] | ||
|
|
||
| [splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png | ||
|
|
||
| # OpenTelemetry HTTP | ||
|
|
||
| The Rust [OpenTelemetry](https://opentelemetry.io/) implementation. | ||
| This crate contains helper implementations for sending HTTP requests. Uses | ||
| include propagating and extracting context over http, exporting telemetry, | ||
| requesting sampling strategies. | ||
|
|
||
| [](./LICENSE) | ||
| [](https://crates.io/crates/opentelemetry-http) | ||
| [](https://docs.rs/opentelemetry-http) | ||
| [](./LICENSE) | ||
| [](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain) | ||
| [](https://cloud-native.slack.com/archives/C03GDP0H023) | ||
|
|
||
| ## Overview | ||
|
|
||
| [`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument, | ||
| generate, collect, and export telemetry data (metrics, logs, and traces) for | ||
| analysis in order to understand your software's performance and behavior. This | ||
| crate provides a HTTP client interface for use by trace exporters, as well as | ||
| helper types to inject and extract key value pairs into/from HTTP headers. | ||
|
|
||
| *Compiler support: [requires `rustc` 1.65+][msrv]* | ||
|
|
||
| [`OpenTelemetry`]: https://crates.io/crates/opentelemetry | ||
| [msrv]: #supported-rust-versions | ||
|
|
||
| ## Supported Rust Versions | ||
| ## OpenTelemetry Overview | ||
|
|
||
| OpenTelemetry is built against the latest stable release. The minimum supported | ||
| version is 1.65. The current OpenTelemetry version is not guaranteed to build | ||
| on Rust versions earlier than the minimum supported version. | ||
| OpenTelemetry is an Observability framework and toolkit designed to create and | ||
| manage telemetry data such as traces, metrics, and logs. OpenTelemetry is | ||
| vendor- and tool-agnostic, meaning that it can be used with a broad variety of | ||
| Observability backends, including open source tools like [Jaeger] and | ||
| [Prometheus], as well as commercial offerings. | ||
|
|
||
| The current stable Rust compiler and the three most recent minor versions | ||
| before it will always be supported. For example, if the current stable compiler | ||
| version is 1.49, the minimum supported version will not be increased past 1.46, | ||
| three minor versions prior. Increasing the minimum supported compiler version | ||
| is not considered a semver breaking change as long as doing so complies with | ||
| this policy. | ||
| OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other | ||
| commercial vendors. OpenTelemetry is focused on the generation, collection, | ||
| management, and export of telemetry. A major goal of OpenTelemetry is that you | ||
| can easily instrument your applications or systems, no matter their language, | ||
| infrastructure, or runtime environment. Crucially, the storage and visualization | ||
| of telemetry is intentionally left to other tools. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,30 @@ | ||
| # OpenTelemetry Jaeger Propagator | ||
|
|
||
| ![OpenTelemetry — An observability framework for cloud-native software.][splash] | ||
|
|
||
| [splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png | ||
|
|
||
| # OpenTelemetry Jaeger Propagator | ||
|
|
||
| [`Jaeger`] propagator integration for applications instrumented with [`OpenTelemetry`]. To export telemetry to Jaeger, use the opentelemetry-otlp crate. | ||
| This crate contains [`Jaeger`] propagator integration for applications | ||
| instrumented with [`OpenTelemetry`]. To export telemetry to Jaeger, use the | ||
| opentelemetry-otlp crate. | ||
|
|
||
| [](https://crates.io/crates/opentelemetry-jaeger) | ||
| [](https://docs.rs/opentelemetry-jaeger) | ||
| [](./LICENSE) | ||
| [](https://crates.io/crates/opentelemetry-jaeger-propagator) | ||
| [](https://docs.rs/opentelemetry-jaeger-propagator) | ||
| [](./LICENSE) | ||
| [](https://github.com/open-telemetry/opentelemetry-rust/actions?query=workflow%3ACI+branch%3Amain) | ||
| [](https://cloud-native.slack.com/archives/C03GDP0H023) | ||
|
|
||
| ## Overview | ||
|
|
||
| [`OpenTelemetry`] is a collection of tools, APIs, and SDKs used to instrument, | ||
| generate, collect, and export telemetry data (metrics, logs, and traces) for | ||
| analysis in order to understand your software's performance and behavior. This | ||
| crate provides the ability to create and interact with a Jaeger propagator. | ||
|
|
||
| *Compiler support: [requires `rustc` 1.65+][msrv]* | ||
|
|
||
| [`Jaeger`]: https://www.jaegertracing.io/ | ||
| [`OpenTelemetry`]: https://crates.io/crates/opentelemetry | ||
| [msrv]: #supported-rust-versions | ||
|
|
||
| ## Supported Rust Versions | ||
| ## OpenTelemetry Overview | ||
|
|
||
| OpenTelemetry is built against the latest stable release. The minimum supported | ||
| version is 1.65. The current OpenTelemetry version is not guaranteed to build | ||
| on Rust versions earlier than the minimum supported version. | ||
| OpenTelemetry is an Observability framework and toolkit designed to create and | ||
| manage telemetry data such as traces, metrics, and logs. OpenTelemetry is | ||
| vendor- and tool-agnostic, meaning that it can be used with a broad variety of | ||
| Observability backends, including open source tools like [Jaeger] and | ||
| [Prometheus], as well as commercial offerings. | ||
|
|
||
| The current stable Rust compiler and the three most recent minor versions | ||
| before it will always be supported. For example, if the current stable compiler | ||
| version is 1.49, the minimum supported version will not be increased past 1.46, | ||
| three minor versions prior. Increasing the minimum supported compiler version | ||
| is not considered a semver breaking change as long as doing so complies with | ||
| this policy. | ||
| OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other | ||
| commercial vendors. OpenTelemetry is focused on the generation, collection, | ||
| management, and export of telemetry. A major goal of OpenTelemetry is that you | ||
| can easily instrument your applications or systems, no matter their language, | ||
| infrastructure, or runtime environment. Crucially, the storage and visualization | ||
| of telemetry is intentionally left to other tools. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters