// Copyright 2024 RustFS Team // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use crate::AppConfig; use crate::telemetry::{OtelGuard, init_telemetry}; use opentelemetry::metrics::Meter; use rustfs_config::APP_NAME; use std::sync::{Arc, Mutex}; use tokio::sync::{OnceCell, SetError}; use tracing::{error, info}; /// Global guard for OpenTelemetry tracing static GLOBAL_GUARD: OnceCell>> = OnceCell::const_new(); /// Flag indicating if observability is enabled pub(crate) static IS_OBSERVABILITY_ENABLED: OnceCell = OnceCell::const_new(); /// Name of the observability meter pub(crate) static OBSERVABILITY_METER_NAME: OnceCell = OnceCell::const_new(); /// Check whether Observability is enabled pub fn is_observability_enabled() -> bool { IS_OBSERVABILITY_ENABLED.get().copied().unwrap_or(false) } /// Get the global meter for observability pub fn global_meter() -> Meter { let meter_name = OBSERVABILITY_METER_NAME.get().map(|s| s.as_str()).unwrap_or(APP_NAME); opentelemetry::global::meter(meter_name) } /// Error type for global guard operations #[derive(Debug, thiserror::Error)] pub enum GlobalError { #[error("Failed to set global guard: {0}")] SetError(#[from] SetError>>), #[error("Global guard not initialized")] NotInitialized, #[error("Global system metrics err: {0}")] MetricsError(String), #[error("Failed to get current PID: {0}")] PidError(String), #[error("Process with PID {0} not found")] ProcessNotFound(u32), #[error("Failed to get physical core count")] CoreCountError, #[error("GPU initialization failed: {0}")] GpuInitError(String), #[error("GPU device not found: {0}")] GpuDeviceError(String), #[error("Failed to send log: {0}")] SendFailed(&'static str), #[error("Operation timed out: {0}")] Timeout(&'static str), } /// Initialize the observability module /// /// # Parameters /// - `config`: Configuration information /// /// # Returns /// A tuple containing the logger and the telemetry guard /// /// # Example /// ```no_run /// use rustfs_obs::init_obs; /// /// # #[tokio::main] /// # async fn main() { /// let guard = init_obs(None).await; /// # } /// ``` pub async fn init_obs(endpoint: Option) -> OtelGuard { // Load the configuration file let config = AppConfig::new_with_endpoint(endpoint); init_telemetry(&config.observability) } /// Set the global guard for OpenTelemetry /// /// # Arguments /// * `guard` - The OtelGuard instance to set globally /// /// # Returns /// * `Ok(())` if successful /// * `Err(GuardError)` if setting fails /// /// # Example /// ```rust /// use rustfs_obs::{ init_obs, set_global_guard}; /// /// async fn init() -> Result<(), Box> { /// let guard = init_obs(None).await; /// set_global_guard(guard)?; /// Ok(()) /// } /// ``` pub fn set_global_guard(guard: OtelGuard) -> Result<(), GlobalError> { info!("Initializing global OpenTelemetry guard"); GLOBAL_GUARD.set(Arc::new(Mutex::new(guard))).map_err(GlobalError::SetError) } /// Get the global guard for OpenTelemetry /// /// # Returns /// * `Ok(Arc>)` if guard exists /// * `Err(GuardError)` if guard not initialized /// /// # Example /// ```rust /// use rustfs_obs::get_global_guard; /// /// async fn trace_operation() -> Result<(), Box> { /// let guard = get_global_guard()?; /// let _lock = guard.lock().unwrap(); /// // Perform traced operation /// Ok(()) /// } /// ``` pub fn get_global_guard() -> Result>, GlobalError> { GLOBAL_GUARD.get().cloned().ok_or(GlobalError::NotInitialized) } /// Try to get the global guard for OpenTelemetry /// /// # Returns /// * `Some(Arc>)` if guard exists /// * `None` if guard not initialized pub fn try_get_global_guard() -> Option>> { GLOBAL_GUARD.get().cloned() } #[cfg(test)] mod tests { use super::*; #[tokio::test] async fn test_get_uninitialized_guard() { let result = get_global_guard(); assert!(matches!(result, Err(GlobalError::NotInitialized))); } }