Modules |Directives |FAQ |Glossary |Sitemap
Apache HTTP Server Version 2.4
| Description: | Centralized monitor for mod_heartbeat origin servers |
|---|---|
| Status: | Experimental |
| Module Identifier: | heartmonitor_module |
| Source File: | mod_heartmonitor.c |
| Compatibility: | Available in Apache 2.3 and later |
mod_heartmonitor listens for server status messages generatedbymod_heartbeat enabled origin servers and makes their statusavailable tomod_lbmethod_heartbeat. This allowsProxyPass to use the "heartbeat"lbmethod inside ofProxyPass.
This module uses the services ofmod_slotmem_shm whenavailable instead of flat-file storage. No configuration is required tousemod_slotmem_shm.
mod_heartmonitor,mod_status andmod_watchdog must be either a static modules or, if a dynamic module, it must be loaded beforemod_heartmonitor.
| Description: | multicast address to listen for incoming heartbeat requests |
|---|---|
| Syntax: | HeartbeatListenaddr:port |
| Default: | disabled |
| Context: | server config |
| Status: | Experimental |
| Module: | mod_heartmonitor |
TheHeartbeatListen directive specifies the multicast address on which the server will listen for status information frommod_heartbeat-enabled servers. This address will usually correspond to a configuredHeartbeatAddress on an origin server.
HeartbeatListen 239.0.0.1:27999
This module is inactive until this directive is used.
| Description: | Specifies the maximum number of servers that will be sendingheartbeat requests to this server |
|---|---|
| Syntax: | HeartbeatMaxServersnumber-of-servers |
| Default: | HeartbeatMaxServers 10 |
| Context: | server config |
| Status: | Experimental |
| Module: | mod_heartmonitor |
| Compatibility: | The value of 0 is accepted only in 2.4.55 and above |
TheHeartbeatMaxServers 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 whenmod_slotmem_shm is in use.
For using flat-file storage (without loadingmod_slotmem_shm), this must be set to 0. The value must be either 0, or bigger or equals 10.
| Description: | Path to store heartbeat data when using flat-file storage |
|---|---|
| Syntax: | HeartbeatStoragefile-path |
| Default: | HeartbeatStorage logs/hb.dat |
| Context: | server config |
| Status: | Experimental |
| Module: | mod_heartmonitor |
TheHeartbeatStorage directive specifies the path to store heartbeat data. This flat-file is used only whenmod_slotmem_shm is not loaded andHeartbeatMaxServers is set to 0.
Copyright 2025 The Apache Software Foundation.
Licensed under theApache License, Version 2.0.
