1<?xml version="1.0" encoding="UTF-8"?>
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=UTF-8" http-equiv="Content-Type" />
5<!--
6        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7              This file is generated from xml source: DO NOT EDIT
8        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9      -->
10<title>mod_lbmethod_heartbeat - Apache HTTP Server Version 2.4</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/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>
21<p class="apache">Apache HTTP Server Version 2.4</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.4</a> &gt; <a href="./">Modules</a></div>
26<div id="page-content">
27<div id="preamble"><h1>Apache Module mod_lbmethod_heartbeat</h1>
28<div class="toplang">
29<p><span>Available Languages: </span><a href="../en/mod/mod_lbmethod_heartbeat.html" title="English">&nbsp;en&nbsp;</a> |
30<a href="../fr/mod/mod_lbmethod_heartbeat.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
31</div>
32<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Heartbeat Traffic Counting load balancer scheduler algorithm for <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></td></tr>
33<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
34<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>lbmethod_heartbeat_module</td></tr>
35<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_lbmethod_heartbeat.c</td></tr>
36<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3 and later</td></tr></table>
37<h3>Summary</h3>
38
39<p><code>lbmethod=heartbeat</code> uses the services of <code class="module"><a href="../mod/mod_heartmonitor.html">mod_heartmonitor</a></code> to balance between origin servers that are providing
40heartbeat info via the <code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code> module.</p>
41
42<p> This modules load balancing algorithm favors servers with more ready (idle)
43capacity over time, but does not select the server with the most ready capacity
44every time.  Servers that have 0 active clients are penalized, with the
45assumption that they are not fully initialized.</p>
46</div>
47<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3 class="directives">Directives</h3>
48<ul id="toc">
49<li><img alt="" src="../images/down.gif" /> <a href="#heartbeatstorage">HeartbeatStorage</a></li>
50</ul>
51<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_lbmethod_heartbeat">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_lbmethod_heartbeat">Report a bug</a></li></ul><h3>See also</h3>
52<ul class="seealso">
53<li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
54<li><code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code></li>
55<li><code class="module"><a href="../mod/mod_heartbeat.html">mod_heartbeat</a></code></li>
56<li><code class="module"><a href="../mod/mod_heartmonitor.html">mod_heartmonitor</a></code></li>
57<li><a href="#comments_section">Comments</a></li></ul></div>
58
59<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
60<div class="directive-section"><h2><a name="HeartbeatStorage" id="HeartbeatStorage">HeartbeatStorage</a> <a name="heartbeatstorage" id="heartbeatstorage">Directive</a></h2>
61<table class="directive">
62<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Path to read heartbeat data</td></tr>
63<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeartbeatStorage <var>file-path</var></code></td></tr>
64<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HeartbeatStorage logs/hb.dat</code></td></tr>
65<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
66<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
67<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lbmethod_heartbeat</td></tr>
68</table>
69    <p>The <code class="directive">HeartbeatStorage</code> directive specifies the
70    path to read heartbeat data.  This flat-file is used only when
71    <code class="module"><a href="../mod/mod_slotmem_shm.html">mod_slotmem_shm</a></code> is not loaded.</p>
72
73</div>
74</div>
75<div class="bottomlang">
76<p><span>Available Languages: </span><a href="../en/mod/mod_lbmethod_heartbeat.html" title="English">&nbsp;en&nbsp;</a> |
77<a href="../fr/mod/mod_lbmethod_heartbeat.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
78</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 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 <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
79<script type="text/javascript"><!--//--><![CDATA[//><!--
80var comments_shortname = 'httpd';
81var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_lbmethod_heartbeat.html';
82(function(w, d) {
83    if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
84        d.write('<div id="comments_thread"><\/div>');
85        var s = d.createElement('script');
86        s.type = 'text/javascript';
87        s.async = true;
88        s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
89        (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
90    }
91    else {
92        d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
93    }
94})(window, document);
95//--><!]]></script></div><div id="footer">
96<p class="apache">Copyright 2022 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>
97<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[//><!--
98if (typeof(prettyPrint) !== 'undefined') {
99    prettyPrint();
100}
101//--><!]]></script>
102</body></html>