Skip to content

Health Check Monitor

The HealthCheckMonitor model defines the mechanism used to verify the availability and responsiveness of pool members or pools. These monitors determine whether traffic should be sent to a given backend based on the result of periodic checks.

Health checks can be applied at the Pool or Pool Member level. If a Pool Member has its own monitor, it takes precedence over the monitor defined on the Pool.

Relationships

  • Can be assigned to one or more VirtualServer, LoadBalancerPool, or LoadBalancerPoolMember models.
  • May be associated with a Tenant.

Notes

  • Health check monitors must be created before they can be assigned.
  • Different check types (e.g., ICMP, TCP, HTTP) may require different port configurations.
  • If port is not defined, some vendors may fall back to the service port defined on the pool member or use a protocol-specific default.

Fields

Field Type Required Description
name string Yes Unique identifier for the health check monitor.
interval integer Yes Time in seconds between each check.
retry integer Yes Number of failures before considering the target down.
timeout integer Yes Time in seconds to wait for a response before marking as failed.
port integer No Port to check against. Optional depending on health check type.
health_check_type choice Yes Type of check (e.g., TCP, HTTP, ICMP).
tenant ForeignKey to Tenant No Optional tenant assignment.