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  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>load_balance</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>load_balance</refname>
  21   <refpurpose>Metaproxy Module balancing load among multiple identical
  22   Z39.50 targets</refpurpose>
  23  </refnamediv>
  24
  25  <refsect1><title>DESCRIPTION</title>
  26   <para>
  27    This filter balances load among Z39.50 targets based on statistics
  28    gathered on number of open sessions and number of open package requests.
  29   </para>
  30   <para>
  31    The load balancing is depending on targets to be specified (vhosts).
  32    Most Z39.50 clients do not specify that. For this reason, this
  33    filter is mostly used as a follower to filter virt_db.
  34   </para>
  35  </refsect1>
  36
  37  <refsect1><title>SCHEMA</title>
  38    <literallayout><xi:include
  39                      xi:href="../xml/schema/filter_load_balance.rnc"
  40                      xi:parse="text"
  41                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  42    </literallayout>
  43  </refsect1>
  44
  45  <refsect1><title>EXAMPLES</title>
  46   <para>
  47    This configuration offers one database, <literal>Default</literal>,
  48    which is load-balanced between two backend servers.
  49    <screen><![CDATA[
  50     <filter type="virt_db"/>
  51       <database>Default</database>
  52       <target>host1:210/Default</target>
  53       <target>host2:210/Default</target>
  54     </filter>
  55     <filter type="load_balance"/>
  56 ]]>
  57    </screen>
  58   </para>
  59
  60  </refsect1>
  61
  62  <refsect1><title>SEE ALSO</title>
  63   <para>
  64    <citerefentry>
  65     <refentrytitle>virt_db</refentrytitle>
  66     <manvolnum>3mp</manvolnum>
  67    </citerefentry>
  68   </para>
  69  </refsect1>
  70
  71  &copyright;
  72 </refentry>
  73
  74 <!-- Keep this comment at the end of the file
  75 Local variables:
  76 mode: nxml
  77 nxml-child-indent: 1
  78 End:
  79 -->