Struct GrpcHealthCheck 

pub struct GrpcHealthCheck {
    pub consecutive_success: usize,
    pub consecutive_failure: usize,
    /* private fields */
}

gRPC health check implementing Pingora’s HealthCheck trait

This health check connects to a gRPC server and calls the standard grpc.health.v1.Health/Check method to verify the server is healthy.

Fields

consecutive_success: usize

Number of consecutive successes required to flip from unhealthy to healthy

consecutive_failure: usize

Number of consecutive failures required to flip from healthy to unhealthy

Implementations

impl GrpcHealthCheck

pub fn new(service: String, timeout: Duration) -> Self

Create a new gRPC health check

Arguments

• service - The service name to check. Empty string checks overall server health.
• timeout - Timeout for the health check RPC call

Trait Implementations

impl Default for GrpcHealthCheck

fn default() -> Self

Returns the “default value” for a type.

impl HealthCheck for GrpcHealthCheck

fn check<'life0, 'life1, 'async_trait>( &'life0 self, target: &'life1 Backend, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if the backend is healthy using gRPC health protocol

fn health_threshold(&self, success: bool) -> usize

Return the health threshold for flipping health status

• success: true - returns consecutive_success (unhealthy -> healthy)
• success: false - returns consecutive_failure (healthy -> unhealthy)

fn health_status_change<'life0, 'life1, 'async_trait>( &'life0 self, _target: &'life1 Backend, _healthy: bool, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Sync + 'async_trait,

Called when the health changes for a Backend.

fn backend_summary(&self, target: &Backend) -> String

Called when a detailed Backend summary is needed.