From 9d61a32935babab73a39723623def6052922b73e Mon Sep 17 00:00:00 2001 From: Eric Covener Date: Tue, 3 Jan 2012 20:37:22 +0000 Subject: [PATCH] Merge r1226603, r1226775 from trunk: fill in the heartbeat modules' documentation. add heartbeat to list of lb methods living in other modules. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1226940 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_heartbeat.xml | 23 ++++++--- docs/manual/mod/mod_heartmonitor.xml | 55 ++++++++++++++++++---- docs/manual/mod/mod_lbmethod_heartbeat.xml | 20 ++++++-- docs/manual/mod/mod_proxy_balancer.xml | 5 +- 4 files changed, 79 insertions(+), 24 deletions(-) diff --git a/docs/manual/mod/mod_heartbeat.xml b/docs/manual/mod/mod_heartbeat.xml index d1485fc90b..ca824e647d 100644 --- a/docs/manual/mod/mod_heartbeat.xml +++ b/docs/manual/mod/mod_heartbeat.xml @@ -23,24 +23,33 @@ mod_heartbeat - -Extension -mod_heartbeat.c +sends messages with server status to frontend proxy +Experimental +mod_heartbeat heartbeat_module -Available in 2.3 and later +Available in Apache 2.3 and later - This document is still under development. +

mod_heartbeat sends multicast messages to a mod_heartmonitor listener +that advertises the servers current connection count. Usually, mod_heartmonitor +will be running on a proxy server with mod_lbmethod_heartbeat loaded, which allows +ProxyPass to use the "heartbeat" lbmethod inside +of ProxyPass.

 HeartbeatAddress Address to send heartbeat requests - +HeartbeatAddress addr:port +disabled server config - This document is still under development. +

The HeartbeatAddress directive specifies the + address mod_heartbeat will send status information to. This + address will usually corrspond to a configured HeartbeatListen on a frontend + proxy system.

diff --git a/docs/manual/mod/mod_heartmonitor.xml b/docs/manual/mod/mod_heartmonitor.xml index 6ba3380a64..9028040f56 100644 --- a/docs/manual/mod/mod_heartmonitor.xml +++ b/docs/manual/mod/mod_heartmonitor.xml @@ -20,27 +20,45 @@ limitations under the License. --> - + mod_heartmonitor - -Extension -mod_heartmonitor.c +centralized monitor for mod_heartbeat origin servers +Experimental +mod_heartmonitor heartmonitor_module -Available in 2.3 and later +Available in Apache 2.3 and later - This document is still under development. +

+mod_heartmonitor listens for server status messages generated +by mod_heartbeat enabled servers and makes their status +available to mod_lbmethod_heartbeat. This allows +ProxyPass to use the "heartbeat" +lbmethod inside of ProxyPass. +

+ +

This module uses the services of mod_slotmem_shm when +available instead of flat-file storage. No configuration is required to +use mod_slotmem_shm.

 HeartbeatListen -Address to listen for heartbeat requests - +address to listen for incoming heartbeat requests +HeartbeatListenaddr:port +disabled server config - This document is still under development. +

The HeartbeatListen directive specifies the + address the server will listen on for status information from + mod_heartbeat-enabled servers. This + address will usually corrspond to a configured HeartbeatAddress on an origin server. +

+ +

This module is inactive until this directive is used.

 @@ -52,8 +70,25 @@ server config - This document is still under development. +

The HeartbeatStorage directive specifies the + path to store heartbeat data. This flat-file is used only when + mod_slotmem_shm is not loaded.

 + +HeartbeatMaxServers +Specifies the maximum number of servers that will be sending +heartbeat requests to this server +HeartbeatMaxServers number-of-servers +HeartbeatMaxServers 10 +server config + + +

The HeartbeatMaxServers directive specifies the + maximum number of servers that will be sending requests to this monitor + server. It is used to control the size of the shared memory allocated + to store the heartbeat info.

+ + diff --git a/docs/manual/mod/mod_lbmethod_heartbeat.xml b/docs/manual/mod/mod_lbmethod_heartbeat.xml index 7e831c55e5..26dfa88433 100644 --- a/docs/manual/mod/mod_lbmethod_heartbeat.xml +++ b/docs/manual/mod/mod_lbmethod_heartbeat.xml @@ -23,15 +23,24 @@ mod_lbmethod_heartbeat - This document is still under development. -Extension +Heartbeat Traffic Counting load balancer scheduler algorithm for mod_proxy_balancer +Experimental mod_lbmethod_heartbeat.c lbmethod_heartbeat_module Available in version 2.3 and later - This document is still under development. +

lbmethod=heartbeat uses the services of mod_heartmonitor to balance between origin servers that are providing +heartbeat info via the mod_heartbeat module.

+ +

This modules load balancing algorithm favors servers with more ready (idle) +capacity over time, but does not select the server with the most ready capacity +every time. Servers that have 0 active clients are penalized, with the +assumption that they are not fully initialized.

 + mod_proxy mod_proxy_balancer mod_heartbeat @@ -45,8 +54,9 @@ server config - This document is still under development. +

The HeartbeatStorage directive specifies the + path to read heartbeat data. This flat-file is used only when + mod_slotmem_shm is not loaded.

 - diff --git a/docs/manual/mod/mod_proxy_balancer.xml b/docs/manual/mod/mod_proxy_balancer.xml index 97fed36667..bc6160c7d4 100644 --- a/docs/manual/mod/mod_proxy_balancer.xml +++ b/docs/manual/mod/mod_proxy_balancer.xml @@ -38,8 +38,9 @@

Load balancing scheduler algorithm is provided by not this module but other modules such as: mod_lbmethod_byrequests, - mod_lbmethod_bytraffic and - mod_lbmethod_bybusyness. + mod_lbmethod_bytraffic, + mod_lbmethod_bybusyness and + mod_lbmethod_heartbeat.

Thus, in order to get the ability of load balancing, -- 2.40.0