Struct health::Config

pub struct Config {
    pub check_interval: Duration,
    pub min_failures: u8,
    pub min_successes: u8,
    pub leeway: Duration,
}

Configuration for a periodic health check

Defaults:

• Checks every 5 seconds
• Becomes unhealthy after 3 consecutive failures
• Becomes healthy on first success
• Becomes unreliable if no completed checks in 15 seconds

Fields

check_interval: Duration

Interval over which to periodically run the health check

min_failures: u8

Minimum number of consecutive failures to flip an healthy health check to unhealthy

min_successes: u8

Minimum number of consecutive successes to flip an unhealthy health check to healthy

leeway: Duration

Leeway between updated before the health check status is no longer considered current

To deal with variation, this should generally not be less than twice the check_interval.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Config

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl StructuralEq for Config

impl StructuralPartialEq for Config