Merge branch 'main' into cijothomas/028migration

Author: cijothomas

README.md

@@ -30,13 +30,13 @@ documentation.
 
 | Signal/Component      | Overall Status     |
 | --------------------  | ------------------ |
-| Logs-API              | RC*                |
-| Logs-SDK              | Beta               |
-| Logs-OTLP Exporter    | Beta               |
-| Logs-Appender-Tracing | Beta               |
-| Metrics-API           | RC                 |
-| Metrics-SDK           | Beta               |
-| Metrics-OTLP Exporter | Beta               |
+| Logs-API              | Stable*            |
+| Logs-SDK              | RC                 |
+| Logs-OTLP Exporter    | RC                 |
+| Logs-Appender-Tracing | RC                 |
+| Metrics-API           | Stable             |
+| Metrics-SDK           | RC                 |
+| Metrics-OTLP Exporter | RC                 |
 | Traces-API            | Beta               |
 | Traces-SDK            | Beta               |
 | Traces-OTLP Exporter  | Beta               |
@@ -55,50 +55,28 @@ If you already use the logging APIs from above, continue to use them, and use
 the appenders above to bridge the logs to OpenTelemetry. If you are using a
 library not listed here, feel free to contribute a new appender for the same.
 
-If you are starting fresh, then consider using
+If you are starting fresh, we recommend using
 [tracing](https://github.com/tokio-rs/tracing) as your logging API. It supports
-structured logging and is actively maintained.
+structured logging and is actively maintained. `OpenTelemetry` itself uses
+`tracing` for its internal logging.
 
 Project versioning information and stability guarantees can be found
 [here](VERSIONING.md).
 
 ## Getting Started
 
-```rust
-use opentelemetry::trace::{
-    TraceContextExt,
-    Tracer,
-    TracerProvider,
-};
-use opentelemetry_sdk::trace::SdkTracerProvider;
-
-fn main() {
-    // Create a new trace pipeline that prints to stdout
-    let provider = TracerProvider::builder()
-        .with_simple_exporter(opentelemetry_stdout::SpanExporter::default())
-        .build();
-    let tracer = provider.tracer("readme_example");
-
-    tracer.in_span("doing_work", |cx| {
-        // Traced app logic here...
-    });
-
-    // Shutdown trace pipeline
-    provider.shutdown().expect("TracerProvider should shutdown successfully")
-}
-```
-
-The example above requires the following packages:
-
-```toml
-# Cargo.toml
-[dependencies]
-opentelemetry = "0.27"
-opentelemetry_sdk = "0.27"
-opentelemetry-stdout = { version = "0.27", features = ["trace"] }
-```
-
-See the [examples](./examples) directory for different integration patterns.
+If you are new to OpenTelemetry, start with the [Stdout
+Example](./opentelemetry-stdout/examples/basic.rs). This example demonstrates
+how to use OpenTelemetry for logs, metrics, and traces, and display
+telemetry data on your console.
+
+For those using OTLP, the recommended OpenTelemetry Exporter for production
+scenarios, refer to the [OTLP Example -
+HTTP](./opentelemetry-otlp/examples/basic-otlp-http/README.md) and the [OTLP
+Example - gRPC](./opentelemetry-otlp/examples/basic-otlp/README.md).
+
+Additional examples for various integration patterns can be found in the
+[examples](./examples) directory.
 
 ## Overview of crates
 

opentelemetry-appender-log/README.md

@@ -26,3 +26,7 @@ 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.
+
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).

opentelemetry-appender-tracing/README.md

@@ -35,6 +35,10 @@ of telemetry is intentionally left to other tools.
 
 *[Supported Rust Versions](#supported-rust-versions)*
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-http/README.md

@@ -31,6 +31,10 @@ of telemetry is intentionally left to other tools.
 
 *[Supported Rust Versions](#supported-rust-versions)*
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-jaeger-propagator/README.md

@@ -31,6 +31,10 @@ of telemetry is intentionally left to other tools.
 
 *[Supported Rust Versions](#supported-rust-versions)*
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-otlp/README.md

@@ -39,6 +39,10 @@ of telemetry is intentionally left to other tools.
 
 See [docs](https://docs.rs/opentelemetry-otlp).
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-prometheus/README.md

@@ -32,3 +32,7 @@ of telemetry is intentionally left to other tools.
 
 [`Prometheus`]: https://prometheus.io
 [`OpenTelemetry`]: https://crates.io/crates/opentelemetry
+
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).

opentelemetry-proto/README.md

@@ -8,6 +8,10 @@ repository and transformation between types from generated files and types defin
 
 *[Supported Rust Versions](#supported-rust-versions)*
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-sdk/README.md

@@ -100,6 +100,10 @@ additional exporters and other related components as well.
 
 See [docs](https://docs.rs/opentelemetry-sdk).
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported

opentelemetry-semantic-conventions/README.md

@@ -25,6 +25,10 @@ and visualization tools.
 
 *[Supported Rust Versions](#supported-rust-versions)*
 
+## Release Notes
+
+You can find the release notes (changelog) [here](./CHANGELOG.md).
+
 ## Supported Rust Versions
 
 OpenTelemetry is built against the latest stable release. The minimum supported