Merge branch 'main' into cijothomas/context-suppress

Author: cijothomas

.github/workflows/benchmark.yml

@@ -0,0 +1,54 @@
+# This workflow runs a Criterion benchmark on a PR and compares the results against the base branch.
+# It is triggered on a PR or a push to main.
+#
+# The workflow is gated on the presence of the "performance" label on the PR.
+#
+# The workflow runs on a self-hosted runner pool. We can't use the shared runners for this,
+# because they are only permitted to run on the default branch to preserve resources. 
+#
+# In the future, we might like to consider using bencher.dev or the framework used by otel-golang here. 
+on: 
+  pull_request:
+  push:
+    branches:
+      - main
+name: benchmark pull requests
+jobs:
+  runBenchmark:
+    name: run benchmark
+    permissions:
+      pull-requests: write
+
+    # If we're running on a PR, use ubuntu-latest - a shared runner. We can't use the self-hosted
+    # runners on arbitrary PRs, and we don't want to unleash that load on the pool anyway.     
+    # If we're running on main, use the OTEL self-hosted runner pool. 
+    runs-on: ${{ github.event_name == 'pull_request' && 'ubuntu-latest' || 'self-hosted' }}
+    if: ${{ (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'performance')) || github.event_name == 'push' }}
+    env:
+      # For PRs, compare against the base branch - e.g., 'main'. 
+      # For pushes to main, compare against the previous commit
+      BRANCH_NAME: ${{ github.event_name == 'pull_request' && github.base_ref || github.event.before }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 10  # Fetch current commit and its parent
+      - uses: arduino/setup-protoc@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+      - uses: boa-dev/criterion-compare-action@v3
+        with:
+          cwd: opentelemetry
+          branchName: ${{ env.BRANCH_NAME }}
+      - uses: boa-dev/criterion-compare-action@v3
+        with:
+          cwd: opentelemetry-appender-tracing
+          features: spec_unstable_logs_enabled
+          branchName: ${{ env.BRANCH_NAME }}
+      - uses: boa-dev/criterion-compare-action@v3
+        with:
+          cwd: opentelemetry-sdk
+          features: rt-tokio,testing,metrics,logs,spec_unstable_metrics_views
+          branchName: ${{ env.BRANCH_NAME }}

.github/workflows/ci.yml

@@ -62,10 +62,8 @@ jobs:
     - uses: arduino/setup-protoc@v3
       with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-    - uses: actions-rs/cargo@v1
-      with:
-        command: fmt
-        args: --all -- --check
+    - name: Format
+      run: cargo fmt --all -- --check
     - name: Lint
       run: bash ./scripts/lint.sh
   external-types:

.github/workflows/pr_criterion.yaml

@@ -31,12 +31,12 @@ documentation.
 | Signal/Component      | Overall Status     |
 | --------------------  | ------------------ |
 | Context               | Beta               |
-| Baggage               | Beta               |
+| Baggage               | RC                 |
 | Propagators           | Beta               |
 | Logs-API              | Stable*            |
-| Logs-SDK              | RC                 |
+| Logs-SDK              | Stable              |
 | Logs-OTLP Exporter    | RC                 |
-| Logs-Appender-Tracing | RC                 |
+| Logs-Appender-Tracing | Stable             |
 | Metrics-API           | Stable             |
 | Metrics-SDK           | RC                 |
 | Metrics-OTLP Exporter | RC                 |

README.md

@@ -0,0 +1,92 @@
+# Migration Guide from 0.28 to 0.29
+
+OpenTelemetry Rust 0.29 introduces a few breaking changes. This guide aims to
+facilitate a smooth migration for common use cases involving the
+`opentelemetry`, `opentelemetry_sdk`, `opentelemetry-otlp`, and
+`opentelemetry-appender-tracing` crates. For a comprehensive list of changes,
+please refer to the detailed changelog for each crate. This document covers only
+the most common scenarios. Note that changes that only affect custom
+exporter/processor authors are not mentioned in this doc.
+
+OpenTelemetry Metrics API and Log-Bridge API were declared stable in 0.28, and have
+no breaking changes.
+
+## Baggage Changes
+
+The Baggage API has been redesigned to align with the OpenTelemetry
+specification. While the core API for interacting with Baggage remains the same,
+the accepted data types have changed. Baggage Keys now only allow strings (ASCII
+printable characters), and Baggage values are restricted to strings.
+
+For detailed changes, see the [changelog](../opentelemetry/CHANGELOG.md). With
+version 0.29, the Baggage API has reached "Release Candidate" status, meaning
+further breaking changes will be highly restricted.
+
+## Appender-Tracing Changes
+
+The `opentelemetry-appender-tracing` crate, which bridges `tracing` events to
+OpenTelemetry logs, has been updated to properly map `tracing` data types to the
+OpenTelemetry model. As of version 0.29, this crate is considered "Stable," and
+no further breaking changes will be made without a major version bump.
+
+## Configuration via Environment Variables
+
+The 0.29 release aligns OpenTelemetry Rust with the rest of the OpenTelemetry
+ecosystem by treating any code-based configuration as final (i.e., it cannot be
+overridden by environment variables). This policy was partially true before but
+is now applied consistently. If you prefer to configure your application via
+environment variables, avoid configuring it programmatically.
+
+## Discontinuing Dedicated Prometheus Exporter
+
+The `opentelemetry-prometheus` crate will be discontinued with the 0.29 release.
+Active development on this crate ceased a few months ago. Given that Prometheus
+now natively supports OTLP, and considering that the OpenTelemetry Rust project
+is still working towards a 1.0 release, we need to focus on essential components
+to maintain scope and ensure timely delivery.
+
+Prometheus interoperability remains a key goal for OpenTelemetry. However, the
+current `opentelemetry-prometheus` crate requires a major rewrite to eliminate
+dependencies on unmaintained crates. We may reintroduce a dedicated Prometheus
+exporter in the future once these issues are resolved.
+
+### Migration Guide
+
+For those using Prometheus as a backend, you can integrate with Prometheus using
+the following methods:
+
+1. Use the OTLP Exporter to push metrics directly to Prometheus.
+2. If you require a pull (scrape) model, push metrics to an OpenTelemetry
+   Collector using the OTLP Exporter, and configure Prometheus to scrape the
+   OpenTelemetry Collector.
+
+These alternatives ensure continued Prometheus integration while allowing us to
+focus on achieving a stable 1.0 release for OpenTelemetry Rust.
+
+## Next Release
+
+In the [next
+release](https://github.com/open-telemetry/opentelemetry-rust/milestone/21), we
+expect to stabilize the Metrics SDK and resolve the long-standing question of
+`tokio-tracing` vs. `opentelemetry tracing`, which is a prerequisite before
+stabilizing Distributed Tracing. Additionally, `Context` is also expected to be
+enhanced with the ability to suppress telemetry-induced-telemetry.
+
+## Instrumentation Libraries
+
+Unlike other OpenTelemetry language implementations, OpenTelemetry Rust historically did not
+maintain any instrumentations directly. This has recently changed with a
+[contribution](https://github.com/open-telemetry/opentelemetry-rust-contrib/pull/202)
+from one of the founding members of the OpenTelemetry Rust project to the
+contrib repository, providing an instrumentation library for
+[`actix-web`](https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/actix-web-opentelemetry).
+We expect that this instrumentation will serve as a reference implementation demonstrating best practices for
+creating OpenTelemetry instrumentations in Rust.
+
+We welcome additional contributions of instrumentation libraries to the contrib repository.
+
+## Thanks
+
+Thank you to everyone who contributed to this milestone. Please share your feedback
+through GitHub issues or join the discussion in the OTel-Rust Slack channel
+[here](https://cloud-native.slack.com/archives/C03GDP0H023).

docs/migration_0.29.md

@@ -2,11 +2,17 @@
 
 ## vNext
 
+## 0.29.0
+
+Released 2025-Mar-21
+
 - Similar to the `opentelemetry-appender-tracing` fix [2658](https://github.com/open-telemetry/opentelemetry-rust/issues/2658)
   InstrumentationScope(Logger) used by the appender now uses an empty ("") named Logger.
   Previously, a Logger with name and version of the crate was used.
   Receivers (processors, exporters) are expected to use `LogRecord.target()` as scope name.
   This is already done in OTLP Exporters, so this change should be transparent to most users.
+- Update `opentelemetry` dependency version to 0.29.
+- Update `opentelemetry-semantic-conventions` dependency version to 0.29.
 
 ## 0.28.0
 

opentelemetry-appender-log/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "opentelemetry-appender-log"
-version = "0.28.0"
+version = "0.29.0"
 description = "An OpenTelemetry appender for the log crate"
 homepage = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-appender-log"
 repository = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-appender-log"
@@ -11,12 +11,12 @@ rust-version = "1.75.0"
 edition = "2021"
 
 [dependencies]
-opentelemetry = { version = "0.28", path = "../opentelemetry", features = [
+opentelemetry = { version = "0.29", path = "../opentelemetry", features = [
   "logs",
 ] }
 log = { workspace = true, features = ["kv", "std"] }
 serde = { workspace = true, optional = true, features = ["std"] }
-opentelemetry-semantic-conventions = { version = "0.28", path = "../opentelemetry-semantic-conventions", optional = true, features = [
+opentelemetry-semantic-conventions = { version = "0.29", path = "../opentelemetry-semantic-conventions", optional = true, features = [
   "semconv_experimental",
 ] }
 

opentelemetry-appender-log/Cargo.toml

@@ -2,6 +2,10 @@
 
 ## vNext
 
+## 0.29.0
+
+Released 2025-Mar-21
+
 Fixes [1682](https://github.com/open-telemetry/opentelemetry-rust/issues/1682).
 "spec_unstable_logs_enabled" feature now do not suppress logs for other layers.
 
@@ -42,13 +46,18 @@ transparent to most users.
   implementations (SDK, processor, exporters) to leverage this additional
   information to determine if an event is enabled.
 
-- `u64` and `usize` values are stored as `opentelemetry::logs::AnyValue::Int`
+- `u64`, `i128`, `u128` and `usize` values are stored as `opentelemetry::logs::AnyValue::Int`
 when conversion is feasible. Otherwise stored as
 `opentelemetry::logs::AnyValue::String`. This avoids unnecessary string
 allocation when values can be represented in their original types.
 - Byte arrays are stored as `opentelemetry::logs::AnyValue::Bytes` instead
 of string.
+- `Error` fields are reported using attribute named "exception.message". For
+  example, the below will now report an attribute named "exception.message",
+  instead of previously reporting the user provided attribute "error".
+  `error!(....error = &OTelSdkError::AlreadyShutdown as &dyn std::error::Error...)`
 - perf - small perf improvement by avoiding string allocation of `target`
+- Update `opentelemetry` dependency version to 0.29.
 
 ## 0.28.1
 

opentelemetry-appender-tracing/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "opentelemetry-appender-tracing"
-version = "0.28.1"
+version = "0.29.0"
 edition = "2021"
 description = "An OpenTelemetry log appender for the tracing crate"
 homepage = "https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry-appender-tracing"
@@ -12,12 +12,12 @@ rust-version = "1.75.0"
 
 [dependencies]
 log = { workspace = true, optional = true }
-opentelemetry = { version = "0.28", path = "../opentelemetry", features = ["logs"] }
+opentelemetry = { version = "0.29", path = "../opentelemetry", features = ["logs"] }
 tracing = { workspace = true, features = ["std"]}
 tracing-core = { workspace = true }
 tracing-log = { workspace = true, optional = true }
 tracing-subscriber = { workspace = true, features = ["registry", "std"] }
-tracing-opentelemetry = { workspace = true, optional = true }
+# tracing-opentelemetry = { workspace = true, optional = true }
 
 [dev-dependencies]
 log = { workspace = true }
@@ -36,7 +36,8 @@ pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
 default = []
 experimental_metadata_attributes = ["dep:tracing-log"]
 spec_unstable_logs_enabled = ["opentelemetry/spec_unstable_logs_enabled"]
-experimental_use_tracing_span_context = ["tracing-opentelemetry"]
+# TODO - Enable this in 0.29.1 (once tracing-opentelemetry v0.30 is released)
+# experimental_use_tracing_span_context = ["tracing-opentelemetry"]
 
 
 [[bench]]