removed some of the debug logging and added author details
[httpd-crcsyncproxy.git] / modules / cluster / README.heartbeat
blobe216db67990fe3b54dc4a815a914a0984ef29e76
1 mod_heartbeat
3 Broadcasts the current Apache Connection status over multicast.
5 Example Configuration:
6   HeartbeatAddress 239.0.0.1:27999
8 Dependencies:
9   mod_status must be either a static module, or if a dynamic module, it must be 
10   loaded before mod_heartbeat.
13 Consuming:
14   Every 1 second, this module generates a single multicast UDP packet,
15   containing the number of busy and idle workers.
16   
17   The packet is a simple ASCII format, similiar to GET query parameters in UDP.
18   
19   An Example packet:
20     v=1&ready=75&busy=0
22   Consumers should handle new variables besides busy and ready, separated by '&'
23   being added in the future.
24   
25 Misc:
26   The interval of 1 seconds is controlled by the HEARTBEAT_INTERVAL
27   compile time define.  This is not currently tunable at run time. To make this
28   module send the status packet more often, you must add to the CFLAGS used to
29   compile the module to include:
30     -DHEARTBEAT_INTERVAL=3
31   Would cause the broadcasts to be sent every 3 seconds.