Struct HealthCheck

#[non_exhaustive]
pub struct HealthCheck {
    pub target: String,
    pub interval: i32,
    pub timeout: i32,
    pub unhealthy_threshold: i32,
    pub healthy_threshold: i32,
}

Information about a health check.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target: String

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

interval: i32

The approximate interval, in seconds, between health checks of an individual instance.

timeout: i32

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

unhealthy_threshold: i32

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

healthy_threshold: i32

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Implementations

impl HealthCheck

pub fn target(&self) -> &str

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

pub fn interval(&self) -> i32

The approximate interval, in seconds, between health checks of an individual instance.

pub fn timeout(&self) -> i32

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

pub fn unhealthy_threshold(&self) -> i32

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

pub fn healthy_threshold(&self) -> i32

The number of consecutive health checks successes required before moving the instance to the Healthy state.

impl HealthCheck

pub fn builder() -> HealthCheckBuilder

Creates a new builder-style object to manufacture HealthCheck.

Trait Implementations

impl Clone for HealthCheck

fn clone(&self) -> HealthCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheck

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

Formats the value using the given formatter.

impl PartialEq for HealthCheck

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HealthCheck