Skip to main content

Observability

Struct Observability 

Source
pub struct Observability { /* private fields */ }
Expand description

Production observability configuration and in-process metrics state.

Implementations§

Source§

impl Observability

Source

pub fn production(service_name: impl Into<String>) -> Self

Creates production observability metadata for a service.

Source

pub fn version(self, version: impl Into<String>) -> Self

Sets the service version label used by tracing and OpenTelemetry config.

Source

pub fn environment(self, environment: impl Into<String>) -> Self

Sets the deployment environment label.

Source

pub fn prometheus(self) -> Self

Enables Prometheus text exposition for configured metrics.

Source

pub fn tracing(self) -> Self

Enables HTTP tracing when this observability object is applied by Nidus.

Source

pub fn otel_from_env(self) -> Self

No-op OpenTelemetry setup when the otel feature is disabled.

Source

pub fn without_http_metrics(self) -> Self

Disables HTTP request metrics.

Source

pub fn without_event_metrics(self) -> Self

Disables observed event metrics.

Source

pub fn without_job_metrics(self) -> Self

Disables observed job metrics.

Source

pub fn without_adapter_instrumentation(self) -> Self

Disables adapter-owned operation instrumentation.

Source

pub fn max_series(self, max_series: usize) -> Self

Caps distinct low-cardinality labels per metric family.

Source

pub fn exclude_route(self, route: impl Into<String>) -> Self

Excludes an HTTP route label from HTTP metrics.

Source

pub fn service_name(&self) -> &str

Returns the service name.

Source

pub fn version_label(&self) -> Option<&str>

Returns the configured service version label.

Source

pub fn environment_label(&self) -> Option<&str>

Returns the configured deployment environment label.

Source

pub fn http_metrics_enabled(&self) -> bool

Returns whether HTTP metrics are enabled.

Source

pub fn prometheus_enabled(&self) -> bool

Returns whether Prometheus exposition is enabled.

Source

pub fn tracing_enabled(&self) -> bool

Returns whether HTTP tracing should be applied by Nidus.

Source

pub fn prometheus_metrics(&self) -> PrometheusMetrics

Returns the underlying HTTP Prometheus collector.

Source

pub fn http_layer(&self) -> MetricsLayer<ObservabilityHttpMetricsHook>

Creates a Tower HTTP metrics layer.

Source

pub fn routes(&self) -> Router

Creates a /metrics router for Prometheus text exposition.

Source

pub fn event_observer(&self) -> ObservabilityEventObserver

Creates an event observer for nidus_events::ObservedEventBus.

Source

pub fn observed_event_bus<T>( &self, ) -> ObservedEventBus<T, ObservabilityEventObserver>
where T: Clone + Send + Sync + 'static,

Creates an observed in-process event bus wired to this observability object.

Source

pub fn job_observer(&self) -> ObservabilityJobObserver

Creates a job observer for nidus_jobs::ObservedJobRunner.

Source

pub fn job_runner(&self) -> ObservedJobRunner<ObservabilityJobObserver>

Creates an observed job runner wired to this observability object.

Source

pub fn adapter_observer(&self) -> ObservabilityAdapterObserver

Creates an adapter observer for Nidus-owned adapter operations.

Source

pub async fn instrument<Fut, T>( &self, operation: impl Into<Cow<'static, str>>, future: Fut, ) -> T
where Fut: Future<Output = T>,

Runs a future inside a named tracing span.

Source

pub fn record_module_graph_validation( &self, status: OperationStatus, duration: Duration, )

Records module graph validation owned by Nidus application bootstrap.

Source

pub fn record_lifecycle_operation( &self, operation: &'static str, status: OperationStatus, duration: Duration, )

Records application lifecycle operation telemetry.

Source

pub fn render_prometheus(&self) -> String

Renders all configured Prometheus metrics.

Trait Implementations§

Source§

impl Clone for Observability

Source§

fn clone(&self) -> Observability

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Observability

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Provider for T
where T: Send + Sync + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more