granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_balancer.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   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         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_proxy_balancer - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.5</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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.5</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy_balancer</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_balancer.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_proxy_balancer.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> extension for load balancing </td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_balancer_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_balancer.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.1 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. It provides load balancing support for
  35     <code>HTTP</code>, <code>FTP</code> and <code>AJP13</code> protocols
  36     </p>
  37
  38     <p>Load balancing scheduler algorithm is provided by not this
  39     module but other modules such as:
  40     <code class="module"><a href="../mod/mod_lbmethod_byrequests.html">mod_lbmethod_byrequests</a></code>,
  41     <code class="module"><a href="../mod/mod_lbmethod_bytraffic.html">mod_lbmethod_bytraffic</a></code>,
  42     <code class="module"><a href="../mod/mod_lbmethod_bybusyness.html">mod_lbmethod_bybusyness</a></code> and
  43     <code class="module"><a href="../mod/mod_lbmethod_heartbeat.html">mod_lbmethod_heartbeat</a></code>.
  44     </p>
  45
  46     <p>Thus, in order to get the ability of load balancing,
  47     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>
  48     and at least one of load balancing scheduler algorithm modules have
  49     to be present in the server.</p>
  50
  51     <div class="warning"><h3>Warning</h3>
  52       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  53       servers are dangerous both to your network and to the Internet at
  54       large.</p>
  55     </div>
  56 </div>
  57 <div id="quickview"><h3 class="directives">Directives</h3>
  58 <p>This module provides no
  59             directives.</p>
  60 <h3>Topics</h3>
  61 <ul id="topics">
  62 <li><img alt="" src="../images/down.gif" /> <a href="#scheduler">Load balancer scheduler algorithm</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#stickyness">Load balancer stickyness</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#example">Examples of a balancer configuration</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#environment">Exported Environment Variables</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#balancer_manager">Enabling Balancer Manager Support</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#stickyness_implementation">Details on load balancer stickyness</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#stickyness_troubleshooting">Troubleshooting load balancer stickyness</a></li>
  69 </ul><h3>See also</h3>
  70 <ul class="seealso">
  71 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  72 </ul></div>
  73 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  74 <div class="section">
  75 <h2><a name="scheduler" id="scheduler">Load balancer scheduler algorithm</a></h2>
  76
  77     <p>At present, there are 3 load balancer scheduler algorithms available
  78     for use: Request Counting, Weighted Traffic Counting and Pending Request
  79     Counting. These are controlled via the <code>lbmethod</code> value of
  80     the Balancer definition. See the <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code>
  81     directive for more information, especially regarding how to
  82     configure the Balancer and BalancerMembers.</p>
  83 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  84 <div class="section">
  85 <h2><a name="stickyness" id="stickyness">Load balancer stickyness</a></h2>
  86
  87     <p>The balancer supports stickyness. When a request is proxied
  88     to some back-end, then all following requests from the same user
  89     should be proxied to the same back-end. Many load balancers implement
  90     this feature via a table that maps client IP addresses to back-ends.
  91     This approach is transparent to clients and back-ends, but suffers
  92     from some problems: unequal load distribution if clients are themselves
  93     hidden behind proxies, stickyness errors when a client uses a dynamic
  94     IP address that changes during a session and loss of stickyness, if the
  95     mapping table overflows.</p>
  96     <p>The module <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> implements stickyness
  97     on top of two alternative means: cookies and URL encoding. Providing the
  98     cookie can be either done by the back-end or by the Apache web server
  99     itself. The URL encoding is usually done on the back-end.</p>
 100 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 101 <div class="section">
 102 <h2><a name="example" id="example">Examples of a balancer configuration</a></h2>
 103
 104     <p>Before we dive into the technical details, here's an example of
 105     how you might use <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code> to provide
 106     load balancing between two back-end servers:
 107     </p>
 108
 109     <div class="example"><p><code>
 110     &lt;Proxy balancer://mycluster&gt;<br />
 111         BalancerMember http://192.168.1.50:80<br />
 112         BalancerMember http://192.168.1.51:80<br />
 113     &lt;/Proxy&gt;<br />
 114     ProxyPass /test balancer://mycluster<br />
 115     ProxyPassReverse /test balancer://mycluster
 116     </code></p></div>
 117
 118     <p>Another example of how to provide load balancing with stickyness
 119     using <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code>, even if the back-end server does
 120     not set a suitable session cookie:
 121     </p>
 122
 123     <div class="example"><p><code>
 124     Header add Set-Cookie "ROUTEID=.%{BALANCER_WORKER_ROUTE}e; path=/"
 125            env=BALANCER_ROUTE_CHANGED<br />
 126     &lt;Proxy balancer://mycluster&gt;<br />
 127     BalancerMember http://192.168.1.50:80 route=1<br />
 128     BalancerMember http://192.168.1.51:80 route=2<br />
 129     ProxySet stickysession=ROUTEID<br />
 130     &lt;/Proxy&gt;<br />
 131     ProxyPass /test balancer://mycluster<br />
 132     ProxyPassReverse /test balancer://mycluster
 133     </code></p></div>
 134 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 135 <div class="section">
 136 <h2><a name="environment" id="environment">Exported Environment Variables</a></h2>
 137
 138     <p>At present there are 6 environment variables exported:</p>
 139
 140     <dl>
 141
 142     <dt><var><a name="balancer_session_sticky" id="balancer_session_sticky">BALANCER_SESSION_STICKY</a></var></dt>
 143     <dd>
 144     <p>This is assigned the <var>stickysession</var> value used for the current
 145     request.  It is the name of the cookie or request parameter used for sticky sessions</p>
 146     </dd>
 147
 148
 149     <dt><var><a name="balancer_session_route" id="balancer_session_route">BALANCER_SESSION_ROUTE</a></var></dt>
 150     <dd>
 151     <p>This is assigned the <var>route</var> parsed from the current
 152     request.</p>
 153     </dd>
 154
 155
 156     <dt><var><a name="balancer_name" id="balancer_name">BALANCER_NAME</a></var></dt>
 157     <dd>
 158     <p>This is assigned the name of the balancer used for the current
 159     request. The value is something like <code>balancer://foo</code>.</p>
 160     </dd>
 161
 162
 163     <dt><var><a name="balancer_worker_name" id="balancer_worker_name">BALANCER_WORKER_NAME</a></var></dt>
 164     <dd>
 165     <p>This is assigned the name of the worker used for the current request.
 166     The value is something like <code>http://hostA:1234</code>.</p>
 167     </dd>
 168
 169
 170     <dt><var><a name="balancer_worker_route" id="balancer_worker_route">BALANCER_WORKER_ROUTE</a></var></dt>
 171     <dd>
 172     <p>This is assigned the <var>route</var> of the worker that will be
 173     used for the current request.</p>
 174     </dd>
 175
 176
 177     <dt><var><a name="balancer_route_changed" id="balancer_route_changed">BALANCER_ROUTE_CHANGED</a></var></dt>
 178     <dd>
 179     <p>This is set to 1 if the session route does not match the
 180     worker route (BALANCER_SESSION_ROUTE != BALANCER_WORKER_ROUTE) or the
 181     session does not yet have an established route.  This can be used to
 182     determine when/if the client needs to be sent an updated route
 183     when sticky sessions are used.</p>
 184     </dd>
 185     </dl>
 186
 187 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 188 <div class="section">
 189 <h2><a name="balancer_manager" id="balancer_manager">Enabling Balancer Manager Support</a></h2>
 190
 191     <p>This module <em>requires</em> the service of
 192     <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.
 193     Balancer manager enables dynamic update of balancer
 194     members. You can use balancer manager to change the balance
 195     factor or a particular member, or put it in the off line
 196     mode.
 197     </p>
 198
 199     <p>Thus, in order to get the ability of load balancer management,
 200     <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> and <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>
 201     have to be present in the server.</p>
 202
 203     <p>To enable load balancer management for browsers from the example.com
 204     domain add this code to your <code>httpd.conf</code>
 205     configuration file</p>
 206 <div class="example"><p><code>
 207     &lt;Location /balancer-manager&gt;<br />
 208     SetHandler balancer-manager<br />
 209 <br />
 210     Require host example.com<br />
 211     &lt;/Location&gt;
 212 </code></p></div>
 213
 214     <p>You can now access load balancer manager by using a Web browser
 215     to access the page
 216     <code>http://your.server.name/balancer-manager</code></p>
 217 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 218 <div class="section">
 219 <h2><a name="stickyness_implementation" id="stickyness_implementation">Details on load balancer stickyness</a></h2>
 220
 221     <p>When using cookie based stickyness, you need to configure the
 222     name of the cookie that contains the information about which back-end
 223     to use. This is done via the <var>stickysession</var> attribute added
 224     to either <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or
 225     <code class="directive"><a href="../mod/mod_proxy.html#proxyset">ProxySet</a></code>. The name of
 226     the cookie is case-sensitive. The balancer extracts the value of the
 227     cookie and looks for a member worker with <var>route</var> equal
 228     to that value. The <var>route</var> must also be set in either
 229     <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or
 230     <code class="directive"><a href="../mod/mod_proxy.html#proxyset">ProxySet</a></code>. The cookie can either
 231     be set by the back-end, or as shown in the above
 232     <a href="#example">example</a> by the Apache web server itself.</p>
 233     <p>Some back-ends use a slightly different form of stickyness cookie,
 234     for instance Apache Tomcat. Tomcat adds the name of the Tomcat instance
 235     to the end of its session id cookie, separated with a dot (<code>.</code>)
 236     from the session id. Thus if the Apache web server finds a dot in the value
 237     of the stickyness cookie, it only uses the part behind the dot to search
 238     for the route. In order to let Tomcat know about its instance name, you
 239     need to set the attribute <code>jvmRoute</code> inside the Tomcat
 240     configuration file <code>conf/server.xml</code> to the value of the
 241     <var>route</var> of the worker that connects to the respective Tomcat.
 242     The name of the session cookie used by Tomcat (and more generally by Java
 243     web applications based on servlets) is <code>JSESSIONID</code>
 244     (upper case) but can be configured to something else.</p>
 245     <p>The second way of implementing stickyness is URL encoding.
 246     The web server searches for a query parameter in the URL of the request.
 247     The name of the parameter is specified again using <var>stickysession</var>.
 248     The value of the parameter is used to lookup a member worker with <var>route</var>
 249     equal to that value. Since it is not easy to extract and manipulate all
 250     URL links contained in responses, generally the work of adding the parameters
 251     to each link is done by the back-end generating the content.
 252     In some cases it might be feasible doing
 253     this via the web server using <code class="module"><a href="../mod/mod_substitute.html">mod_substitute</a></code> or
 254     <code class="module"><a href="../mod/mod_sed.html">mod_sed</a></code>. This can have negative impact on performance though.</p>
 255     <p>The Java standards implement URL encoding slightly different. They use
 256     a path info appended to the URL using a semicolon (<code>;</code>)
 257     as the separator and add the session id behind. As in the cookie case,
 258     Apache Tomcat can include the configured <code>jvmRoute</code> in this path
 259     info. To let Apache find this sort of path info, you neet to set
 260     <code>scolonpathdelim</code> to <code>On</code> in
 261     <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or
 262     <code class="directive"><a href="../mod/mod_proxy.html#proxyset">ProxySet</a></code>.</p>
 263     <p>Finally you can support cookies and URL encoding at the same time, by
 264     configuring the name of the cookie and the name of the URL parameter
 265     separated by a vertical bar (<code>|</code>) as in the following example:</p>
 266     <div class="example"><p><code>
 267     ProxyPass /test balancer://mycluster stickysession=JSESSIONID|jsessionid scolonpathdelim=On<br />
 268     &lt;Proxy balancer://mycluster&gt;<br />
 269     BalancerMember http://192.168.1.50:80 route=node1<br />
 270     BalancerMember http://192.168.1.51:80 route=node2<br />
 271     &lt;/Proxy&gt;<br />
 272     </code></p></div>
 273     <p>If the cookie and the request parameter both provide routing information
 274     for the same request, the information from the request parameter is used.</p>
 275 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 276 <div class="section">
 277 <h2><a name="stickyness_troubleshooting" id="stickyness_troubleshooting">Troubleshooting load balancer stickyness</a></h2>
 278
 279     <p>If you experience stickyness errors, e.g. users loose their
 280     application sessions and need to login again, you first want to
 281     check whether this is because the back-ends are sometimes unavailable
 282     or whether your configuration is wrong. To find out about possible
 283     stability problems with the back-ends, check your Apache error log
 284     for proxy error messages.</p>
 285     <p>To verify your configuration, first check, whether the stickyness
 286     is based on a cookie or on URL encoding. Next step would be logging
 287     the appropriate data in the access log by using an enhanced
 288     <code class="directive"><a href="../mod/mod_log_config.html#logformat">LogFormat</a></code>.
 289     The following fields are useful:</p>
 290     <dl>
 291     <dt><code>%{MYCOOKIE}C</code></dt>
 292     <dd>The value contained in the cookie with name <code>MYCOOKIE</code>.
 293     The name should be the same given in the <var>stickysession</var>
 294     attribute.</dd>
 295     <dt><code>%{Set-Cookie}o</code></dt>
 296     <dd>This logs any cookie set by the back-end. You can track,
 297     whether the back-end sets the session cookie you expect, and
 298     to which value it is set.</dd>
 299     <dt><code>%{BALANCER_SESSION_STICKY}e</code></dt>
 300     <dd>The name of the cookie or request parameter used
 301     to lookup the routing information.</dd>
 302     <dt><code>%{BALANCER_SESSION_ROUTE}e</code></dt>
 303     <dd>The route information found in the request.</dd>
 304     <dt><code>%{BALANCER_WORKER_ROUTE}e</code></dt>
 305     <dd>The route of the worker chosen.</dd>
 306     <dt><code>%{BALANCER_ROUTE_CHANGED}e</code></dt>
 307     <dd>Set to <code>1</code> if the route in the request
 308     is different from the route of the worker, i.e.
 309     the request couldn't be handled sticky.</dd>
 310     </dl>
 311     <p>Common reasons for loss of session are session timeouts,
 312     which are usually configurable on the back-end server.</p>
 313     <p>The balancer also logs detailed information about handling
 314     stickyness to the error log, if the log level is set to
 315     <code>debug</code> or higher. This is an easy way to
 316     troubleshoot stickyness problems, but the log volume might
 317     be to high for production servers under high load.</p>
 318 </div>
 319 </div>
 320 <div class="bottomlang">
 321 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_balancer.html" title="English">&nbsp;en&nbsp;</a> |
 322 <a href="../ja/mod/mod_proxy_balancer.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
 323 </div><div id="footer">
 324 <p class="apache">Copyright 2012 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>
 325 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 326 </body></html>