Struct Health 

pub struct Health { /* private fields */ }

A registry of health checks.

Implementations

impl Health

pub fn new() -> Self

An empty registry, with a five-second deadline per check.

pub fn register<F, Fut>(self, name: impl Into<String>, check: F) -> Self

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

Add a check.

It receives the application, so it can resolve whatever it needs to prove — which is the point: a check that does not touch the dependency is a check that reports the dependency is fine when it is not.

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

How long a single check may take before it counts as failed.

None removes the deadline, which is almost always wrong: a probe that hangs leaves the replica in an unknown state, and an orchestrator that cannot decide does nothing at all.

pub fn describing_build(self, build: impl Serialize) -> Self

Include this build description in the report.

Pass build_info!() — the version and commit belong in the same document as the health, because the first two questions of an incident are “is it up” and “which one is it”.

pub fn names(&self) -> Vec<&str>

The names registered, in order.

pub async fn run(&self, app: Arc<Application>) -> Report

Run every check.

Concurrently: a report of six checks that take a second each should take a second, not six, because a probe has a deadline of its own and a slow report is a failed one.

pub async fn render(&self, app: Arc<Application>) -> Response

Run every check and render the document a probe reads.

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 Debug for Health

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

Formats the value using the given formatter.

impl Default for Health

fn default() -> Self

Returns the “default value” for a type.