diff options
Diffstat (limited to 'docs/manual/mod/mod_heartmonitor.xml')
| -rw-r--r-- | docs/manual/mod/mod_heartmonitor.xml | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/docs/manual/mod/mod_heartmonitor.xml b/docs/manual/mod/mod_heartmonitor.xml index 9028040f56..1627c479ca 100644 --- a/docs/manual/mod/mod_heartmonitor.xml +++ b/docs/manual/mod/mod_heartmonitor.xml @@ -20,19 +20,19 @@ limitations under the License. --> -<modulesynopsis metafile="mod_heartbeat.xml.meta"> +<modulesynopsis metafile="mod_heartmonitor.xml.meta"> <name>mod_heartmonitor</name> <description>centralized monitor for mod_heartbeat origin servers</description> <status>Experimental</status> -<sourcefile>mod_heartmonitor</sourcefile> +<sourcefile>mod_heartmonitor.c</sourcefile> <identifier>heartmonitor_module</identifier> <compatibility>Available in Apache 2.3 and later</compatibility> <summary> <p> <module>mod_heartmonitor</module> listens for server status messages generated -by <module>mod_heartbeat</module> enabled servers and makes their status +by <module>mod_heartbeat</module> enabled origin servers and makes their status available to <module>mod_lbmethod_heartbeat</module>. This allows <directive module="mod_proxy">ProxyPass</directive> to use the "heartbeat" <em>lbmethod</em> inside of <directive module="mod_proxy">ProxyPass</directive>. @@ -41,22 +41,34 @@ available to <module>mod_lbmethod_heartbeat</module>. This allows <p>This module uses the services of <module>mod_slotmem_shm</module> when available instead of flat-file storage. No configuration is required to use <module>mod_slotmem_shm</module>.</p> + + <note type="warning"> + To use <module>mod_heartmonitor</module>, + <module>mod_status</module> and <module>mod_watchdog</module> + must be either a static modules or, if a dynamic module, it must + be loaded before <module>mod_heartmonitor</module>. + </note> + </summary> <directivesynopsis> <name>HeartbeatListen</name> -<description>address to listen for incoming heartbeat requests </description> +<description>multicast address to listen for incoming heartbeat requests </description> <syntax>HeartbeatListen<var>addr:port</var></syntax> <default>disabled</default> <contextlist><context>server config</context></contextlist> <usage> <p>The <directive>HeartbeatListen</directive> directive specifies the - address the server will listen on for status information from + multicast address on which the server will listen for status information from <module>mod_heartbeat</module>-enabled servers. This address will usually corrspond to a configured <directive module="mod_heartbeat">HeartbeatAddress</directive> on an origin server. </p> + + <example> + HeartbeatListen 239.0.0.1:27999 + </example> <p> This module is inactive until this directive is used.</p> </usage> @@ -88,7 +100,7 @@ heartbeat requests to this server</description> <p>The <directive>HeartbeatMaxServers</directive> 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.</p> + to store the heartbeat info when <module>mod_slotmem_shm</module> is in use.</p> </usage> </directivesynopsis> </modulesynopsis> |