Struct Health

pub struct Health {
    pub refresh_interval_ms: u64,
    pub max_memory_bytes: Option<ByteSize>,
    pub max_memory_percent: f32,
    pub probe_timeout_ms: u64,
    pub memory_stat_refresh_frequency_ms: u64,
}

Settings to control Relay’s health checks.

After breaching one of the configured thresholds, Relay will return an unhealthy status from its health endpoint.

Fields

refresh_interval_ms: u64

Interval to refresh internal health checks.

Shorter intervals will decrease the time it takes the health check endpoint to report issues, but can also increase sporadic unhealthy responses.

Defaults to `3000`` (3 seconds).

max_memory_bytes: Option<ByteSize>

Maximum memory watermark in bytes.

By default, there is no absolute limit set and the watermark is only controlled by setting Self::max_memory_percent.

max_memory_percent: f32

Maximum memory watermark as a percentage of maximum system memory.

Defaults to 0.95 (95%).

probe_timeout_ms: u64

Health check probe timeout in milliseconds.

Any probe exceeding the timeout will be considered failed. This limits the max execution time of Relay health checks.

Defaults to 900 milliseconds.

memory_stat_refresh_frequency_ms: u64

The refresh frequency of memory stats which are used to poll memory usage of Relay.

The implementation of memory stats guarantees that the refresh will happen at least every x ms since memory readings are lazy and are updated only if needed.

Trait Implementations

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.

impl<'de> Deserialize<'de> for Health

where Health: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Health

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.