Skip to content

Commit 37c7a02

Browse files
Maximiliano-Zeballoslalitbcijothomas
authored
docs: make opentelemetry-proto README consistent with other components (#3445)
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com> Co-authored-by: Cijo Thomas <cijo.thomas@gmail.com>
1 parent 7c8578b commit 37c7a02

1 file changed

Lines changed: 48 additions & 4 deletions

File tree

opentelemetry-proto/README.md

Lines changed: 48 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,57 @@
1+
# OpenTelemetry Proto
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 Proto
6-
This crate contains generated files from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
7-
repository and transformation between types from generated files and types defined in [opentelemetry](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry).
7+
This crate contains generated files from
8+
[opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
9+
repository and transformations between types from generated files and types
10+
defined in
11+
[opentelemetry](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry).
12+
13+
[![Crates.io: opentelemetry-proto](https://img.shields.io/crates/v/opentelemetry-proto.svg)](https://crates.io/crates/opentelemetry-proto)
14+
[![Documentation](https://docs.rs/opentelemetry-proto/badge.svg)](https://docs.rs/opentelemetry-proto)
15+
[![LICENSE](https://img.shields.io/crates/l/opentelemetry-proto)](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-proto/LICENSE)
16+
[![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)
17+
[![codecov](https://codecov.io/gh/open-telemetry/opentelemetry-rust/branch/main/graph/badge.svg)](https://codecov.io/gh/open-telemetry/opentelemetry-rust)
18+
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
19+
20+
## Overview
21+
22+
OpenTelemetry is an Observability framework and toolkit designed to create and
23+
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
24+
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
25+
Observability backends, including open source tools like [Jaeger] and
26+
[Prometheus], as well as commercial offerings.
27+
28+
OpenTelemetry is *not* an observability backend like Jaeger, Prometheus, or other
29+
commercial vendors. OpenTelemetry is focused on the generation, collection,
30+
management, and export of telemetry. A major goal of OpenTelemetry is that you
31+
can easily instrument your applications or systems, no matter their language,
32+
infrastructure, or runtime environment. Crucially, the storage and visualization
33+
of telemetry is intentionally left to other tools.
834

935
*[Supported Rust Versions](#supported-rust-versions)*
1036

37+
[Prometheus]: https://prometheus.io
38+
[Jaeger]: https://www.jaegertracing.io
39+
40+
### What does this crate contain?
41+
42+
This crate provides auto-generated Protobuf types from the [OpenTelemetry
43+
protocol specification](https://github.com/open-telemetry/opentelemetry-proto),
44+
along with conversion implementations between these generated types and the
45+
types defined in the
46+
[opentelemetry](https://crates.io/crates/opentelemetry) crate. It is used
47+
internally by exporters such as
48+
[opentelemetry-otlp](https://crates.io/crates/opentelemetry-otlp) to serialize
49+
and deserialize telemetry data.
50+
51+
## Getting started
52+
53+
See [docs](https://docs.rs/opentelemetry-proto).
54+
1155
## Release Notes
1256

1357
You can find the release notes (changelog) [here](https://github.com/open-telemetry/opentelemetry-rust/blob/main/opentelemetry-proto/CHANGELOG.md).
@@ -23,4 +67,4 @@ before it will always be supported. For example, if the current stable compiler
2367
version is 1.49, the minimum supported version will not be increased past 1.46,
2468
three minor versions prior. Increasing the minimum supported compiler version
2569
is not considered a semver breaking change as long as doing so complies with
26-
this policy.
70+
this policy.

0 commit comments

Comments
 (0)