1
0
mirror of https://github.com/apache/httpd.git synced 2025-07-30 20:03:10 +03:00
Files
apache/docs/manual/mod/mod_lbmethod_heartbeat.xml
Christophe Jaillet 9cf83a220a Fix some formating. (extra '.', missing <code>)
Fix the number of available load balancer scheduler algorithms and add a link to the corresponding module. (lbmethod_heartbeat was missing in the list)

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1829613 13f79535-47bb-0310-9956-ffa450edef68
2018-04-19 20:25:35 +00:00

63 lines
2.6 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<modulesynopsis metafile="mod_lbmethod_heartbeat.xml.meta">
<name>mod_lbmethod_heartbeat</name>
<description>Heartbeat Traffic Counting load balancer scheduler algorithm for <module
>mod_proxy_balancer</module></description>
<status>Experimental</status>
<sourcefile>mod_lbmethod_heartbeat.c</sourcefile>
<identifier>lbmethod_heartbeat_module</identifier>
<compatibility>Available in version 2.3 and later</compatibility>
<summary>
<p><code>lbmethod=heartbeat</code> uses the services of <module
>mod_heartmonitor</module> to balance between origin servers that are providing
heartbeat info via the <module>mod_heartbeat</module> module.</p>
<p> This modules load balancing algorithm favors servers with more ready (idle)
capacity over time, but does not select the server with the most ready capacity
every time. Servers that have 0 active clients are penalized, with the
assumption that they are not fully initialized.</p>
</summary>
<seealso><module>mod_proxy</module></seealso>
<seealso><module>mod_proxy_balancer</module></seealso>
<seealso><module>mod_heartbeat</module></seealso>
<seealso><module>mod_heartmonitor</module></seealso>
<directivesynopsis>
<name>HeartbeatStorage</name>
<description>Path to read heartbeat data</description>
<syntax>HeartbeatStorage <var>file-path</var></syntax>
<default>HeartbeatStorage logs/hb.dat</default>
<contextlist><context>server config</context></contextlist>
<usage>
<p>The <directive>HeartbeatStorage</directive> directive specifies the
path to read heartbeat data. This flat-file is used only when
<module>mod_slotmem_shm</module> is not loaded.</p>
</usage>
</directivesynopsis>
</modulesynopsis>