Struct ObservabilityHandle 

pub struct ObservabilityHandle { /* private fields */ }

Handle for managing the observability system lifecycle.

This handle provides graceful shutdown for all initialized observability components. It holds references to the tracing handle and metrics server, allowing coordinated shutdown of all components.

Example

let config = ObservabilityConfig::default();
let handle = init_observability(config).await?;

// ... application runs ...

// Graceful shutdown
handle.shutdown().await?;

Implementations

impl ObservabilityHandle

pub async fn shutdown(self) -> Result<(), ObservabilityError>

Shutdown all observability components gracefully.

This method:

1. Shuts down the tracing system (flushes pending spans)
2. Shuts down the metrics server (stops HTTP server)

After calling this method, no more telemetry will be exported.

Errors

Returns an error if any component fails to shut down gracefully.

Example

let handle = init_observability(config).await?;

// Graceful shutdown
handle.shutdown().await?;

pub fn metrics_registry(&self) -> &MetricsRegistry

Returns a reference to the metrics registry.

The metrics registry is always available, even if the metrics server was not started. This allows applications to collect metrics without exposing them via HTTP.

Example

let handle = init_observability(config).await?;

// Access metrics registry
let counter = handle.metrics_registry().register_counter("my_counter", vec![]);
counter.inc();

pub fn is_metrics_server_running(&self) -> bool

Returns true if the metrics server is running.