Couper Documentation

edge

Health

Defines a recurring health check request for its backend. Results can be obtained via the backends.<label>.health variables. Changes in health states and related requests will be logged. Default User-Agent will be Couper / <version> health-check if not provided via headers attribute. An unhealthy backend will return with a backend_unhealthy error.

Block nameContextLabel
beta_healthbackend blockno label

Attributes

NameTypeDefaultDescription
expected_status
tuple (int)
[200, 204, 301]
One of wanted response status codes.
expected_text
string
-
Text which the response body must contain.
failure_threshold
number
2
Failed checks needed to consider backend unhealthy.
headers
object
-
Request HTTP header fields.
interval
string
"1s"
Time interval for recheck.
path
string
-
URL path with query on backend host.
timeout
string
"1s"
Maximum allowed time limit which is bounded by interval.