From 6beeb1b708550be0d4a53b272283e17e5e35fe17 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 17:01:30 +0200 Subject: Adding upstream version 2.4.57. Signed-off-by: Daniel Baumann --- docs/manual/mod/mod_heartbeat.html.en | 135 ++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 docs/manual/mod/mod_heartbeat.html.en (limited to 'docs/manual/mod/mod_heartbeat.html.en') diff --git a/docs/manual/mod/mod_heartbeat.html.en b/docs/manual/mod/mod_heartbeat.html.en new file mode 100644 index 0000000..74bb242 --- /dev/null +++ b/docs/manual/mod/mod_heartbeat.html.en @@ -0,0 +1,135 @@ + + + + + +mod_heartbeat - Apache HTTP Server Version 2.4 + + + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.4

+
+
<-
+ +
+

Apache Module mod_heartbeat

+
+

Available Languages:  en  | + fr 

+
+ + + + +
Description:Sends messages with server status to frontend proxy
Status:Experimental
Module Identifier:heartbeat_module
Source File:mod_heartbeat
Compatibility:Available in Apache 2.3 and later
+

Summary

+ +

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.

+

+ mod_heartbeat itself is loaded on the origin server(s) that serve requests + through the proxy server(s). +

+ +
+ To use mod_heartbeat, + mod_status and mod_watchdog + must be either a static modules or, if a dynamic module, must + be loaded before mod_heartbeat. +
+ +
+ +
top
+
+

Consuming mod_heartbeat Output

+ +

+ Every 1 second, this module generates a single multicast UDP + packet, containing the number of busy and idle workers. The + packet is a simple ASCII format, similar to GET query parameters + in HTTP. +

+ +

An Example Packet

+v=1&ready=75&busy=0 +

+ +

+ Consumers should handle new variables besides busy and ready, + separated by '&', being added in the future. +

+ +
+
top
+

HeartbeatAddress Directive

+ + + + + + + +
Description:Multicast address for heartbeat packets
Syntax:HeartbeatAddress addr:port
Default:disabled
Context:server config
Status:Experimental
Module:mod_heartbeat
+

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

+
HeartbeatAddress 239.0.0.1:27999
+ + +
+
+
+

Available Languages:  en  | + fr 

+
top

Comments

Notice:
This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our mailing lists.
+
+ \ No newline at end of file -- cgit v1.2.3