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