Skip to content

Commit 1f7b6c4

Browse files
authored
Tweaks to readme docs (#1588)
1 parent 5e67cae commit 1f7b6c4

File tree

2 files changed

+44
-4
lines changed

2 files changed

+44
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,14 @@ The following crates are maintained in this repo:
100100
* [`opentelemetry-sdk`] This is the OpenTelemetry SDK crate, and contains the
101101
official OpenTelemetry SDK implementation. It contains Logging SDK, Metrics
102102
SDK, and Tracing SDK. It also contains propagator implementations.
103-
* [`opentelemetry-otlp`] exporter for sending logs, metrics and traces in the
104-
OTLP format to an endpoint accepting OTLP, like the [OpenTelemetry
105-
collector](https://opentelemetry.io/docs/collector/), or [vendor specific
106-
endpoints](https://opentelemetry.io/ecosystem/vendors/).
103+
* [`opentelemetry-otlp`] - exporter to send telemetry (logs, metrics and traces)
104+
in the [OTLP
105+
format](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/protocol)
106+
to an endpoint accepting OTLP. This could be the [OTel
107+
Collector](https://github.com/open-telemetry/opentelemetry-collector),
108+
telemetry backends like [Jaeger](https://www.jaegertracing.io/),
109+
[Prometheus](https://prometheus.io/docs/prometheus/latest/feature_flags/#otlp-receiver)
110+
or [vendor specific endpoints](https://opentelemetry.io/ecosystem/vendors/).
107111
* [`opentelemetry-stdout`] exporter for sending logs, metrics and traces to
108112
stdout, for learning/debugging purposes.
109113
* [`opentelemetry-http`] This crate contains utility functions to help with

opentelemetry/README.md

+36
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,42 @@ also aligned with the design philosophy of existing telemetry solutions in the
8686
Rust ecosystem, like `tracing` or `log`, where these crates only offer a facade
8787
and the actual functionality is enabled through additional crates.
8888

89+
### Related crates
90+
91+
Unless you are a library author, you will almost always need to use additional
92+
crates along with this. Given this crate has no-op implementation only, an
93+
OpenTelemetry SDK is always required.
94+
[opentelemetry-sdk](https://crates.io/crates/opentelemetry-sdk) is the official
95+
SDK implemented by OpenTelemetry itself, though it is possible to use a
96+
different sdk.
97+
98+
Additionally one or more exporters are also required to export telemetry to a
99+
destination. OpenTelemetry provides the following exporters:
100+
101+
- **[opentelemetry-stdout](https://crates.io/crates/opentelemetry-stdout):**
102+
Prints telemetry to stdout, primarily used for learning/debugging purposes.
103+
- **[opentelemetry-otlp](https://crates.io/crates/opentelemetry-otlp):** Exports
104+
telemetry (logs, metrics and traces) in the [OTLP
105+
format](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/protocol)
106+
to an endpoint accepting OTLP. This could be the [OTel
107+
Collector](https://github.com/open-telemetry/opentelemetry-collector),
108+
telemetry backends like [Jaeger](https://www.jaegertracing.io/),
109+
[Prometheus](https://prometheus.io/docs/prometheus/latest/feature_flags/#otlp-receiver)
110+
or [vendor specific endpoints](https://opentelemetry.io/ecosystem/vendors/).
111+
- **[opentelemetry-zipkin](https://crates.io/crates/opentelemetry-zipkin):**
112+
Exports telemetry (traces only) to Zipkin following [OpenTelemetry to Zipkin
113+
specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/zipkin.md)
114+
- **[opentelemetry-prometheus](https://crates.io/crates/opentelemetry-prometheus):**
115+
Exports telemetry (metrics only) to Prometheus following [OpenTelemetry to
116+
Prometheus
117+
specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/prometheus.md)
118+
119+
OpenTelemetry Rust also has a [contrib
120+
repo](https://github.com/open-telemetry/opentelemetry-rust-contrib), where
121+
additional exporters could be found. Check [OpenTelemetry
122+
Registry](https://opentelemetry.io/ecosystem/registry/?language=rust) for
123+
additional exporters and other related components as well.
124+
89125
## Getting started
90126

91127
See [docs](https://docs.rs/opentelemetry).

0 commit comments

Comments
 (0)