Add custom OpenTelemetrySpanExt trait

crates/block-producer/src/block_builder/mod.rs

@@ -4,7 +4,7 @@ use std::{
 };
 
 use futures::FutureExt;
-use miden_node_utils::tracing::{OpenTelemetrySpanExt, OtelStatus};
+use miden_node_utils::tracing::OpenTelemetrySpanExt;
 use miden_objects::{
     account::AccountId,
     batch::ProvenBatch,
@@ -106,7 +106,7 @@ impl BlockBuilder {
             .and_then(|proven_block| async { self.inject_failure(proven_block) })
             .and_then(|proven_block| self.commit_block(mempool, proven_block))
             // Handle errors by propagating the error to the root span and rolling back the block.
-            .inspect_err(|err| Span::current().set_status(OtelStatus::Error { description: format!("{err:?}").into() }))
+            .inspect_err(|err| Span::current().set_error(err))
             .or_else(|_err| self.rollback_block(mempool).never_error())
             // Error has been handled, this is just type manipulation to remove the result wrapper.
             .unwrap_or_else(|_| ())

crates/utils/Cargo.toml

@@ -28,6 +28,7 @@ opentelemetry         = { version = "0.28" }
 opentelemetry-otlp    = { version = "0.28", default-features = false, features = ["grpc-tonic", "tls-roots", "trace"] }
 opentelemetry_sdk     = { version = "0.28", features = ["rt-tokio"] }
 rand                  = { workspace = true }
+sealed                = { version = "0.6" }
 serde                 = { version = "1.0", features = ["derive"] }
 thiserror             = { workspace = true }
 tonic                 = { workspace = true }

crates/utils/src/tracing/mod.rs

@@ -1,6 +1,27 @@
 pub mod grpc;
 
-// Re-export useful traits for open-telemetry traces. This avoids requiring other crates from
-// importing that family of crates directly.
-pub use opentelemetry::trace::Status as OtelStatus;
-pub use tracing_opentelemetry::OpenTelemetrySpanExt;
+use opentelemetry::trace::Status as OtelStatus;
+use opentelemetry::{Key, Value};
+use sealed::sealed;
+
+/// Utility functions based on [`tracing_opentelemetry::OpenTelemetrySpanExt`].
+#[sealed]
+pub trait OpenTelemetrySpanExt {
+    fn set_attribute(&self, key: impl Into<Key>, value: impl Into<Value>);
+    fn set_error(&self, err: &dyn std::error::Error);
+}
+
+#[sealed]
+impl OpenTelemetrySpanExt for tracing::Span {
+    /// Sets an attribute on `Span`.
+    fn set_attribute(&self, key: impl Into<Key>, value: impl Into<Value>) {
+        tracing_opentelemetry::OpenTelemetrySpanExt::set_attribute(self, key, value);
+    }
+    /// Sets a status on `Span` based on an error.
+    fn set_error(&self, err: &dyn std::error::Error) {
+        tracing_opentelemetry::OpenTelemetrySpanExt::set_status(
+            self,
+            OtelStatus::Error { description: format!("{err:?}").into() },
+        );
+    }
+}