summaryrefslogtreecommitdiffstats
path: root/docs/manual
diff options
context:
space:
mode:
authorRuediger Pluem <rpluem@apache.org>2006-06-26 18:59:38 +0200
committerRuediger Pluem <rpluem@apache.org>2006-06-26 18:59:38 +0200
commit58f86ac058df0d413054cfef286a3824017737cf (patch)
tree333dcfba8dfb452c5b15901b462c4bde9a3d0632 /docs/manual
parentPatch submitted by Matt Lewandowsky - fixes name of mod_isapi handler. (diff)
downloadapache2-58f86ac058df0d413054cfef286a3824017737cf.tar.xz
apache2-58f86ac058df0d413054cfef286a3824017737cf.zip
* Add the following environment variables to expose the information
* about the route, the sticky session and the worker used during a request to other modules: BALANCER_SESSION_STICKY BALANCER_SESSION_ROUTE BALANCER_NAME BALANCER_WORKER_NAME BALANCER_WORKER_ROUTE PR: 39806 Submitted by: Brian <brectanu gmail.com> Reviewed by: rpluem git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@417238 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/mod/mod_proxy_balancer.xml41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/manual/mod/mod_proxy_balancer.xml b/docs/manual/mod/mod_proxy_balancer.xml
index 1fa7360736..c0cb40d072 100644
--- a/docs/manual/mod/mod_proxy_balancer.xml
+++ b/docs/manual/mod/mod_proxy_balancer.xml
@@ -271,6 +271,47 @@ candidate lbstatus -= total factor</code></pre>
</section>
+<section id="environment">
+ <title>Exported Environment Variables</title>
+ <p>At present there are 5 environment variables exported:</p>
+
+ <!-- ============= BALANCER_SESSION_STICKY =============== -->
+ <dt><var><a name="balancer_session_sticky" id="balancer_session_sticky">BALANCER_SESSION_STICKY</a></var></dt>
+ <dd>
+ <p>This is assigned the <var>stickysession</var> value used in the current
+ request. It is the cookie or parameter name used for sticky sessions</p>
+ </dd>
+
+ <!-- ============= BALANCER_SESSION_ROUTE ================ -->
+ <dt><var><a name="balancer_session_route" id="balancer_session_route">BALANCER_SESSION_ROUTE</a></var></dt>
+ <dd>
+ <p>This is assigned the <var>route</var> parsed from the current
+ request.</p>
+ </dd>
+
+ <!-- ============= BALANCER_NAME ========================= -->
+ <dt><var><a name="balancer_name" id="balancer_name">BALANCER_NAME</a></var></dt>
+ <dd>
+ <p>This is assigned the name of the balancer used for the current
+ request. The value is something like <code>balancer://foo</code>.</p>
+ </dd>
+
+ <!-- ============= BALANCER_WORKER_NAME ================== -->
+ <dt><var><a name="balancer_worker_name" id="balancer_worker_name">BALANCER_WORKER_NAME</a></var></dt>
+ <dd>
+ <p>This is assigned the name of the worker used for the current request.
+ The value is something like <code>http://hostA:1234</code>.</p>
+ </dd>
+
+ <!-- ============= BALANCER_WORKER_ROUTE ================= -->
+ <dt><var><a name="balancer_worker_route" id="balancer_worker_route">BALANCER_WORKER_ROUTE</a></var></dt>
+ <dd>
+ <p>This is assigned the <var>route</var> of the worker that will be
+ used for the current request.</p>
+ </dd>
+
+</section>
+
<section id="enable">
<title>Enabling Balancer Manager Support</title>
<p>This module <em>requires</em> the service of