Merge branch 'main' into add-shutdown-with-timeout-for-metric-exporter

Author: mohammadVatandoost

.cspell.json

@@ -42,6 +42,8 @@
         "Dwarnings",
         "EPYC",
         "flamegraph",
+        "Gerring",
+        "Grübel",
         "hasher",
         "Isobel",
         "jaegertracing",

.github/workflows/benchmark.yml

@@ -32,6 +32,8 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 10  # Fetch current commit and its parent
+      - name: "Show change commit"
+        run: git log -1
       - uses: arduino/setup-protoc@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
@@ -42,13 +44,17 @@ jobs:
         with:
           cwd: opentelemetry
           branchName: ${{ env.BRANCH_NAME }}
+      - name: "Checkout change commit"
+        run: git checkout $GITHUB_SHA
       - uses: boa-dev/criterion-compare-action@v3
         with:
           cwd: opentelemetry-appender-tracing
           features: spec_unstable_logs_enabled
           branchName: ${{ env.BRANCH_NAME }}
+      - name: "Checkout change commit"
+        run: git checkout $GITHUB_SHA
       - uses: boa-dev/criterion-compare-action@v3
         with:
           cwd: opentelemetry-sdk
-          features: rt-tokio,testing,metrics,logs,spec_unstable_metrics_views
+          features: testing,metrics,logs,spec_unstable_metrics_views,spec_unstable_logs_enabled,experimental_logs_concurrent_log_processor
           branchName: ${{ env.BRANCH_NAME }}

.github/workflows/ci.yml

@@ -58,7 +58,10 @@ jobs:
         submodules: true
     - uses: dtolnay/rust-toolchain@stable
       with:
-        components: rustfmt
+        components: rustfmt, clippy
+    - uses: taiki-e/install-action@v2
+      with:
+          tool: cargo-hack
     - uses: arduino/setup-protoc@v3
       with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -187,6 +187,7 @@ you're more than welcome to participate!
 
 ### Approvers
 
+* [Anton Grübel](https://github.com/gruebel), Baz
 * [Shaun Cox](https://github.com/shaun-cox), Microsoft
 * [Scott Gerring](https://github.com/scottgerring), Datadog
 

docs/design/logs.md

@@ -345,7 +345,25 @@ only meant for OTel components itself and anyone writing extensions like custom
 Exporters etc.
 
 // TODO: Document the principles followed when selecting severity for internal
-logs // TODO: Document how this can cause circular loop and plans to address it.
+logs
+
+When OpenTelemetry components generate logs that could potentially feed back
+into OpenTelemetry, this can result in what is known as "telemetry-induced
+telemetry." To address this, OpenTelemetry provides a mechanism to suppress such
+telemetry using the `Context`. Components are expected to mark telemetry as
+suppressed within a specific `Context` by invoking
+`Context::enter_telemetry_suppressed_scope()`. The Logs SDK implementation
+checks this flag in the current `Context` and ignores logs if suppression is
+enabled.
+
+This mechanism relies on proper in-process propagation of the `Context`.
+However, external libraries like `hyper` and `tonic`, which are used by
+OpenTelemetry in its OTLP Exporters, do not propagate OpenTelemetry's `Context`.
+As a result, the suppression mechanism does not work out-of-the-box to suppress
+logs originating from these libraries.
+
+// TODO: Document how OTLP can solve this issue without asking external
+crates to respect and propagate OTel Context.
 
 ## Summary
 

examples/logs-basic/Cargo.toml

@@ -4,6 +4,12 @@ version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
 publish = false
+autobenches = false
+
+[[bin]]
+name = "logs-basic"
+path = "src/main.rs"
+bench = false
 
 [dependencies]
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["logs"] }

examples/logs-basic/src/main.rs

@@ -15,19 +15,21 @@ fn main() {
         .with_simple_exporter(exporter)
         .build();
 
-    // For the OpenTelemetry layer, add a tracing filter to filter events from
-    // OpenTelemetry and its dependent crates (opentelemetry-otlp uses crates
-    // like reqwest/tonic etc.) from being sent back to OTel itself, thus
-    // preventing infinite telemetry generation. The filter levels are set as
-    // follows:
+    // To prevent a telemetry-induced-telemetry loop, OpenTelemetry's own internal
+    // logging is properly suppressed. However, logs emitted by external components
+    // (such as reqwest, tonic, etc.) are not suppressed as they do not propagate
+    // OpenTelemetry context. Until this issue is addressed
+    // (https://github.com/open-telemetry/opentelemetry-rust/issues/2877),
+    // filtering like this is the best way to suppress such logs.
+    //
+    // The filter levels are set as follows:
     // - Allow `info` level and above by default.
-    // - Restrict `opentelemetry`, `hyper`, `tonic`, and `reqwest` completely.
-    // Note: This will also drop events from crates like `tonic` etc. even when
-    // they are used outside the OTLP Exporter. For more details, see:
-    // https://github.com/open-telemetry/opentelemetry-rust/issues/761
+    // - Completely restrict logs from `hyper`, `tonic`, `h2`, and `reqwest`.
+    //
+    // Note: This filtering will also drop logs from these components even when
+    // they are used outside of the OTLP Exporter.
     let filter_otel = EnvFilter::new("info")
         .add_directive("hyper=off".parse().unwrap())
-        .add_directive("opentelemetry=off".parse().unwrap())
         .add_directive("tonic=off".parse().unwrap())
         .add_directive("h2=off".parse().unwrap())
         .add_directive("reqwest=off".parse().unwrap());

examples/metrics-advanced/Cargo.toml

@@ -4,6 +4,12 @@ version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
 publish = false
+autobenches = false
+
+[[bin]]
+name = "metrics-advanced"
+path = "src/main.rs"
+bench = false
 
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }

examples/metrics-basic/Cargo.toml

@@ -4,6 +4,12 @@ version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
 publish = false
+autobenches = false
+
+[[bin]]
+name = "metrics-basic"
+path = "src/main.rs"
+bench = false
 
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }

examples/tracing-grpc/Cargo.toml

@@ -4,22 +4,25 @@ version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
 publish = false
+autobenches = false
 
 [[bin]] # Bin to run the gRPC server
 name = "grpc-server"
 path = "src/server.rs"
+bench = false
 
 [[bin]] # Bin to run the gRPC client
 name = "grpc-client"
 path = "src/client.rs"
+bench = false
 
 [dependencies]
 opentelemetry = { path = "../../opentelemetry" }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["rt-tokio"] }
 opentelemetry-stdout = { workspace = true, features = ["trace"] }
 prost = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
-tonic = { workspace = true, features = ["server", "codegen", "channel", "prost"] }
+tonic = { workspace = true, features = ["server", "codegen", "channel", "prost", "router"] }
 
 [build-dependencies]
 tonic-build = { workspace = true }