Struct Health 

pub struct Health { /* private fields */ }

Health check registry, see the module documentation. Cloning gives another handle to the same registry.

Implementations

impl Health

pub fn new() -> Self

pub fn check<F, Fut, E>(self, name: &str, check: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), E>> + Send + 'static, E: Display,

A dependency the service cannot work without: when it fails, readiness is 503

pub fn optional<F, Fut, E>(self, name: &str, check: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), E>> + Send + 'static, E: Display,

A dependency the service can live without: when it fails, readiness stays 200 but reports degraded

pub fn timeout(self, timeout: Duration) -> Self

Longest a single check may take before it counts as failed (default 2 seconds)

pub fn cache_for(self, ttl: Duration) -> Self

Reuse the last result for this long (default 1 second, zero disables). Concurrent probes share one run of the checks either way.

pub fn expose_errors(self) -> Self

Include the error text of failed checks in the response. Off by default because messages can reveal hostnames and internals.

pub fn liveness( &self, ) -> impl Fn(Request) -> BoxFuture<'static, Result<Response>> + Send + Sync + Clone + 'static

Handler for liveness probes: 200 {"status":"up"} as long as the server responds

pub fn readiness( &self, ) -> impl Fn(Request) -> BoxFuture<'static, Result<Response>> + Send + Sync + Clone + 'static

Handler for readiness probes, see the module documentation

Trait Implementations

impl Clone for Health

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Health

fn default() -> Self

Returns the “default value” for a type.