Struct HealthAPIHandler

Source

pub struct HealthAPIHandler { /* private fields */ }

Expand description

An API handler for reporting the health of all components.

This handler exposes two main routes – /health/ready and /health/live – which return the overall readiness and liveness of all registered components, respectively. Each route will return a successful response (200 OK) if all components are ready/live, or a failure response (503 Service Unavailable) if any (or all) of the components are not ready/live, respectively.

In both cases, the response body will be a JSON object with all registered components, each with their individual readiness and liveness status, as well as the response latency (in seconds) for the component to respond to the latest liveness probe.

HealthAPIHandler

Struct HealthAPIHandler Copy item path

Trait Implementations§

impl APIHandler for HealthAPIHandler

type State = HealthRegistryState

fn generate_initial_state(&self) -> Self::State

fn generate_routes(&self) -> Router<Self::State>

Auto Trait Implementations§

impl Freeze for HealthAPIHandler

impl RefUnwindSafe for HealthAPIHandler

impl Send for HealthAPIHandler

impl Sync for HealthAPIHandler

impl Unpin for HealthAPIHandler

impl UnwindSafe for HealthAPIHandler

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<T> Track for T

fn track_allocations(self, token: AllocationGroupToken) -> Tracked<Self>

fn in_current_allocation_group(self) -> Tracked<Self>

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct HealthAPIHandler

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

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

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

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

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

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

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