Struct HealthCheckService 

pub struct HealthCheckService {
    pub health_check_frequency: Option<Duration>,
    pub parallel_health_check: bool,
    /* private fields */
}

Background service that runs one health-check loop for a shared HealthRegistry.

Use this service with views created by BackendView::new_with_health_registry. Load balancers backed by Backends::new already schedule their private registry and must not also run a HealthCheckService for it.

In periodic mode (health_check_frequency set) the service signals readiness after its first health-check pass, including when no views have published targets yet, and publishing the first target wakes it for an immediate pass. In one-shot mode (health_check_frequency is None) the service instead waits for the first published target before running its single pass and signaling readiness, so it never checks an empty registry and returns before any target exists.

Fields

health_check_frequency: Option<Duration>

How frequently to run health checks.

If None, health checks run once when the service starts.

parallel_health_check: bool

Whether to check all targets concurrently.

Implementations

impl HealthCheckService

pub async fn run( &self, shutdown: ShutdownWatch, ready_opt: Option<ServiceReadyNotifier>, )

Run health checks for the shared registry until shutdown.

impl HealthCheckService

pub fn new(registry: Arc<HealthRegistry>) -> Self

Create a health-check service for registry.

A health check must be configured on registry before the service is started. Starting without one fails closed without signaling readiness.

Trait Implementations

impl BackgroundService for HealthCheckService

fn start_with_ready_notifier<'life0, 'async_trait>( &'life0 self, shutdown: ShutdownWatch, ready: ServiceReadyNotifier, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

This function is called when the pingora server tries to start all the services. The background service should signal readiness by calling ready_notifier.notify_ready() once initialization is complete. The service can return at anytime or wait for the shutdown signal.

fn start<'life0, 'async_trait>( &'life0 self, shutdown: ShutdownWatch, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

This function is called when the pingora server tries to start all the services. The background service can return at anytime or wait for the shutdown signal.