granicus.if.org Git - apache/blob - docs/manual/mod/mod_heartbeat.html.en

   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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_heartbeat - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_heartbeat</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_heartbeat.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Sends messages with server status to frontend proxy</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>heartbeat_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_heartbeat</td></tr>
  35 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
  36 <h3>Summary</h3>
  37
  38 <p> <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code> sends multicast messages to a <code class="module"><a href="../mod/mod_heartmonitor.html">mod_heartmonitor</a></code> listener
  39 that advertises the servers current connection count.  Usually, <code class="module"><a href="../mod/mod_heartmonitor.html">mod_heartmonitor</a></code>
  40 will be running on a proxy server with <code class="module"><a href="../mod/mod_lbmethod_heartbeat.html">mod_lbmethod_heartbeat</a></code> loaded, which allows
  41 <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> to use the "heartbeat" <em>lbmethod</em> inside
  42 of <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code>.</p>
  43 <p>
  44     <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code> itself is loaded on the origin server(s) that serve requests
  45     through the proxy server(s).
  46 </p>
  47
  48     <div class="warning">
  49         To use <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code>,
  50         <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>
  51         must be either a static modules or, if a dynamic module, must
  52         be loaded before <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code>.
  53     </div>
  54
  55 </div>
  56 <div id="quickview"><h3>Topics</h3>
  57 <ul id="topics">
  58 <li><img alt="" src="../images/down.gif" /> <a href="#consuming">Consuming mod_heartbeat Output</a></li>
  59 </ul><h3 class="directives">Directives</h3>
  60 <ul id="toc">
  61 <li><img alt="" src="../images/down.gif" /> <a href="#heartbeataddress">HeartbeatAddress</a></li>
  62 </ul>
  63 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_heartbeat">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_heartbeat">Report a bug</a></li></ul><h3>See also</h3>
  64 <ul class="seealso">
  65 <li><a href="#comments_section">Comments</a></li></ul></div>
  66 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  67 <div class="section">
  68 <h2><a name="consuming" id="consuming">Consuming mod_heartbeat Output</a></h2>
  69
  70   <p>
  71       Every 1 second, this module generates a single multicast UDP
  72       packet, containing the number of busy and idle workers.  The
  73       packet is a simple ASCII format, similar to GET query parameters
  74       in HTTP.
  75   </p>
  76
  77 <div class="example"><h3>An Example Packet</h3><p><code>
  78 v=1&amp;ready=75&amp;busy=0
  79 </code></p></div>
  80
  81   <p>
  82     Consumers should handle new variables besides busy and ready,
  83     separated by '&amp;', being added in the future.
  84   </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="HeartbeatAddress" id="HeartbeatAddress">HeartbeatAddress</a> <a name="heartbeataddress" id="heartbeataddress">Directive</a></h2>
  89 <table class="directive">
  90 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Multicast address for heartbeat packets</td></tr>
  91 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeartbeatAddress <var>addr:port</var></code></td></tr>
  92 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>disabled</code></td></tr>
  93 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  94 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  95 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_heartbeat</td></tr>
  96 </table>
  97 <p>The <code class="directive">HeartbeatAddress</code> directive specifies the
  98 multicast address to which <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code> will send
  99 status information. This address will usually correspond to a configured
 100  <code class="directive"><a href="../mod/mod_heartmonitor.html#heartbeatlisten">HeartbeatListen</a></code> on a
 101 frontend proxy system.</p>
 102 <pre class="prettyprint lang-config">HeartbeatAddress 239.0.0.1:27999</pre>
 103
 104
 105 </div>
 106 </div>
 107 <div class="bottomlang">
 108 <p><span>Available Languages: </span><a href="../en/mod/mod_heartbeat.html" title="English">&nbsp;en&nbsp;</a></p>
 109 </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&amp;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>
 110 <script type="text/javascript"><!--//--><![CDATA[//><!--
 111 var comments_shortname = 'httpd';
 112 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_heartbeat.html';
 113 (function(w, d) {
 114     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 115         d.write('<div id="comments_thread"><\/div>');
 116         var s = d.createElement('script');
 117         s.type = 'text/javascript';
 118         s.async = true;
 119         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 120         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 121     }
 122     else {
 123         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 124     }
 125 })(window, document);
 126 //--><!]]></script></div><div id="footer">
 127 <p class="apache">Copyright 2016 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>
 128 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
 129 if (typeof(prettyPrint) !== 'undefined') {
 130     prettyPrint();
 131 }
 132 //--><!]]></script>
 133 </body></html>