Struct Observability 

pub struct Observability { /* private fields */ }

Available on crate feature observability only.

The configured telemetry providers. Cheap to clone; every clone refers to the same providers.

Dropping the last clone without calling shutdown lets the SDK flush on drop, which may block; call shutdown explicitly (Kerniq’s App does so after draining connections).

Implementations

impl Observability

pub fn builder() -> ObservabilityBuilder

Starts configuring observability.

pub fn disabled() -> Observability

A handle with every signal disabled.

pub fn service(&self) -> &ServiceInfo

The service identity.

pub fn resource(&self) -> &Resource

Available on crate features logs or metrics or tracing only.

The OpenTelemetry resource attached to every signal.

pub fn meter(&self, name: &'static str) -> Meter

Available on crate feature metrics only.

A meter for application instruments. Create instruments once and reuse them; recording is lock-free in the common case. Returns a no-op meter when metrics are disabled, so instrumentation code never needs to check.

pub fn meter_provider(&self) -> Option<&SdkMeterProvider>

Available on crate feature metrics only.

The SDK meter provider, when metrics are enabled.

pub fn tracer(&self, name: &'static str) -> SdkTracer

Available on crate feature tracing only.

A tracer for manual spans through the OpenTelemetry API. Most code should use tracing spans instead, which are exported through the same provider.

pub fn tracer_provider(&self) -> Option<&SdkTracerProvider>

Available on crate feature tracing only.

The SDK tracer provider, when tracing is enabled.

pub fn propagator(&self) -> Arc<dyn TextMapPropagator + Send + Sync>

Available on crate feature tracing only.

The W3C TraceContext + Baggage propagator, for outbound calls (see kerniq_observability_axum::propagation).

pub fn logger_provider(&self) -> Option<&SdkLoggerProvider>

Available on crate feature logs only.

The SDK logger provider, when log export is enabled.

pub fn prometheus(&self) -> Option<&PrometheusExporter>

Available on crate feature prometheus only.

The Prometheus endpoint, when configured.

pub fn http_instrumentation(&self) -> HttpInstrumentation

HTTP instrumentation configured from this handle: metrics when metrics are enabled, spans and W3C propagation when tracing is enabled, and the configured exclusions (the Prometheus path is always excluded).

pub fn stats(&self) -> TelemetryStats

Export-pipeline counters (see TelemetryStats). Also published as the kerniq.telemetry.items and kerniq.telemetry.exports metrics.

pub fn force_flush(&self) -> Vec<String>

Exports everything buffered now. Blocks the calling thread until the exporters return; use from spawn_blocking in async code.

pub async fn shutdown(&self) -> ShutdownReport

Flushes and shuts down every provider, in at most the configured shutdown timeout. Idempotent; later calls return immediately.

Call it after the server has stopped accepting requests and drained (Kerniq’s App does this automatically). Providers are shut down on Tokio’s blocking pool, so the async runtime stays responsive even if a Collector is unreachable; the caller waits at most the timeout.

pub fn install_global_providers(&self)

Sets this handle’s providers and propagator as the OpenTelemetry globals (opentelemetry::global), for libraries that instrument through the global API. Never done implicitly.

pub fn tracing_layer<S>(&self) -> Box<dyn Layer<S> + Send + Sync>

where S: Subscriber + for<'a> LookupSpan<'a> + Send + Sync,

Available on crate features logs or tracing only.

The tracing layers for this configuration (console output, span export, log export), each with its own filter, for composing into an application-owned subscriber (with install_subscriber(false)).

use tracing_subscriber::layer::SubscriberExt;
use kerniq_observability::prelude::*;

let observability = Observability::builder()
    .logs(LogsConfig::json())
    .install_subscriber(false)
    .build()
    .await?;
let subscriber = tracing_subscriber::registry()
    .with(observability.tracing_layer())
    // .with(your_other_layer)
    ;
tracing::subscriber::set_global_default(subscriber).unwrap();

Trait Implementations

impl Clone for Observability

fn clone(&self) -> Observability

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Observability

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.