Skip to main content

HealthRegistry

Struct HealthRegistry 

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

Active health state shared by one or more BackendViews.

Registries use full backend identity by default. Callers can supply an equivalence key to intentionally share probes across backend variants.

Implementations§

Source§

impl HealthRegistry

Source

pub fn new() -> Self

Create an empty registry keyed by full backend identity.

Source

pub fn with_equivalence( equivalence_key: impl Fn(&Backend) -> u64 + Send + Sync + 'static, ) -> Self

Create an empty registry using equivalence_key to group targets.

Backends that produce the same u64 key share one health state and probe. Callers are responsible for ensuring that backends which need independent health state produce distinct keys.

Source

pub fn set_health_check(&self, hc: Box<dyn HealthCheck + Send + Sync + 'static>)

Set the health-check implementation used by every view in this registry.

§Panics

Panics if a health check has already been set.

Source

pub fn target_count(&self) -> usize

Return the number of distinct backend targets currently being tracked.

Targets that produce the same registry health key count as one target.

Source

pub async fn run_health_check(&self, parallel: bool)

Run one active health-check pass over the union of all registered views.

When parallel is true, all targets are checked concurrently.

Dropping the returned future cancels the pass: outstanding per-target checks are aborted rather than left running to completion, so targets not yet reported keep their previous health.

Trait Implementations§

Source§

impl Default for HealthRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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