Doc: Update to Docbook 4.4
[metaproxy-moved-to-github.git] / doc / load_balance.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <refentry id="ref-load_balance">
8  <refmeta>
9   <refentrytitle>load_balance</refentrytitle>
10   <manvolnum>3mp</manvolnum>
11    <refmiscinfo>Metaproxy Module</refmiscinfo>
12 </refmeta>
13  
14  <refnamediv>
15   <refname>load_balance</refname>
16   <refpurpose>Metaproxy Module balancing load among multiple identical
17   Z39.50 targets</refpurpose>
18  </refnamediv>
19  
20  <refsect1><title>DESCRIPTION</title>
21   <para>
22    This filter balances load among Z39.50 targets based on statistics
23    gathered on number of open sessions and number of open package requests. 
24   </para>
25   <para>
26    The load balancing is depending on targets to be specified (vhosts).
27    Most Z39.50 clients do not specify that. For this reason, this
28    filter is mostly used as a follower to filter virt_db.
29   </para>
30  </refsect1>
31  
32  <refsect1><title>EXAMPLES</title>
33   <para>
34    This configuration offers one database, <literal>Default</literal>,
35    which is load-balanced between two backend servers.
36    <screen><![CDATA[
37     <filter type="virt_db"/>
38       <database>Default</database>
39       <target>host1:210/Default</target>
40       <target>host2:210/Default</target>
41     </filter>
42     <filter type="load_balance"/>
43 ]]>
44    </screen>
45   </para>
46   
47  </refsect1> 
48  
49  <refsect1><title>SEE ALSO</title>
50   <para>
51    <citerefentry>
52     <refentrytitle>virt_db</refentrytitle>
53     <manvolnum>3mp</manvolnum>
54    </citerefentry>
55   </para>
56  </refsect1>
57  
58  &copyright;
59 </refentry>
60
61 <!-- Keep this comment at the end of the file
62 Local variables:
63 mode: sgml
64 sgml-omittag:t
65 sgml-shorttag:t
66 sgml-minimize-attributes:nil
67 sgml-always-quote-attributes:t
68 sgml-indent-step:1
69 sgml-indent-data:t
70 sgml-parent-document:nil
71 sgml-local-catalogs: nil
72 sgml-namecase-general:t
73 End:
74 -->