Struct relay_config::Health

pub struct Health {
    pub sys_info_refresh_interval_secs: u64,
    pub max_memory_bytes: Option<ByteSize>,
    pub max_memory_percent: f32,
    pub probe_timeout_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

sys_info_refresh_interval_secs: u64

Interval in which Relay will refresh system information, like current memory usage.

Defaults to 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.

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.