Merge main to switch_batch_log_to_background_thread

Author: ThomsonTan

.github/workflows/ci.yml

@@ -8,6 +8,9 @@ on:
     - main
     paths-ignore:
     - '**.md'
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 jobs:
   test:
     strategy:
@@ -22,8 +25,9 @@ jobs:
           - rust: stable
             os: macos-latest
           - rust: stable
-            os: actuated-arm64-4cpu-16gb
+            os: otel-linux-arm64
     runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.rust == 'beta' }}
     steps:
     - name: Free disk space
       if: ${{ matrix.os == 'ubuntu-latest'}}
@@ -73,33 +77,13 @@ jobs:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@nightly
         with:
-          toolchain: nightly-2024-05-01
+          toolchain: nightly-2024-06-30
           components: rustfmt
       - name: external-type-check
         run: |
-          cargo install cargo-check-external-types
+          cargo install cargo-check-external-types@0.1.13
           cd ${{ matrix.example }}
           cargo check-external-types --config allowed-external-types.toml
-  non-default-examples:
-    strategy:
-      matrix:
-        os: [ windows-latest, ubuntu-latest ]
-        example: [opentelemetry-otlp/examples/basic-otlp]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        submodules: true
-    - uses: dtolnay/rust-toolchain@stable
-      with:
-        components: rustfmt
-    - uses: arduino/setup-protoc@v3
-      with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-    - name: Build
-      run: |
-        cd ${{ matrix.example }}
-        cargo build --verbose
   msrv:
     strategy:
       matrix:
@@ -132,7 +116,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/rust-toolchain@stable
         with:
           components: rustfmt
       - uses: arduino/setup-protoc@v3

.github/workflows/semver.yml

@@ -4,7 +4,6 @@ env:
 on:
   pull_request:
     types: [ labeled, synchronize, opened, reopened ]
-
 jobs:
   semver-compliance: # This job uses the latest published crate as baseline for comparison.
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -140,7 +140,7 @@ For a deeper discussion, see:
 
 Currently, the Opentelemetry Rust SDK has two ways to handle errors. In the situation where errors are not allowed to return. One should call global error handler to process the errors. Otherwise, one should return the errors.
 
-The Opentelemetry Rust SDK comes with an error type `opentelemetry::Error`. For different function, one error has been defined. All error returned by trace module MUST be wrapped in `opentelemetry::trace::TraceError`. All errors returned by metrics module MUST be wrapped in `opentelemetry::metrics::MetricsError`. All errors returned by logs module MUST be wrapped in `opentelemetry::logs::LogsError`.
+The Opentelemetry Rust SDK comes with an error type `opentelemetry::Error`. For different function, one error has been defined. All error returned by trace module MUST be wrapped in `opentelemetry::trace::TraceError`. All errors returned by metrics module MUST be wrapped in `opentelemetry::metrics::MetricError`. All errors returned by logs module MUST be wrapped in `opentelemetry::logs::LogsError`.
 
 For users that want to implement their own exporters. It's RECOMMENDED to wrap all errors from the exporter into a crate-level error type, and implement `ExporterError` trait.
 
@@ -169,7 +169,7 @@ It's important to regularly review and remove the `otel_unstable` flag from the
 The potential features include:
 
 - Stable and non-experimental features that compliant to specification, and have a feature flag to minimize compilation size. Example: feature flags for signals (like `logs`, `traces`, `metrics`) and runtimes (`rt-tokio`, `rt-tokio-current-thread`, `rt-async-std`).
-- Stable and non-experimental features, although not part of the specification, are crucial for enhancing the tracing/log crate's functionality or boosting performance. These features are also subject to discussion and approval by the OpenTelemetry Rust Maintainers. An example of such a feature is `logs_level_enabled`.
+- Stable and non-experimental features, although not part of the specification, are crucial for enhancing the tracing/log crate's functionality or boosting performance. These features are also subject to discussion and approval by the OpenTelemetry Rust Maintainers.
 
 All such features should adhere to naming convention  `<signal>_<feature_name>`
 

Cargo.toml

@@ -39,12 +39,12 @@ reqwest = { version = "0.12", default-features = false }
 serde = { version = "1.0", default-features = false }
 serde_json = "1.0"
 temp-env = "0.3.6"
-thiserror = { version = "1", default-features = false }
+thiserror = { version = "2", default-features = false }
 tonic = { version = "0.12.3", default-features = false }
 tonic-build = "0.12"
 tokio = { version = "1", default-features = false }
 tokio-stream = "0.1"
 tracing = { version = "0.1", default-features = false }
 tracing-core = { version = "0.1", default-features = false }
 tracing-subscriber = { version = "0.3", default-features = false }
-url = { version = "2.5", default-features = false }
+url = { version = "2.5.2", default-features = false } #https://github.com/servo/rust-url/issues/992

README.md

@@ -17,30 +17,33 @@ analysis in order to understand your software's performance and behavior. You
 can export and analyze them using [Prometheus], [Jaeger], and other
 observability tools.
 
-*Compiler support: [requires `rustc` 1.70+][msrv]*
+*[Supported Rust Versions](#supported-rust-versions)*
 
 [Prometheus]: https://prometheus.io
 [Jaeger]: https://www.jaegertracing.io
-[msrv]: #supported-rust-versions
 
 ## Project Status
 
+The table below summarizes the overall status of each component. Some components
+include unstable features, which are documented in their respective crate
+documentation.
+
 | Signal/Component      | Overall Status     |
 | --------------------  | ------------------ |
-| Logs-API              | Beta*              |
+| Logs-API              | RC*                |
 | Logs-SDK              | Beta               |
 | Logs-OTLP Exporter    | Beta               |
 | Logs-Appender-Tracing | Beta               |
-| Metrics-API           | Beta               |
-| Metrics-SDK           | Alpha              |
-| Metrics-OTLP Exporter | Alpha              |
+| Metrics-API           | RC                 |
+| Metrics-SDK           | Beta               |
+| Metrics-OTLP Exporter | Beta               |
 | Traces-API            | Beta               |
 | Traces-SDK            | Beta               |
 | Traces-OTLP Exporter  | Beta               |
 
 *OpenTelemetry Rust is not introducing a new end user callable Logging API.
 Instead, it provides [Logs Bridge
-API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md),
+API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/api.md),
 that allows one to write log appenders that can bridge existing logging
 libraries to the OpenTelemetry log data model. The following log appenders are
 available:
@@ -80,7 +83,7 @@ fn main() {
     });
 
     // Shutdown trace pipeline
-    global::shutdown_tracer_provider();
+    provider.shutdown().expect("TracerProvider should shutdown successfully")
 }
 ```
 
@@ -198,12 +201,12 @@ you're more than welcome to participate!
 * [Harold Dost](https://github.com/hdost)
 * [Julian Tescher](https://github.com/jtescher)
 * [Lalit Kumar Bhasin](https://github.com/lalitb)
+* [Utkarsh Umesan Pillai](https://github.com/utpilla)
 * [Zhongyang Wu](https://github.com/TommyCpp)
 
 ### Approvers
 
 * [Shaun Cox](https://github.com/shaun-cox)
-* [Utkarsh Umesan Pillai](https://github.com/utpilla)
 
 ### Emeritus
 

examples/README.md

@@ -7,7 +7,7 @@ This directory contains some examples that should help you get start crates from
 This example uses following crates from this repo:
 
 - opentelemetry(log)
-- opentelemetry-appender-log
+- opentelemetry-appender-tracing
 - opentelemetry-stdout
 
 Check this example if you want to understand *how to instrument logs using opentelemetry*.

examples/logs-basic/Cargo.toml

@@ -9,7 +9,7 @@ publish = false
 opentelemetry = { path = "../../opentelemetry", features = ["logs"] }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["logs"] }
 opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["logs"]}
-opentelemetry-appender-log = { path = "../../opentelemetry-appender-log", default-features = false}
+opentelemetry-appender-tracing = { path = "../../opentelemetry-appender-tracing", default-features = false}
 opentelemetry-semantic-conventions = { path = "../../opentelemetry-semantic-conventions" }
-log = { workspace = true }
-serde_json = { workspace = true }
+tracing = { workspace = true, features = ["std"]}
+tracing-subscriber = { workspace = true, features = ["registry", "std"] }

examples/logs-basic/README.md

@@ -1,15 +1,15 @@
-# OpenTelemetry Log Appender for log -  Example
+# OpenTelemetry Log Appender for tracing -  Example
 
-This example shows how to use the opentelemetry-appender-log crate, which is a
+This example shows how to use the opentelemetry-appender-tracing crate, which is a
 [logging
 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
+that bridges logs from the [tracing crate](https://tracing.rs/tracing/#events) to
 OpenTelemetry. The example setups a LoggerProvider with stdout exporter, so logs
 are emitted to stdout.
 
 ## Usage
 
-Run the following, and Logs emitted using [log](https://docs.rs/log/latest/log/)
+Run the following, and Logs emitted using [tracing](https://docs.rs/tracing/latest/tracing/)
 will be written out to stdout.
 
 ```shell

examples/logs-basic/src/main.rs

@@ -1,27 +1,22 @@
-use log::{error, Level};
 use opentelemetry::KeyValue;
-use opentelemetry_appender_log::OpenTelemetryLogBridge;
+use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::logs::LoggerProvider;
 use opentelemetry_sdk::Resource;
-use opentelemetry_semantic_conventions::resource::SERVICE_NAME;
+use tracing::error;
+use tracing_subscriber::prelude::*;
 
 fn main() {
-    // Setup LoggerProvider with a stdout exporter
     let exporter = opentelemetry_stdout::LogExporter::default();
-    let logger_provider = LoggerProvider::builder()
-        .with_resource(Resource::new([KeyValue::new(
-            SERVICE_NAME,
-            "logs-basic-example",
+    let provider: LoggerProvider = LoggerProvider::builder()
+        .with_resource(Resource::new(vec![KeyValue::new(
+            "service.name",
+            "log-appender-tracing-example",
         )]))
         .with_simple_exporter(exporter)
         .build();
+    let layer = layer::OpenTelemetryTracingBridge::new(&provider);
+    tracing_subscriber::registry().with(layer).init();
 
-    // Setup Log Appender for the log crate.
-    let otel_log_appender = OpenTelemetryLogBridge::new(&logger_provider);
-    log::set_boxed_logger(Box::new(otel_log_appender)).unwrap();
-    log::set_max_level(Level::Error.to_level_filter());
-
-    // Emit logs using macros from the log crate.
-    // These logs gets piped through OpenTelemetry bridge and gets exported to stdout.
-    error!(target: "my-target", "hello from {}. My price is {}", "apple", 2.99);
+    error!(name: "my-event-name", target: "my-system", event_id = 20, user_name = "otel", user_email = "[email protected]", message = "This is an example message");
+    let _ = provider.shutdown();
 }

examples/metrics-advanced/Cargo.toml

@@ -7,7 +7,7 @@ publish = false
 
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }
-opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["metrics", "rt-tokio"] }
+opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["spec_unstable_metrics_views", "rt-tokio"] }
 opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["metrics"] }
 tokio = { workspace = true, features = ["full"] }
 serde_json = { workspace = true }