Struct AppHealthCheck

pub struct AppHealthCheck { /* private fields */ }

Application health check aggregating health from multiple components.

Implementations

impl AppHealthCheck

pub fn new( slow_time_limit: Option<Duration>, hard_time_limit: Option<Duration>, ) -> Self

pub fn override_limits( &self, slow_time_limit: Option<Duration>, hard_time_limit: Option<Duration>, )

pub fn expose_metrics(&self)

Sets the info metrics for the metrics time limits. This method should be called at most once when all the health checks are collected.

pub fn set_details(&self, details: impl Serialize)

Sets app-level health details. They can include build info etc.

pub fn insert_component( &self, health_check: ReactiveHealthCheck, ) -> Result<(), AppHealthCheckError>

Inserts health check for a component.

Errors

Returns an error if the component with the same name is already defined.

pub fn insert_custom_component( &self, health_check: Arc<dyn CheckHealth>, ) -> Result<(), AppHealthCheckError>

Inserts a custom health check for a component.

Errors

Returns an error if the component with the same name is already defined.

pub async fn check_health(&self) -> AppHealth

Checks the overall application health. This will query all component checks concurrently.

Trait Implementations

impl Debug for AppHealthCheck

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

Formats the value using the given formatter.

impl Default for AppHealthCheck

fn default() -> Self

Returns the “default value” for a type.