| <?xml version="1.0"?> |
| <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd"> |
| <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?> |
| <!-- $LastChangedRevision$ --> |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <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.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 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>. |
| </p> |
| |
| <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>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 |
| multicast address on which the server will listen for status information from |
| <module>mod_heartbeat</module>-enabled servers. This |
| address will usually correspond to a configured <directive |
| module="mod_heartbeat">HeartbeatAddress</directive> on an origin server. |
| </p> |
| |
| <highlight language="config"> |
| HeartbeatListen 239.0.0.1:27999 |
| </highlight> |
| |
| <p> This module is inactive until this directive is used.</p> |
| </usage> |
| </directivesynopsis> |
| |
| <directivesynopsis> |
| <name>HeartbeatStorage</name> |
| <description>Path to store heartbeat data</description> |
| <syntax>HeartbeatStorage <var>file-path</var></syntax> |
| <default>HeartbeatStorage logs/hb.dat</default> |
| <contextlist><context>server config</context></contextlist> |
| |
| <usage> |
| <p>The <directive>HeartbeatStorage</directive> directive specifies the |
| path to store heartbeat data. This flat-file is used only when |
| <module>mod_slotmem_shm</module> is not loaded.</p> |
| </usage> |
| </directivesynopsis> |
| |
| <directivesynopsis> |
| <name>HeartbeatMaxServers</name> |
| <description>Specifies the maximum number of servers that will be sending |
| heartbeat requests to this server</description> |
| <syntax>HeartbeatMaxServers <var>number-of-servers</var></syntax> |
| <default>HeartbeatMaxServers 10</default> |
| <contextlist><context>server config</context></contextlist> |
| |
| <usage> |
| <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 when <module>mod_slotmem_shm</module> is in use.</p> |
| </usage> |
| </directivesynopsis> |
| </modulesynopsis> |