From 5e618b7677c7294e4720444f24212e2af0156e90 Mon Sep 17 00:00:00 2001 From: Jesper Brix Rosenkilde Date: Mon, 12 May 2025 22:37:21 +0200 Subject: [PATCH] Add documentation for missing directives in active health checks (#470) --- .../caddyfile/directives/reverse_proxy.md | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/src/docs/markdown/caddyfile/directives/reverse_proxy.md b/src/docs/markdown/caddyfile/directives/reverse_proxy.md index c4164fd..36ceaaa 100644 --- a/src/docs/markdown/caddyfile/directives/reverse_proxy.md +++ b/src/docs/markdown/caddyfile/directives/reverse_proxy.md @@ -71,15 +71,17 @@ reverse_proxy [] [] { lb_retry_match # active health checking - health_uri - health_upstream - health_port - health_interval - health_passes - health_fails - health_timeout - health_status - health_body + health_uri + health_upstream + health_port + health_interval + health_passes + health_fails + health_timeout + health_method + health_status + health_request_body + health_body health_follow_redirects health_headers { [] @@ -339,8 +341,12 @@ Active health checks perform health checking in the background on a timer. To en - **health_timeout** is a [duration value](/docs/conventions#durations) that defines how long to wait for a reply before marking the backend as down. Default: `5s`. +- **health_method** is the HTTP method to use for the active health check. Default: `GET`. + - **health_status** is the HTTP status code to expect from a healthy backend. Can be a 3-digit status code, or a status code class ending in `xx`. For example: `200` (which is the default), or `2xx`. +- **health_request_body** is a string representing the request body to send with the active health check. + - **health_body** is a substring or regular expression to match on the response body of an active health check. If the backend does not return a matching body, it will be marked as down. - **health_follow_redirects** will cause the health check to follow redirects provided by upstream. By default, a redirect response would cause the health check to count as a fail.