granicus.if.org Git - apache/blob - docs/manual/mod/mod_lbmethod_heartbeat.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_lbmethod_heartbeat.xml.meta">
  24
  25 <name>mod_lbmethod_heartbeat</name>
  26 <description>Heartbeat Traffic Counting load balancer scheduler algorithm for <module
  27 >mod_proxy_balancer</module></description>
  28 <status>Experimental</status>
  29 <sourcefile>mod_lbmethod_heartbeat.c</sourcefile>
  30 <identifier>lbmethod_heartbeat_module</identifier>
  31 <compatibility>Available in version 2.3 and later</compatibility>
  32
  33 <summary>
  34 <p>lbmethod=heartbeat uses the services of <module
  35 >mod_heartmonitor</module> to balance between origin servers that are providing
  36 heartbeat info via the <module>mod_heartbeat</module> module.</p>
  37
  38 <p> This modules load balancing algorithm favors servers with more ready (idle)
  39 capacity over time, but does not select the server with the most ready capacity
  40 every time.  Servers that have 0 active clients are penalized, with the
  41 assumption that they are not fully initialized.</p>
  42 </summary>
  43
  44 <seealso><module>mod_proxy</module></seealso>
  45 <seealso><module>mod_proxy_balancer</module></seealso>
  46 <seealso><module>mod_heartbeat</module></seealso>
  47 <seealso><module>mod_heartmonitor</module></seealso>
  48
  49 <directivesynopsis>
  50 <name>HeartbeatStorage</name>
  51 <description>Path to read heartbeat data</description>
  52 <syntax>HeartbeatStorage <var>file-path</var></syntax>
  53 <default>HeartbeatStorage logs/hb.dat</default>
  54 <contextlist><context>server config</context></contextlist>
  55
  56 <usage>
  57     <p>The <directive>HeartbeatStorage</directive> directive specifies the
  58     path to read heartbeat data.  This flat-file is used only when
  59     <module>mod_slotmem_shm</module> is not loaded.</p>
  60 </usage>
  61 </directivesynopsis>
  62 </modulesynopsis>