@@ -30,13 +30,13 @@ documentation.
3030
3131| Signal/Component | Overall Status |
3232| -------------------- | ------------------ |
33- | Logs-API | RC * |
34- | Logs-SDK | Beta |
35- | Logs-OTLP Exporter | Beta |
36- | Logs-Appender-Tracing | Beta |
37- | Metrics-API | RC |
38- | Metrics-SDK | Beta |
39- | Metrics-OTLP Exporter | Beta |
33+ | Logs-API | Stable * |
34+ | Logs-SDK | RC |
35+ | Logs-OTLP Exporter | RC |
36+ | Logs-Appender-Tracing | RC |
37+ | Metrics-API | Stable |
38+ | Metrics-SDK | RC |
39+ | Metrics-OTLP Exporter | RC |
4040| Traces-API | Beta |
4141| Traces-SDK | Beta |
4242| Traces-OTLP Exporter | Beta |
@@ -55,49 +55,28 @@ If you already use the logging APIs from above, continue to use them, and use
5555the appenders above to bridge the logs to OpenTelemetry. If you are using a
5656library not listed here, feel free to contribute a new appender for the same.
5757
58- If you are starting fresh, then consider using
58+ If you are starting fresh, we recommend using
5959[ tracing] ( https://github.com/tokio-rs/tracing ) as your logging API. It supports
60- structured logging and is actively maintained.
60+ structured logging and is actively maintained. ` OpenTelemetry ` itself uses
61+ ` tracing ` for its internal logging.
6162
6263Project versioning information and stability guarantees can be found
6364[ here] ( VERSIONING.md ) .
6465
6566## Getting Started
6667
67- ``` rust
68- use opentelemetry :: {
69- global,
70- trace :: {Tracer , TracerProvider as _},
71- };
72- use opentelemetry_sdk :: trace :: TracerProvider ;
73-
74- fn main () {
75- // Create a new trace pipeline that prints to stdout
76- let provider = TracerProvider :: builder ()
77- . with_simple_exporter (opentelemetry_stdout :: SpanExporter :: default ())
78- . build ();
79- let tracer = provider . tracer (" readme_example" );
80-
81- tracer . in_span (" doing_work" , | cx | {
82- // Traced app logic here...
83- });
84-
85- // Shutdown trace pipeline
86- provider . shutdown (). expect (" TracerProvider should shutdown successfully" )
87- }
88- ```
89-
90- The example above requires the following packages:
91-
92- ``` toml
93- # Cargo.toml
94- [dependencies ]
95- opentelemetry = " 0.22"
96- opentelemetry_sdk = " 0.22"
97- opentelemetry-stdout = { version = " 0.3" , features = [" trace" ] }
98- ```
99-
100- See the [ examples] ( ./examples ) directory for different integration patterns.
68+ If you are new to OpenTelemetry, start with the [ Stdout
69+ Example] ( ./opentelemetry-stdout/examples/basic.rs ) . This example demonstrates
70+ how to use OpenTelemetry for logs, metrics, and traces, and display
71+ telemetry data on your console.
72+
73+ For those using OTLP, the recommended OpenTelemetry Exporter for production
74+ scenarios, refer to the [ OTLP Example -
75+ HTTP] ( ./opentelemetry-otlp/examples/basic-otlp-http/README.md ) and the [ OTLP
76+ Example - gRPC] ( ./opentelemetry-otlp/examples/basic-otlp/README.md ) .
77+
78+ Additional examples for various integration patterns can be found in the
79+ [ examples] ( ./examples ) directory.
10180
10281## Overview of crates
10382
@@ -184,7 +163,7 @@ for specific dates and for Zoom meeting links. "OTel Rust SIG" is the name of
184163meeting for this group.
185164
186165Meeting notes are available as a public [ Google
187- doc] ( https://docs.google.com/document/d/1tGKuCsSnyT2McDncVJrMgg74_z8V06riWZa0Sr79I_4 /edit ) .
166+ doc] ( https://docs.google.com/document/d/12upOzNk8c3SFTjsL6IRohCWMgzLKoknSCOOdMakbWo4 /edit ) .
188167If you have trouble accessing the doc, please get in touch on
189168[ Slack] ( https://cloud-native.slack.com/archives/C03GDP0H023 ) .
190169
@@ -207,6 +186,7 @@ you're more than welcome to participate!
207186### Approvers
208187
209188* [ Shaun Cox] ( https://github.com/shaun-cox )
189+ * [ Scott Gerring] ( https://github.com/scottgerring )
210190
211191### Emeritus
212192
0 commit comments