From 433c7e8820cc60a417f78998925585dba76c3c02 Mon Sep 17 00:00:00 2001 From: Jim Jagielski Date: Thu, 11 Feb 2016 14:05:48 +0000 Subject: [PATCH] more docco: health check and status. Basic info git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1729837 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/howto/reverse_proxy.html.en | 46 ++++++++++++++++++++++++- docs/manual/howto/reverse_proxy.xml | 46 +++++++++++++++++++++++-- 2 files changed, 89 insertions(+), 3 deletions(-) diff --git a/docs/manual/howto/reverse_proxy.html.en b/docs/manual/howto/reverse_proxy.html.en index 78e46d4fa3..f68e8aad8f 100644 --- a/docs/manual/howto/reverse_proxy.html.en +++ b/docs/manual/howto/reverse_proxy.html.en @@ -61,6 +61,8 @@
  • Balancer and BalancerMember configuration
  • Failover
  • Balancer Manager
    • +
  • Dynamic Health Checks
    • +
  • BalancerMember status flags
    • top
    @@ -226,7 +228,7 @@ ProxyPassReverse "/images" "balancer://myset" needs to be added to your configuration:

    -
    <Location "/balancer-manager">
+    
    <Location "/balancer-manager">
     SetHandler balancer-manager
     Require host localhost
 </Location>
    
@@ -262,6 +264,48 @@ ProxyPassReverse "/images"  "balancer://myset"
    BalancerPersist is enabled.

    +
    top
    +
    +

    Dynamic Health Checks

    + + +

    + Before httpd proxies a request to a worker, it can "test" if that worker + is available via setting the ping parameter for that worker using + ProxyPass. Oftentimes it is + more useful to check the health of the workers out of band, in a + dynamic fashion. This is achieved in Apache httpd by the + mod_proxy_hcheck module. +

    + +
    top
    +
    +

    BalancerMember status flags

    + + +

    + In the balancer-manager the current state, or status, of a worker + is displayed and can be set/reset. The meanings of these statuses are as follows: +

    + + + + + + + + + + + +
    FlagStringDescription
     OkWorker is available
     InitWorker has been initialized
    DDisWorker is disabled and will not accept any requests; will be + automatically retried.
    SStopWorker is administratively stopped; will not accept requests + and will not be automatically retried
    IIgnWorker is in ignore-errors mode and will always be considered available.
    HStbyWorker is in hot-standby mode and will only be used if no other + viable workers are available.
    EErrWorker is in an error state, usually due to failing pre-request check; + requests will not be proxied to this worker, but it will be retried depending on + the retry setting of the worker.
    NDrnWorker is in drain mode and will only accept existing sticky sessions + destined for itself and ignore all other requests.
    CHcFlWorker has failed dynamic health check and will not be used until it + passes subsequent health checks.

    Available Languages:  en  | diff --git a/docs/manual/howto/reverse_proxy.xml b/docs/manual/howto/reverse_proxy.xml index 348192d167..edbb824ffa 100644 --- a/docs/manual/howto/reverse_proxy.xml +++ b/docs/manual/howto/reverse_proxy.xml @@ -231,12 +231,12 @@ ProxyPassReverse "/images" "balancer://myset" needs to be added to your configuration:

    - + <Location "/balancer-manager"> SetHandler balancer-manager Require host localhost </Location> - + Warning

    Do not enable the balancer-manager until you have +

    + Dynamic Health Checks + +

    + Before httpd proxies a request to a worker, it can "test" if that worker + is available via setting the ping parameter for that worker using + ProxyPass. Oftentimes it is + more useful to check the health of the workers out of band, in a + dynamic fashion. This is achieved in Apache httpd by the + mod_proxy_hcheck module. +

    + +
    + +
    + BalancerMember status flags + +

    + In the balancer-manager the current state, or status, of a worker + is displayed and can be set/reset. The meanings of these statuses are as follows: +

    + + + + + + + + + + + +
    FlagStringDescription
     OkWorker is available
     InitWorker has been initialized
    DDisWorker is disabled and will not accept any requests; will be + automatically retried.
    SStopWorker is administratively stopped; will not accept requests + and will not be automatically retried
    IIgnWorker is in ignore-errors mode and will always be considered available.
    HStbyWorker is in hot-standby mode and will only be used if no other + viable workers are available.
    EErrWorker is in an error state, usually due to failing pre-request check; + requests will not be proxied to this worker, but it will be retried depending on + the retry setting of the worker.
    NDrnWorker is in drain mode and will only accept existing sticky sessions + destined for itself and ignore all other requests.
    CHcFlWorker has failed dynamic health check and will not be used until it + passes subsequent health checks.
    +
    + -- 2.49.0