You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by rj...@apache.org on 2006/11/19 04:51:23 UTC
svn commit: r476695 - in /tomcat/connectors/trunk/jk/xdocs: ./ common/
config/ howto/ tools/
Author: rjung
Date: Sat Nov 18 19:51:22 2006
New Revision: 476695
URL: http://svn.apache.org/viewvc?view=rev&rev=476695
Log:
Minor documentation enhancement.
Added:
tomcat/connectors/trunk/jk/xdocs/tools/
tomcat/connectors/trunk/jk/xdocs/tools/project.xml (with props)
tomcat/connectors/trunk/jk/xdocs/tools/tools.xml (with props)
Removed:
tomcat/connectors/trunk/jk/xdocs/common/tools.xml
tomcat/connectors/trunk/jk/xdocs/proxy.xml
Modified:
tomcat/connectors/trunk/jk/xdocs/config/apache.xml
tomcat/connectors/trunk/jk/xdocs/config/workers.xml
tomcat/connectors/trunk/jk/xdocs/faq.xml
tomcat/connectors/trunk/jk/xdocs/howto/apache.xml
tomcat/connectors/trunk/jk/xdocs/howto/loadbalancers.xml
tomcat/connectors/trunk/jk/xdocs/howto/quick.xml
tomcat/connectors/trunk/jk/xdocs/howto/workers.xml
tomcat/connectors/trunk/jk/xdocs/project.xml
Modified: tomcat/connectors/trunk/jk/xdocs/config/apache.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/config/apache.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/config/apache.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/config/apache.xml Sat Nov 18 19:51:22 2006
@@ -267,19 +267,6 @@
</p>
<p>
-JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as
-required by Servlet API 2.3.
-This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default).
-
-<source>
- JkOptions +ForwardKeySize
-</source>
-
-<br/>
-<br/>
-</p>
-
-<p>
JkOptions <b>ForwardURICompat</b>, you ask mod_jk to send the URI to Tomcat normally,
which is less spec compliant but mod_rewrite compatible,
use it for compatibility with Tomcat 3.2.x engines (on by default).
@@ -387,6 +374,18 @@
</p>
<p>
+JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection
+buffer after the response headers have been received from Tomcat.
+
+<source>
+ JkOptions +FlushHeader
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
JkOptions <b>DisableReuse</b>, you ask mod_jk to close connections immediately
after their use. Normally mod_jk uses persistent connections and pools idle
connections to reuse them, when new requests have to be sent to Tomcat.
@@ -408,8 +407,21 @@
</p>
<p>
-The directive <b>JkEnvVar</b> allows you to forward an environment variable from Apache server to Tomcat engine.
-The variable can be retrieved on the Tomcat side as a request attribute.
+JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as
+required by Servlet API 2.3.
+This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default).
+
+<source>
+ JkOptions +ForwardKeySize
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+The directive <b>JkEnvVar</b> allows you to forward environment variables from Apache server to Tomcat engine.
+The variables can be retrieved on the Tomcat side as a request attributes.
You must add a default value as a second parameter to the directive.
<source>
@@ -531,8 +543,12 @@
JkMountFile conf/uriworkermap.properties
</source>
-<p>If mount point uri starts with minus '-' char the mount point
-will be disabled.
+<p>If the mount point uri starts with an exclamation mark '!'
+it defines an exclusion in the same way JkUnmount does.
+If the mount point uri starts with minus sign '-'
+the mount point will only be disabled. A disabled mount can be reenabled
+by deleting the minus sign and waiting for the JkMountFile to reload.
+An exclusion can be disabled by prefixing it with a mninus sign.
</p>
<source>
# Sample uriworkermap.properties file
@@ -544,10 +560,14 @@
-/jsp-examples/*=ajp13w
</source>
<p>At run time you can change the content of this file. For example
-removing minus char will enable the uri mapping. You can add any
-number of new entries at runtime that reflects the newly deployed
+removing minus signs will enable the previously disabled uri mappings.
+You can add any number of new entries at runtime that reflects the newly deployed
applications. Apache will reload the file and update the mount
points within 60 second interval.
+</p>
+<p>
+There is no way to delete entries by dynamic reloading, but you can disable or
+exclude mappings.
</p>
</subsection>
Modified: tomcat/connectors/trunk/jk/xdocs/config/workers.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/config/workers.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/config/workers.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/config/workers.xml Sat Nov 18 19:51:22 2006
@@ -154,7 +154,7 @@
each retry after default an extra wait of 100ms will be inserted.
</directive>
-<directive name="connection_pool_size" default="1" required="false">
+<directive name="connection_pool_size" default="see text" required="false">
This defines the number of connections made to the AJP backend that
are maintained as a connection pool.
It will limit the number of those connection that each web server child
@@ -165,7 +165,7 @@
should reflect the number of threads per child process. JK will discover
the number of threads per child process on Apache 2 web server with worker-mpm and set
its default value to match the ThreadsPerChild Apache directive. For IIS the default
-value is 10. For other web servers this value has to be set manually.
+value is 10. For other web servers than Apache or IIS this value has to be set manually.
</p>
<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache 2.x prefork</b> or <b>Apache 1.3.x</b>!</warn>
</directive>
@@ -199,9 +199,10 @@
</directive>
<directive name="lbfactor" default="1" required="false">
-Integer number used when the worker will be used inside load balancer worker,
-this is the load-balancing factor for the worker.
-The load-balancing factor is <i>how much we expect this worker to work</i>, or
+Only used for a member worker of a load balancer.
+<p>
+The integer number lbfactor (load-balancing factor) is
+<i>how much we expect this worker to work</i>, or
<i>the worker's work quota</i>. Load balancing factor is compared with other workers
that makes the load balancer. For example if one worker has lb_factor 5 times higher then
other worker, then it will receive five times more requests.
@@ -375,6 +376,8 @@
</directive>
<directive name="recover_time" default="60" required="false">
+Only used for load balancer workers.
+<p>
The recover time is the time in seconds the load balancer will not try
to use a worker, after it went into error state. Only after this time has passed,
a worker in error state will be marked as in recovering, so that it will be
@@ -391,6 +394,8 @@
</directive>
<directive name="recovery_options" default="0" required="false">
+Only used for a member worker of a load balancer.
+<p>
Recovery options property told webserver how to handle recovery when
it detect that tomcat failed.
By default, webserver will forward the request to another tomcat in LB mode
@@ -412,7 +417,10 @@
</directive>
<directive name="distance" default="0" required="false">
-Express preferences between the balanced workers of an lb worker.
+Only used for a member worker of a load balancer.
+<p>
+An integer number to express preferences between
+the balanced workers of an lb worker.
A load balancer will never choose some balanced worker
in case there is another usable worker with lower distance.
<p>
@@ -425,6 +433,8 @@
</directive>
<directive name="domain" default="" required="false">
+Only used for a member worker of a load balancer.
+<p>
Domain directive can be used only when the worker is a member of the load balancer.
Workers that share the same domain name are treated as single worker. If sticky_session
is used, then the domain name is used as session route.
@@ -438,6 +448,8 @@
</directive>
<directive name="redirect" default="" required="false">
+Only used for a member worker of a load balancer.
+<p>
Set to the preferred failover worker. If worker matching SESSION ID is in
error state then the redirect worker will be used instead. It will be used
even if being disabled, thus offering hot standby.
@@ -447,6 +459,8 @@
</directive>
<directive name="activation" default="Active" required="false">
+Only used for a member worker of a load balancer.
+<p>
Using this directive, a balanced worker of a load balancer
can be configured as disabled or stopped. A disabled worker only gets
requests, which belong to sessions for that worker. A stopped
@@ -486,6 +500,8 @@
</directive>
<directive name="reference" default="" required="false">
+This attribute can be used for normal workers and for load balancer workers.
+<p>
This directive allows to copy configurations between workers
in a hierarchical way. If worker castor sets <b>worker.castor.reference=worker.pollux</b>
then it inherits all properties of <b>pollux</b>, except for the ones that
@@ -506,13 +522,18 @@
</directive>
<directive name="secret" default="" required="false">
+This attribute can be used for normal workers and for load balancer workers.
+<p>
If set to AJP Connector secret keyword, only request with this keyword are successfull responding.
Use <b>request.useSecret="true"</b> and <b>request.secret="secret key word"</b> at your tomcat ajp
Connector configuration.
</directive>
<directive name="mount" default="" required="false">
-Space delimited list of uri maps the worker should handle.
+This attribute can be used for normal workers and for load balancer workers.
+<p>
+Space delimited list of uri maps the worker should handle. It is only used,
+if the worker is included in worker.list.
<p>
This directive can be used multiple times for the same worker.
</p>
@@ -528,7 +549,7 @@
them any more. Please migrate your existing configurations.
</p>
<deprecations>
-<directive name="cachesize" successor="connection_pool_size" default="1" required="false">
+<directive name="cachesize" successor="connection_pool_size" default="see text" required="false">
<warn>This directive has been deprecated since 1.2.16.</warn>
Cachesize defines the number of connections made to the AJP backend that
are maintained as a connection pool.
@@ -540,7 +561,7 @@
should reflect the number of threads per child process. JK will discover
the number of threads per child process on Apache 2 web server with worker-mpm and set
its default value to match the ThreadsPerChild Apache directive. For IIS the default
-value is 10. For other web servers this value has to be set manually.
+value is 10. For other web servers than Apache or IIS this value has to be set manually.
</p>
<warn>Do not use cachesize with values higher then 1 on <b>Apache 2.x prefork</b> or <b>Apache 1.3.x</b>!</warn>
</directive>
Modified: tomcat/connectors/trunk/jk/xdocs/faq.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/faq.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/faq.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/faq.xml Sat Nov 18 19:51:22 2006
@@ -146,6 +146,7 @@
<p>
Starting with JK 1.2.0, a <b>socket_keepalive</b> property as been added to ajp13 settings, and you should take a look at
it in <a href="howto/workers.html">Workers HowTo</a>.
+If nothing else helps, you can try <b>JkOptions +DisableReuse</b>, but this will have strong performance implications.
</p>
</subsection>
@@ -158,8 +159,8 @@
even if they are no more used.
</p>
<p>
-Since JK 1.2.0, <b>cache_timeout</b> and <b>recycle_timeout</b> properties as been added to close
-connections after some time of inactivity, for more informations refer to <a href="howto/workers.html">Workers HowTo</a>.
+To close connections after some time of inactivity you can use <b>connection_pool_timeout</b>,
+for more informations refer to <a href="config/workers.html">workers.properties configuration</a>.
</p>
</subsection>
Modified: tomcat/connectors/trunk/jk/xdocs/howto/apache.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/howto/apache.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/howto/apache.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/howto/apache.xml Sat Nov 18 19:51:22 2006
@@ -73,7 +73,8 @@
The mod_jk module was developed and tested on:
<ul>
<li>
-Linux, FreeBSD, AIX, HP-UX, MacOS X, and should works on major Unixes platforms supporting Apache 1.3 and/or 2.0
+Linux, FreeBSD, AIX, HP-UX, MacOS X, Solaris and should works on major Unixes platforms
+supporting Apache 1.3 and/or 2.0/2.2
</li>
<li>
WinNT4.0-i386 SP4/SP5/SP6a (should be able to work with other service packs), Win2K and WinXP and Win98
@@ -307,16 +308,14 @@
AddModule mod_jk.c
# Where to find workers.properties
JkWorkersFile /etc/httpd/conf/workers.properties
+ # Where to put jk shared memory
+ JkShmFile /var/log/httpd/mod_jk.shm
# Where to put jk logs
JkLogFile /var/log/httpd/mod_jk.log
# Set the jk log level [debug/error/info]
JkLogLevel info
- # Select the log format
+ # Select the timestamp log format
JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
- # JkOptions indicate to send SSL KEY SIZE,
- JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
- # JkRequestLogFormat set the request format
- JkRequestLogFormat "%w %V %T"
# Send servlet for context /examples to worker named worker1
JkMount /examples/servlet/* worker1
# Send JSPs for context /examples to worker named worker1
@@ -354,7 +353,7 @@
</source>
<p>
-Since JK 1.2.3 for Apache 2.0 and JK 1.2.16 for Apache 1.3 this can also
+Since JK 1.2.3 for Apache 2.0/2.2 and JK 1.2.16 for Apache 1.3 this can also
be used for piped logging:
</p>
@@ -449,14 +448,10 @@
</p>
<p>
-JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as
-required by Servlet API 2.3.
-This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default).
-
-<source>
- JkOptions +ForwardKeySize
-</source>
-
+ Exactly one of the following three options <b>+ForwardURIxxx</b>
+ is required. By default, the option ForwardURICompat
+ is turned on. So if you turn this off you will need to switch on one of the other
+ two described below.
<br/>
<br/>
</p>
@@ -474,13 +469,6 @@
<br/>
</p>
<p>
- At least one <b>+ForwardURIxxx</b> is required. By default, the ForwardURICompat
- is turned on. So if you turn this off you will need to switch on one of the other
- two described below.
-<br/>
-<br/>
-</p>
-<p>
JkOptions <b>ForwardURICompatUnparsed</b>, the forwarded URI
is unparsed, it's spec compliant but broke mod_rewrite.
@@ -545,8 +533,83 @@
</p>
<p>
-The directive <b>JkEnvVar</b> allows you to forward an environment variable from Apache server to Tomcat engine.
-The variable can be retrieved on the Tomcat side as a request attribute.
+JkOptions <b>ForwardLocalAddress</b>, you ask mod_jk to send the local address,
+of the Apache web server instead remote client address. This can be used by
+Tomcat remote address valve for allowing connections only from registered Apache
+web servers.
+
+<source>
+ JkOptions +ForwardLocalAddress
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+JkOptions <b>FlushPackets</b>, you ask mod_jk to flush Apache's connection
+buffer after each AJP packet chunk received from Tomcat. This option can have
+a strong performance penalty for Apache and Tomcat as writes are performed
+more often than would normally be required (ie: at the end of each
+response).
+
+<source>
+ JkOptions +FlushPackets
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection
+buffer after the response headers have been received from Tomcat.
+
+<source>
+ JkOptions +FlushHeader
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+JkOptions <b>DisableReuse</b>, you ask mod_jk to close connections immediately
+after their use. Normally mod_jk uses persistent connections and pools idle
+connections to reuse them, when new requests have to be sent to Tomcat.
+</p>
+
+<p>
+Using this option will have a strong performance penalty for Apache and Tomcat.
+Use this only as a last resort in case of unfixable network problems.
+If a firewall between Apache and Tomcat silently kills idle connections,
+try to use the worker attribute socket_keepalive in combination with an appropriate
+TCP keepalive value in your OS.
+
+<source>
+ JkOptions +DisableReuse
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward also the SSL Key Size as
+required by Servlet API 2.3.
+This flag shouldn't be set when servlet engine is Tomcat 3.2.x (off by default).
+
+<source>
+ JkOptions +ForwardKeySize
+</source>
+
+<br/>
+<br/>
+</p>
+
+<p>
+The directive <b>JkEnvVar</b> allows you to forward environment variables from Apache server to Tomcat engine.
+The variables can be retrieved on the Tomcat side as request attributes.
You must add a default value as a second parameter to the directive.
<source>
@@ -616,7 +679,7 @@
</source>
<p>
-Starting with mod_jk 1.2.6 for Apache 2.0 and 1.2.19 for Apache 1.3, it's possible to exclude some URL/URI from
+Starting with mod_jk 1.2.6 for Apache 2.0/2.2 and 1.2.19 for Apache 1.3, it's possible to exclude some URL/URI from
jk processing by setting the env var <b>no-jk</b>, for example with the SetEnvIf Directive.
</p>
@@ -710,7 +773,7 @@
</screen>
<p>
-If you want to build mod_jk for Apache 1.3 and 2.0, you should
+If you want to build mod_jk for Apache 1.3 and 2.0/2.2, you should
<ul>
<li>
use configure and indicate Apache 1.3 apxs location (--with-apxs)
@@ -725,7 +788,7 @@
make clean (to remove all previously compiled modules)
</li>
<li>
-use configure and indicate Apache 2.0 apxs location,
+use configure and indicate Apache 2.0/2.2 apxs location,
</li>
<li>
then make.
@@ -743,7 +806,7 @@
<td>--with-apxs[=FILE]</td>
<td>FILE is the location of the apxs tool. Default is finding apxs in PATH.
It builds a shared Apache module. It detects automaticly the Apache version.
-(2.0 and 1.3)</td>
+(2.0/2.2 and 1.3)</td>
</tr>
<tr><td>--with-apache=DIR</td>
<td>DIR is the path where apache sources are located.
@@ -783,7 +846,7 @@
<subsection name="Examples of configure use">
<screen>
-<note>Apache 1.3 and 2.0 build</note>
+<note>Apache 1.3 and 2.0/2.2 build</note>
<type>./configure --with-apxs=/usr/sbin/apxs</type><br/>
<type>make</type><br/>
<type>cp ./apache-1.3/mod_jk.so /usr/lib/apache</type><br/>
@@ -794,7 +857,7 @@
</screen>
<screen>
-<note>Apache 2.0 build with JNI support</note>
+<note>Apache 2.0/2.2 build with JNI support</note>
<type>./configure --with-apxs2=/opt/apache2/bin/apxs \</type>
<typenext>--with-java-home=${JAVA_HOME} --with-java-platform=2 \</typenext>
<typenext>--enable-jni</typenext><br/>
Modified: tomcat/connectors/trunk/jk/xdocs/howto/loadbalancers.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/howto/loadbalancers.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/howto/loadbalancers.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/howto/loadbalancers.xml Sat Nov 18 19:51:22 2006
@@ -36,6 +36,129 @@
<warn>The workers that are member of load balancer must not appear in the
<b>worker.list</b> directive.</warn>
</p>
+
+<subsection name="lb Worker properties">
+<p>
+The load-balancing worker does not really communicate with Tomcat workers.
+Instead it is responsible for the management of several "real" workers.
+This management includes:
+</p>
+
+<ul>
+<li>
+Instantiating the workers in the web server.
+</li>
+<li>
+Using the worker's load-balancing factor, perform weighed-round-robin load balancing where
+high lbfactor means stronger machine (that is going to handle more requests)
+</li>
+<li>
+Keeping requests belonging to the same session executing on the same Tomcat worker.
+</li>
+<li>
+Identifying failed Tomcat workers, suspending requests to them and instead falling-back on
+other workers managed by the lb worker.
+</li>
+</ul>
+
+<p>
+The overall result is that workers managed by the same lb worker are load-balanced (based on their lbfactor and current user session) and also fall-backed so a single Tomcat process death will not "kill" the entire site.
+The following table specifies some properties that the lb worker can accept:
+<ul>
+<li><b>balance_workers</b> is a comma separated list of workers that the load balancer need to manage.
+These workers should not appear in the worker.list property. This directive can be used multiple times for the same load balancer.</li>
+<li><b>sticky_session</b> specifies whether requests with SESSION ID's should be routed back to the same
+Tomcat worker. Set sticky_session to False when Tomcat is using a Session Manager which
+can persist session data across multiple instances of Tomcat. By default sticky_session is set to True.</li>
+</ul>
+</p>
+
+<source>
+ # The worker balance1 while use "real" workers worker1 and worker2
+ worker.balance1.balance_workers=worker1, worker2
+</source>
+
+</subsection>
+
+<subsection name="Advanced lb Worker properties">
+<p>
+With JK 1.2.x, new load-balancing and fault-tolerant support has been added via
+2 new properties, <b>redirect</b> and <b>activation</b>.
+</p>
+
+<p>
+Let's take an example environment:
+</p>
+
+<p>
+A cluster with two nodes (worker1+worker2), running a webserver + tomcat tandem on each node and
+a loadbalancer in front of the nodes.
+</p>
+
+<source>
+ # The advanced router LB worker
+ worker.list=router
+
+ # Define a worker using ajp13
+ worker.worker1.port=8009
+ worker.worker1.host=node1.domain.org
+ worker.worker1.type=ajp13
+ worker.worker1.lbfactor=1
+ # Define prefered failover node for worker1
+ worker.worker1.redirect=worker2
+
+ # Define another worker using ajp13
+ worker.worker2.port=8009
+ worker.worker2.host=node2.domain.org
+ worker.worker2.type=ajp13
+ worker.worker2.lbfactor=1
+ # Disable worker2 for all requests except failover
+ worker.worker2.activation=disabled
+
+ # Define the LB worker
+ worker.router.type=lb
+ worker.router.balance_workers=worker1,worker2
+</source>
+
+<p>
+The <b>redirect</b> flag on worker1 tells the <b>lb_worker</b> to redirect the requests
+to worker2 only if worker1 is in error state. In other cases worker2 will not receive
+any requests, thus acting like a hot standby.
+</p>
+
+
+</subsection>
+
+<subsection name="Status Worker properties">
+<p>
+The status worker does not communicate with Tomcat.
+Instead it is responsible for the load balancer management.
+</p>
+<source>
+ # Add the status worker to the worker list
+ worker.list=jkstatus
+ # Define a 'jkstatus' worker using status
+ worker.jkstatus.type=status
+</source>
+<p>Next thing is to mount the requests to the jkstatus worker. For Apache
+web servers use the:</p>
+<source>
+ # Add the jkstatus mount point
+ JkMount /jkmanager/* jkstatus
+</source>
+<p>To obtain a higher level of security use the:</p>
+<source>
+ # Enable the JK manager access from localhost only
+ <Location /jkmanager/>
+ JkMount jkstatus
+ Order deny,allow
+ Deny from all
+ Allow from 127.0.0.1
+ </Location>
+</source>
+
+</subsection>
+
</section>
</body>
Modified: tomcat/connectors/trunk/jk/xdocs/howto/quick.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/howto/quick.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/howto/quick.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/howto/quick.xml Sat Nov 18 19:51:22 2006
@@ -61,11 +61,6 @@
worker.worker1.type=ajp13
worker.worker1.host=localhost
worker.worker1.port=8009
- worker.worker1.lbfactor=50
- worker.worker1.cachesize=10
- worker.worker1.cache_timeout=600
- worker.worker1.socket_keepalive=1
- worker.worker1.recycle_timeout=300
</source>
</p>
@@ -129,17 +124,16 @@
# Where to find workers.properties
# Update this path to match your conf directory location (put workers.properties next to httpd.conf)
JkWorkersFile /etc/httpd/conf/workers.properties
+ # Where to put jk shared memory
+ # Update this path to match your local state directory or logs directory
+ JkShmFile /var/log/httpd/mod_jk.shm
# Where to put jk logs
# Update this path to match your logs directory location (put mod_jk.log next to access_log)
JkLogFile /var/log/httpd/mod_jk.log
# Set the jk log level [debug/error/info]
JkLogLevel info
- # Select the log format
+ # Select the timestamp log format
JkLogStampFormat "[%a %b %d %H:%M:%S %Y] "
- # JkOptions indicate to send SSL KEY SIZE,
- JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories
- # JkRequestLogFormat set the request format
- JkRequestLogFormat "%w %V %T"
# Send everything for context /examples to worker named worker1 (ajp13)
JkMount /examples/* worker1
Modified: tomcat/connectors/trunk/jk/xdocs/howto/workers.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/howto/workers.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/howto/workers.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/howto/workers.xml Sat Nov 18 19:51:22 2006
@@ -193,11 +193,11 @@
The main difference between ajpv12 and ajpv13 are that:
<ul>
<li>
-ajpv13 is a more binary protocol and it try to compress some of the request data by coding
+ajpv13 is a more binary protocol and it tries to compress some of the request data by coding
frequently used strings as small integers.
</li>
<li>
-ajpv13 reuse open sockets and leaves them open for future requests (remember when you've got a Firewall between your
+ajpv13 reuses open sockets and leaves them open for future requests (remember when you've got a Firewall between your
WebServer and Tomcat).
</li>
<li>
@@ -218,8 +218,7 @@
worker.worker2.host=www2.x.com
worker.worker2.port=8009
worker.worker2.lbfactor=3
- # worker "worker2" use up to 10 sockets, which will stay no more than 10mn in the connection pool
- worker.worker2.connection_pool_size=10
+ # worker "worker2" uses connections, which will stay no more than 10mn in the connection pool
worker.worker2.connection_pool_timeout=600
# worker "worker2" ask operating system to send KEEP-ALIVE signal on the connection
worker.worker2.socket_keepalive=1
@@ -252,80 +251,30 @@
Keeping requests belonging to the same session executing on the same Tomcat worker.
</li>
<li>
-Identifying failed Tomcat workers, suspending requests to them and instead fall-backing on
+Identifying failed Tomcat workers, suspending requests to them and instead falling-back on
other workers managed by the lb worker.
</li>
</ul>
<p>
The overall result is that workers managed by the same lb worker are load-balanced (based on their lbfactor and current user session) and also fall-backed so a single Tomcat process death will not "kill" the entire site.
-The following table specifies properties that the lb worker can accept:
+The following table specifies some properties that the lb worker can accept:
<ul>
<li><b>balance_workers</b> is a comma separated list of workers that the load balancer need to manage.
These workers should not appear in the worker.list property. This directive can be used multiple times for the same load balancer.</li>
<li><b>sticky_session</b> specifies whether requests with SESSION ID's should be routed back to the same
-Tomcat worker. If sticky_session is an flag and if it is set to True and sessions are sticky, otherwise
-sticky_session is set to false. Set sticky_session to False when Tomcat is using a Session Manager which
+Tomcat worker. Set sticky_session to False when Tomcat is using a Session Manager which
can persist session data across multiple instances of Tomcat. By default sticky_session is set to True.</li>
</ul>
</p>
<source>
- The worker balance1 while use "real" workers worker1 and worker2
+ # The worker balance1 while use "real" workers worker1 and worker2
worker.balance1.balance_workers=worker1, worker2
</source>
</subsection>
-<subsection name="Advanced lb Worker properties">
-<p>
-With JK 1.2.x, new load-balancing and fault-tolerant support has been added via
-2 new properties, <b>redirect</b> and <b>activation</b>.
-</p>
-
-<p>
-Let's take an example environment:
-</p>
-
-<p>
-A cluster with two nodes (worker1+worker2), running a webserver + tomcat tandem on each node and
-a loadbalancer in front of the nodes.
-</p>
-
-<source>
- # The advanced router LB worker
- worker.list=router
-
- # Define a worker using ajp13
- worker.worker1.port=8009
- worker.worker1.host=node1.domain.org
- worker.worker1.type=ajp13
- worker.worker1.lbfactor=1
- # Define prefered failover node for worker1
- worker.worker1.redirect=worker2
-
- # Define another worker using ajp13
- worker.worker2.port=8009
- worker.worker2.host=node2.domain.org
- worker.worker2.type=ajp13
- worker.worker2.lbfactor=1
- # Disable worker2 for all requests except failover
- worker.worker2.activation=disabled
-
- # Define the LB worker
- worker.router.type=lb
- worker.router.balance_workers=worker1,worker2
-</source>
-
-<p>
-The <b>redirect</b> flag on worker1 tells the <b>lb_worker</b> to redirect the requests
-to worker2 only if worker1 is in error state. In other cases worker2 will not receive
-any requests, thus acting like a hot standby.
-</p>
-
-
-</subsection>
-
<subsection name="Status Worker properties">
<p>
The status worker does not communicate with Tomcat.
@@ -488,7 +437,6 @@
worker.worker2.host=locahost
worker.worker2.port=8009
worker.worker2.lbfactor=1
- worker.worker2.connection_pool_size=10
worker.worker2.connection_pool_timeout=600
worker.worker2.socket_keepalive=1
worker.worker2.socket_timeout=60
Modified: tomcat/connectors/trunk/jk/xdocs/project.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/project.xml?view=diff&rev=476695&r1=476694&r2=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/project.xml (original)
+++ tomcat/connectors/trunk/jk/xdocs/project.xml Sat Nov 18 19:51:22 2006
@@ -22,7 +22,7 @@
<item name="HowTo and Install" href="howto/index.html"/>
<item name="Frequently asked questions" href="faq.html"/>
<item name="Changelog" href="changelog.html"/>
- <item name="Tools" href="common/tools.html"/>
+ <item name="Tools" href="tools/tools.html"/>
<item name="Old JK/JK2 documentation" href="http://tomcat.apache.org/connectors-doc-archive/jk2/index.html"/>
</menu>
Added: tomcat/connectors/trunk/jk/xdocs/tools/project.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/tools/project.xml?view=auto&rev=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/tools/project.xml (added)
+++ tomcat/connectors/trunk/jk/xdocs/tools/project.xml Sat Nov 18 19:51:22 2006
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Application Developer's Guide"
+ href="http://tomcat.apache.org/">
+
+ <title>Tomcat Connector</title>
+
+ <logo href="/images/tomcat.gif">
+ Tomcat Connector
+ </logo>
+<body>
+
+ <menu name="Links">
+ <item name="Docs Home" href="../index.html"/>
+ </menu>
+
+</body>
+</project>
Propchange: tomcat/connectors/trunk/jk/xdocs/tools/project.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/connectors/trunk/jk/xdocs/tools/project.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/connectors/trunk/jk/xdocs/tools/tools.xml
URL: http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/tools/tools.xml?view=auto&rev=476695
==============================================================================
--- tomcat/connectors/trunk/jk/xdocs/tools/tools.xml (added)
+++ tomcat/connectors/trunk/jk/xdocs/tools/tools.xml Sat Nov 18 19:51:22 2006
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="tools.html">
+
+ &project;
+<copyright>
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+</copyright>
+<properties>
+<title>Tools</title>
+<author>Glenn Nielsen</author>
+<date>$Date$</date>
+</properties>
+<body>
+<section name="Introduction">
+<p>Documentation for additional mod_jk related tools.</p>
+</section>
+
+<section name="Reports">
+<p>
+The mod_jk source distribution contains two perl scripts in the
+jk/tools/reports directory which can be used to analyze the mod_jk
+logs, save statistical data, and generate report graphs.
+</p>
+
+<p><code>tomcat_trend.pl log_dir archive_dir</code></p>
+<p>
+Script for analyzing mod_jk.log data when logging tomcat request data using
+the <code>JkRequestLogFormat</code> Apache mod_jk configuration.
+Generates statistics for request latency and errors. Archives the generated
+data to files for later use in long term trend graphs and reports.
+</p>
+
+<p><code>tomcat_reports.pl archive_dir reports_dir</code></p>
+<p>
+Script for generating reports and graphs using statistical data generated
+by the <code>tomcat_trend.pl</code> script.
+
+The following graphs are created:
+<ul>
+ <li>tomcat_request.png - Long term trend graph of total number of tomcat
+ requests handled.</li>
+ <li>tomcat_median.png - Long term overall trend graph of tomcat request
+ latency median.</li>
+ <li>tomcat_deviation.png - Long term overall trend graph of tomcat request
+ mean and standard deviation.</li>
+ <li>tomcat_error.png - Long term trend graph of requests rejected by tomcat.
+ Shows requests rejected when tomcat has no request processors available.
+ Can be an indicator that tomcat is overloaded or having other scaling
+ problems.</li>
+ <li>tomcat_client.png - Long term trend graph of requests forward to tomcat
+ which were aborted by the remote client (browser). You will normally see
+ some aborted requests. High numbers of these can be an indicator that
+ tomcat is overloaded or there are requests which have very high latency.</li>
+</ul>
+</p>
+
+<p>
+A great deal of statistical data is generated but at this time
+only long term trend graphs are being created and no reports.
+This is only a start. Many more graphs and reports could be
+generated from the data. Please consider contributing back any
+new reports or graphs you create. Thanks.
+</p>
+
+<p>
+These perl scripts depend upon the following perl modules and libraries:
+<ul>
+ <li>GD 1.8.x graphics library <a href="http://www.boutell.com/gd/">
+ http://www.boutell.com/gd/</a></li>
+ <li>GD 1.4.x perl module</li>
+ <li>GD Graph perl module</li>
+ <li>GD TextUtil perl module</li>
+ <li>StatisticsDescriptive perl module</li>
+</ul>
+</p>
+</section>
+
+</body>
+</document>
Propchange: tomcat/connectors/trunk/jk/xdocs/tools/tools.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/connectors/trunk/jk/xdocs/tools/tools.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org