feat(admin): Return error status code from admin console if tracing is disabled on startup.

crates/iota-node/src/admin.rs

@@ -18,7 +18,7 @@ use iota_types::{
     error::IotaError,
 };
 use serde::Deserialize;
-use telemetry_subscribers::TracingHandle;
+use telemetry_subscribers::{TelemetryError, TracingHandle};
 use tokio::sync::oneshot;
 use tracing::info;
 
@@ -204,6 +204,10 @@ async fn enable_tracing(
             response.push(format!("filter will be reset after {:?}", duration));
             (StatusCode::OK, response.join("\n"))
         }
+        Err(TelemetryError::TracingDisabled) => {
+            response.push("tracing is not supported as it was disabled in the node's TelemetryConfig\nignoring request".into());
+            (StatusCode::FORBIDDEN, response.join("\n"))
+        }
         Err(err) => {
             response.push(format!("can't update filter: {:?}", err));
             (StatusCode::BAD_REQUEST, response.join("\n"))
@@ -212,11 +216,19 @@ async fn enable_tracing(
 }
 
 async fn reset_tracing(State(state): State<Arc<AppState>>) -> (StatusCode, String) {
-    state.tracing_handle.reset_trace();
-    (
-        StatusCode::OK,
-        "tracing filter reset to TRACE_FILTER env var".into(),
-    )
+    match state.tracing_handle.reset_trace() {
+        Ok(()) => {
+            (
+                StatusCode::OK,
+                "tracing filter reset to TRACE_FILTER env var".into(),
+            )
+        }
+        Err(TelemetryError::TracingDisabled) => (
+            StatusCode::FORBIDDEN,
+            "tracing was disabled in the node's TelemetryConfig. so it is not supported\nignoring request".into(),
+        ),
+        Err(err) => (StatusCode::INTERNAL_SERVER_ERROR, err.to_string()),
+    }
 }
 
 async fn get_filter(State(state): State<Arc<AppState>>) -> (StatusCode, String) {

crates/telemetry-subscribers/Cargo.toml

@@ -22,6 +22,7 @@ opentelemetry-proto = "0.7"
 opentelemetry_sdk = { version = "0.24", features = ["rt-tokio"] }
 prometheus.workspace = true
 prost.workspace = true
+thiserror.workspace = true
 tokio = { workspace = true, features = ["full"] }
 tonic.workspace = true
 tracing.workspace = true

crates/telemetry-subscribers/src/lib.rs

@@ -24,6 +24,7 @@ use opentelemetry_sdk::{
     trace::{BatchSpanProcessor, Sampler, ShouldSample, TracerProvider},
 };
 use span_latency_prom::PrometheusSpanLatencyLayer;
+use thiserror::Error;
 use tracing::{Level, error, info, metadata::LevelFilter};
 use tracing_appender::non_blocking::{NonBlocking, WorkerGuard};
 use tracing_subscriber::{EnvFilter, Layer, Registry, filter, fmt, layer::SubscriberExt, reload};
@@ -36,6 +37,15 @@ pub mod span_latency_prom;
 /// Alias for a type-erased error type.
 pub type BoxError = Box<dyn std::error::Error + Send + Sync + 'static>;
 
+#[derive(Debug, Error)]
+pub enum TelemetryError {
+    #[error("OTLP protocol not enabled in the node's configuration")]
+    TracingDisabled,
+
+    #[error("{0}")]
+    Other(#[from] BoxError),
+}
+
 /// Configuration for different logging/tracing options
 /// ===
 /// - json_log_output: Output JSON logs to stdout only.
@@ -107,9 +117,8 @@ impl FilterHandle {
     }
 
     pub fn get(&self) -> Result<String, BoxError> {
-        self.0
-            .with_current(|filter| filter.to_string())
-            .map_err(Into::into)
+        let result = self.0.with_current(|filter| filter.to_string())?;
+        Ok(result)
     }
 }
 
@@ -143,9 +152,9 @@ impl TracingHandle {
         &self,
         directives: S,
         duration: Duration,
-    ) -> Result<(), BoxError> {
+    ) -> Result<(), TelemetryError> {
         if let Some(trace) = &self.trace {
-            let res = trace.update(directives);
+            trace.update(directives)?;
             // after duration is elapsed, reset to the env setting
             let trace = trace.clone();
             let trace_filter_env = env::var("TRACE_FILTER").unwrap_or_else(|_| "off".to_string());
@@ -155,23 +164,24 @@ impl TracingHandle {
                     error!("failed to reset trace filter: {}", e);
                 }
             });
-            res
+            Ok(())
         } else {
             info!("tracing not enabled, ignoring update");
-            Ok(())
+            Err(TelemetryError::TracingDisabled)
         }
     }
 
     pub fn clear_file_output(&self) {
         self.file_output.clear_path();
     }
 
-    pub fn reset_trace(&self) {
+    pub fn reset_trace(&self) -> Result<(), TelemetryError> {
         if let Some(trace) = &self.trace {
             let trace_filter_env = env::var("TRACE_FILTER").unwrap_or_else(|_| "off".to_string());
-            if let Err(e) = trace.update(trace_filter_env) {
-                error!("failed to reset trace filter: {}", e);
-            }
+            trace.update(trace_filter_env).map_err(|e| e.into())
+        } else {
+            info!("tracing not enabled, ignoring reset");
+            Err(TelemetryError::TracingDisabled)
         }
     }
 }