Struct HealthConfig 

#[non_exhaustive]
pub struct HealthConfig {
    pub enabled: bool,
    pub path: String,
    pub live_path: String,
    pub ready_path: String,
    pub startup_path: String,
}

Health-probe endpoint configuration.

Paths are configurable so an embedder can relocate the probes (e.g. behind a /internal/ prefix) or disable them when a fronting platform supplies its own. Defaults match the conventional /health* layout.

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.

enabled: bool

Mount the health endpoints. Default: true.

path: String

Aggregate health endpoint. Default: /health.

live_path: String

Liveness probe. Default: /health/live.

ready_path: String

Readiness probe (checks the upstream gRPC health). Default: /health/ready.

startup_path: String

Startup probe. Default: /health/startup.

Trait Implementations

impl Clone for HealthConfig

fn clone(&self) -> HealthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthConfig

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

Formats the value using the given formatter.

impl Default for HealthConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HealthConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.