From fe9a4232978275ed3945dada2a4e1e16dc942fab Mon Sep 17 00:00:00 2001 From: Jim Jagielski Date: Sun, 17 Jan 2016 21:06:19 +0000 Subject: [PATCH] Prelim docs git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1725129 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_proxy_hcheck.xml | 108 +++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 docs/manual/mod/mod_proxy_hcheck.xml diff --git a/docs/manual/mod/mod_proxy_hcheck.xml b/docs/manual/mod/mod_proxy_hcheck.xml new file mode 100644 index 0000000000..de866591bb --- /dev/null +++ b/docs/manual/mod/mod_proxy_hcheck.xml @@ -0,0 +1,108 @@ + + + + + + + + + +mod_proxy_hcheck +Dynamic health check of Balancer members (workers) for +mod_proxy +Extension +mod_proxy_hcheck.c +proxy_hcheck_module +Available in Apache 2.5.0 and later + + +

This module provides for dynamic health checking of balancer + members (workers). This can be enabled on a worker-by-worker + basis. The health check is done independently of the + actual reverse proxy requests.

+ +

This module requires the service of mod_watchdog.

+ +Parameters +

The health check mechanism is enabled via the use of additional + BalancerMember parameters, which are configured in the standard + way via ProxyPass:

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterDefaultDescription
hcmethodNoneNo dynamic health check performed. Choices are: + + + + + + + + + +
MethodDescription
NoneNo dynamic health checking done
TCPCheck that a socket to the backend can be created: e.g. "are you up"
OPTIONSSend an HTTP OPTIONS request to the backend
HEADSend an HTTP HEAD request to the backend
GETSend an HTTP GET request to the backend
CPINGAJP onlyDo CPING/CPONG check
PROVIDERName of provider to be used to check health
+
hcpasses1Number of successful health check tests before worker is re-enabled
hcfails1Number of failed health check tests before worker is disabled
hcinterval30Period of health checks (e.g. performed every 30 seconds)
hcuri Additional URI to be appended to the worker URL for the health check.
hctemplate Name of template, created via ProxyHCTemplate to use for setting health check parameters for this worker
+ + + +mod_proxy + + +ProxyHCTemplate +Creates a named template for setting various health check parameters +ProxyBadHeader name parameter=setting >...< +server configvirtual host + + + +

The ProxyHCTemplate directive allows + for creating a named set (template) of health check parameters + that can then be assigned to balancer members via the hctemplate + parameter

+ + ProxyHCTemplate + +ProxyHCTemplate tcp5 hcmethod=tcp hcinterval=5 +ProxyPass "/apps" "http://backend.example.com/" hctemplate=tcp5 + + + + + + + -- 2.40.0