1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_heartmonitor - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_heartmonitor</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_heartmonitor.html" title="English"> en </a> | 28<a href="/fr/mod/mod_heartmonitor.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 29</div> 30<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Centralized monitor for mod_heartbeat origin servers</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>heartmonitor_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_heartmonitor.c</td></tr> 34<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table> 35<h3>Summary</h3> 36 37<p> 38<code class="module"><a href="/mod/mod_heartmonitor.html">mod_heartmonitor</a></code> listens for server status messages generated 39by <code class="module"><a href="/mod/mod_heartbeat.html">mod_heartbeat</a></code> enabled origin servers and makes their status 40available to <code class="module"><a href="/mod/mod_lbmethod_heartbeat.html">mod_lbmethod_heartbeat</a></code>. This allows 41<code class="directive"><a href="/mod/mod_proxy.html#proxypass">ProxyPass</a></code> to use the "heartbeat" 42<em>lbmethod</em> inside of <code class="directive"><a href="/mod/mod_proxy.html#proxypass">ProxyPass</a></code>. 43</p> 44 45<p>This module uses the services of <code class="module"><a href="/mod/mod_slotmem_shm.html">mod_slotmem_shm</a></code> when 46available instead of flat-file storage. No configuration is required to 47use <code class="module"><a href="/mod/mod_slotmem_shm.html">mod_slotmem_shm</a></code>.</p> 48 49 <div class="warning"> 50 To use <code class="module"><a href="/mod/mod_heartmonitor.html">mod_heartmonitor</a></code>, 51 <code class="module"><a href="/mod/mod_status.html">mod_status</a></code> and <code class="module"><a href="/mod/mod_watchdog.html">mod_watchdog</a></code> 52 must be either a static modules or, if a dynamic module, it must 53 be loaded before <code class="module"><a href="/mod/mod_heartmonitor.html">mod_heartmonitor</a></code>. 54 </div> 55 56</div> 57<div id="quickview"><h3 class="directives">Directives</h3> 58<ul id="toc"> 59<li><img alt="" src="/images/down.gif" /> <a href="#heartbeatlisten">HeartbeatListen</a></li> 60<li><img alt="" src="/images/down.gif" /> <a href="#heartbeatmaxservers">HeartbeatMaxServers</a></li> 61<li><img alt="" src="/images/down.gif" /> <a href="#heartbeatstorage">HeartbeatStorage</a></li> 62</ul> 63<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 64 65<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 66<div class="directive-section"><h2><a name="HeartbeatListen" id="HeartbeatListen">HeartbeatListen</a> <a name="heartbeatlisten" id="heartbeatlisten">Directive</a></h2> 67<table class="directive"> 68<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>multicast address to listen for incoming heartbeat requests </td></tr> 69<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeartbeatListen<var>addr:port</var></code></td></tr> 70<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>disabled</code></td></tr> 71<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 72<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 73<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_heartmonitor</td></tr> 74</table> 75 <p>The <code class="directive">HeartbeatListen</code> directive specifies the 76 multicast address on which the server will listen for status information from 77 <code class="module"><a href="/mod/mod_heartbeat.html">mod_heartbeat</a></code>-enabled servers. This 78 address will usually correspond to a configured <code class="directive"><a href="/mod/mod_heartbeat.html#heartbeataddress">HeartbeatAddress</a></code> on an origin server. 79 </p> 80 81 <pre class="prettyprint lang-config">HeartbeatListen 239.0.0.1:27999</pre> 82 83 84 <p> This module is inactive until this directive is used.</p> 85 86</div> 87<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 88<div class="directive-section"><h2><a name="HeartbeatMaxServers" id="HeartbeatMaxServers">HeartbeatMaxServers</a> <a name="heartbeatmaxservers" id="heartbeatmaxservers">Directive</a></h2> 89<table class="directive"> 90<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the maximum number of servers that will be sending 91heartbeat requests to this server</td></tr> 92<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeartbeatMaxServers <var>number-of-servers</var></code></td></tr> 93<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HeartbeatMaxServers 10</code></td></tr> 94<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 95<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 96<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_heartmonitor</td></tr> 97</table> 98 <p>The <code class="directive">HeartbeatMaxServers</code> directive specifies the 99 maximum number of servers that will be sending requests to this monitor 100 server. It is used to control the size of the shared memory allocated 101 to store the heartbeat info when <code class="module"><a href="/mod/mod_slotmem_shm.html">mod_slotmem_shm</a></code> is in use.</p> 102 103</div> 104<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 105<div class="directive-section"><h2><a name="HeartbeatStorage" id="HeartbeatStorage">HeartbeatStorage</a> <a name="heartbeatstorage" id="heartbeatstorage">Directive</a></h2> 106<table class="directive"> 107<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Path to store heartbeat data</td></tr> 108<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeartbeatStorage <var>file-path</var></code></td></tr> 109<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HeartbeatStorage logs/hb.dat</code></td></tr> 110<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 111<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr> 112<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_heartmonitor</td></tr> 113</table> 114 <p>The <code class="directive">HeartbeatStorage</code> directive specifies the 115 path to store heartbeat data. This flat-file is used only when 116 <code class="module"><a href="/mod/mod_slotmem_shm.html">mod_slotmem_shm</a></code> is not loaded.</p> 117 118</div> 119</div> 120<div class="bottomlang"> 121<p><span>Available Languages: </span><a href="/en/mod/mod_heartmonitor.html" title="English"> en </a> | 122<a href="/fr/mod/mod_heartmonitor.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 123</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />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 again 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 Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 124<script type="text/javascript"><!--//--><![CDATA[//><!-- 125var comments_shortname = 'httpd'; 126var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_heartmonitor.html'; 127(function(w, d) { 128 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 129 d.write('<div id="comments_thread"><\/div>'); 130 var s = d.createElement('script'); 131 s.type = 'text/javascript'; 132 s.async = true; 133 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 134 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 135 } 136 else { 137 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 138 } 139})(window, document); 140//--><!]]></script></div><div id="footer"> 141<p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> 142<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 143if (typeof(prettyPrint) !== 'undefined') { 144 prettyPrint(); 145} 146//--><!]]></script> 147</body></html>
