Return-Path:
X-Original-To: apmail-tomcat-dev-archive@www.apache.org
Delivered-To: apmail-tomcat-dev-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
by minotaur.apache.org (Postfix) with SMTP id F205617462
for ;
Tue, 1 Sep 2015 14:32:38 +0000 (UTC)
Received: (qmail 8307 invoked by uid 500); 1 Sep 2015 14:32:32 -0000
Delivered-To: apmail-tomcat-dev-archive@tomcat.apache.org
Received: (qmail 8233 invoked by uid 500); 1 Sep 2015 14:32:32 -0000
Mailing-List: contact dev-help@tomcat.apache.org; run by ezmlm
Precedence: bulk
List-Help:
List-Unsubscribe:
List-Post:
List-Id:
Reply-To: "Tomcat Developers List"
Delivered-To: mailing list dev@tomcat.apache.org
Received: (qmail 8223 invoked by uid 99); 1 Sep 2015 14:32:32 -0000
Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105)
by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 01 Sep 2015 14:32:32 +0000
Received: from hades.apache.org (localhost [127.0.0.1])
by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id
EDCFBAC0095
for ; Tue, 1 Sep 2015 14:32:31 +0000 (UTC)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1700577 - in /tomcat/jk/trunk/xdocs/reference:
apache.xml
iis.xml status.xml uriworkermap.xml workers.xml
Date: Tue, 01 Sep 2015 14:32:31 -0000
To: dev@tomcat.apache.org
From: rjung@apache.org
X-Mailer: svnmailer-1.0.9
Message-Id: <20150901143231.EDCFBAC0095@hades.apache.org>
Author: rjung
Date: Tue Sep 1 14:32:31 2015
New Revision: 1700577
URL: http://svn.apache.org/r1700577
Log:
Minor docs tweaks.
Modified:
tomcat/jk/trunk/xdocs/reference/apache.xml
tomcat/jk/trunk/xdocs/reference/iis.xml
tomcat/jk/trunk/xdocs/reference/status.xml
tomcat/jk/trunk/xdocs/reference/uriworkermap.xml
tomcat/jk/trunk/xdocs/reference/workers.xml
Modified: tomcat/jk/trunk/xdocs/reference/apache.xml
URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/apache.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/apache.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/apache.xml Tue Sep 1 14:32:31 2015
@@ -24,14 +24,14 @@
Mladen Turk
- Configuring Apache
+ Configuring mod_jk for the Apache HTTP Server
-Most of the directives are allowed once in the global part of the Apache httpd
+Most of the directives are allowed once in the global part of the Apache HTTP Server
configuration and once in every <VirtualHost> elements. Exceptions from this rule are
explicitly listed in the table below.
@@ -42,15 +42,15 @@ Exceptions from this rule are again expl
See especially JkMountCopy.
-Warning: If Apache httpd and Tomcat are configured to serve content from
-the same filing system location then care must be taken to ensure that httpd is
+Warning: If Apache and Tomcat are configured to serve content from
+the same file system location then care must be taken to ensure that Apache is
not able to serve inappropriate content such as the contents of the WEB-INF
directory or JSP source code.
-This could occur if the httpd DocumentRoot
+This could occur if the Apache DocumentRoot
overlaps with a Tomcat Host's appBase or the docBase of any Context. It could
-also occur when using the httpd Alias directive with a Tomcat Host's appBase or
+also occur when using the Apache Alias directive with a Tomcat Host's appBase or
the docBase of any Context.
@@ -71,7 +71,7 @@ value.
Enables setting worker properties inside Apache configuration file.
The syntax is the same as in the JkWorkersFile (usually workers.properties).
Simply prefix each line with "JkWorkerProperty" to put it directly into
-the Apache httpd config files.
+the Apache config files.
This directive is allowed multiple times.
It must be put into the global part of the configuration.
@@ -95,7 +95,7 @@ drive and not an NFS share.
The shared memory contains configuration and runtime information for load balancer
-workers and their members. It is need in order that all apache children
+workers and their members. It is need in order that all Apache children
share the same status information for load balancing members (OK, ERROR, ...),
share the information about load taken by the individual workers,
@@ -181,8 +181,8 @@ This directive is available in jk1.2.7 v
Automatically Alias webapp context directories into the Apache
document space.
-Care should be taken to ensure that only static content is served via httpd as a
-result of using this directive. Any static content served by httpd will bypass any
+Care should be taken to ensure that only static content is served via Apache as a
+result of using this directive. Any static content served by Apache will bypass any
security constraints defined in the application's web.xml.
For inheritance rules, see: JkMountCopy.
@@ -238,7 +238,7 @@ This directive is only allowed once. It
the global part of the configuration.
This directive has been added in version 1.2.27 of mod_jk.
-It is available only for httpd 2.x and above using APR libraries
+It is available only for Apache 2.x and above using APR libraries
including thread support.
@@ -290,7 +290,7 @@ to add SSLOptions +ExportCertData<
Specifically, mod_jk will export the following environment variables from
- Apache httpd to Tomcat under these request attributes as per the
+ Apache to Tomcat under these request attributes as per the
Servlet Specification 3.0, section 3.8:
@@ -554,7 +554,7 @@ be used for piped logging:
JkLogLevel
-set the log level between :
+set the log level between:
@@ -601,7 +601,7 @@ See above for details.
You can log mod_jk information using the Apache standard module mod_log_config.
-The module sets several notes in the Apache httpd notes table.
+The module sets several notes in the Apache notes table.
Most of them are are only useful in combination with a load balancer worker.
@@ -613,26 +613,26 @@ Most of them are are only useful in comb
Before version 1.2.26 only available if JkRequestLogFormat is set.
Request duration in seconds and microseconds.
Before version 1.2.26 only available if JkRequestLogFormat is set.
- Load-Balancer: Name of the first worker tried
- Load-Balancer: Type of the first worker tried
- Load-Balancer: Access count for the first worker tried
- Load-Balancer: Count of created sessions for the first worker tried
- Load-Balancer: Bytes read for the first worker tried
- Load-Balancer: Bytes transferred for the first worker tried
- Load-Balancer: Error count for the first worker tried
- Load-Balancer: Busy count for the first worker tried
- Load-Balancer: Activation state for the first worker tried
- Load-Balancer: Error state for the first worker tried
- Load-Balancer: Name of the last worker tried
- Load-Balancer: Type of the last worker tried
- Load-Balancer: Access count for the last worker tried
- Load-Balancer: Count of created sessions for the last worker tried
- Load-Balancer: Bytes read for the last worker tried
- Load-Balancer: Bytes transferred for the last worker tried
- Load-Balancer: Error count for the last worker tried
- Load-Balancer: Busy count for the last worker tried
- Load-Balancer: Activation state for the last worker tried
- Load-Balancer: Error state for the last worker tried
+ Load balancer: Name of the first worker tried
+ Load balancer: Type of the first worker tried
+ Load balancer: Access count for the first worker tried
+ Load balancer: Count of created sessions for the first worker tried
+ Load balancer: Bytes read for the first worker tried
+ Load balancer: Bytes transferred for the first worker tried
+ Load balancer: Error count for the first worker tried
+ Load balancer: Busy count for the first worker tried
+ Load balancer: Activation state for the first worker tried
+ Load balancer: Error state for the first worker tried
+ Load balancer: Name of the last worker tried
+ Load balancer: Type of the last worker tried
+ Load balancer: Access count for the last worker tried
+ Load balancer: Count of created sessions for the last worker tried
+ Load balancer: Bytes read for the last worker tried
+ Load balancer: Bytes transferred for the last worker tried
+ Load balancer: Error count for the last worker tried
+ Load balancer: Busy count for the last worker tried
+ Load balancer: Activation state for the last worker tried
+ Load balancer: Error state for the last worker tried
A Tomcat worker is a Tomcat instance that is waiting to execute servlets or any other content
on behalf of some web server. For example, we can have a web server such as
-Apache forwarding servlet requests to a Tomcat process (the worker) running behind it.
+the Apache HTTP Server forwarding servlet requests to a Tomcat process (the worker) running behind it.
The scenario described above is a very simple one;
@@ -144,7 +144,7 @@ Each worker configuration directive cons
worker.<worker name>.<directive>=<value>
The first word is always worker.
-The second word is the worker name you can choose. In the case of load-balancing,
+The second word is the worker name you can choose. In the case of load balancing,
the worker name has an additional meaning. Please consult the
Load Balancer HowTo.
@@ -220,16 +220,19 @@ be unavailable or will misbehave. Those
-Type of the worker (can be one of ajp13, ajp14, jni, lb or status). The type of the worker
+Type of the worker (can be one of ajp12, ajp13, ajp14, jni, lb or status). The type of the worker
defines the directives that can be applied to the worker.
Type ajp13 is the preferred worker type that JK uses for communication
between web server and Tomcat. This type of worker uses sockets as communication
-channel. For detailed description of the AJP13 protocol stack browse to
-AJPv13 protocol specification
+channel. For detailed description of the ajp13 protocol stack browse to
+AJPv13 protocol specification. Type lb is
+used for load balancing workers,
+type status for status workers.
-
Type ajp14 is experimental and not recommended.
+
Type ajp14 is experimental and not recommended, type ajp12
+is obsolete.
-JNI workers have been deprecated. They will likely not work. Do not use them.
+JNI workers are no longer supported and will likely not work. Do not use them.
@@ -284,13 +287,13 @@ This feature has been added in jk 1.2
-This directive should be used when you have a firewall between your webserver
+This directive should be used when you have a firewall between your web server
and the Tomcat engine, who tend to drop inactive connections. This flag will tell the Operating System
to send KEEP_ALIVE messages on inactive connections (interval depend on global OS settings,
generally 120 minutes), and thus prevent the firewall to cut inactive connections.
To enable keepalive set this property value to true.
-The problem with Firewall cutting inactive connections is that sometimes, neither webserver or Tomcat
+The problem with Firewall cutting inactive connections is that sometimes, neither web server or Tomcat
have information about the cut and couldn't handle it.
@@ -375,15 +378,16 @@ It will limit the number of those connec
process can made.
Connection pool size property is only used for multi threaded
-web servers such as Apache, IIS and Netscape/Sun. The connection_pool_size property
+web servers such as the Apache HTTP Server, Microsoft IIS and the iPlanet Web Server.
+The connection_pool_size property
needs to reflect the number of requests one web server process should
be able to send to a backend in parallel. Usually this is the same as
the number of threads per web server process. JK will discover
-this number for the Apache web server automatically and set the pool size to
+this number for the Apache HTTP Server automatically and set the pool size to
this value. For IIS the default value is 250 (before version 1.2.20: 10),
-for Netscape/Sun the default value is 1.
+for iPlanet the default value is 1.
-
We strongly recommend adjusting this value for IIS and the Netscape/Sun
+
We strongly recommend adjusting this value for IIS and iPlanet
to the number of requests one web server process should
be able to send to a backend in parallel. You should measure how many connections
you need during peak activity without performance problems, and then add some
@@ -391,7 +395,7 @@ percentage depending on your growth rate
whether your web server processes are able to use at least as many threads,
as you configured as the pool size.
-Do not use connection_pool_size with values higher then 1 on Apache 2.x prefork or Apache 1.3.x!
+Do not use connection_pool_size with values higher then 1 on Apache 2.x with prefork MPM or Apache 1.3.x!
@@ -399,7 +403,7 @@ Minimum size of the connection pool that
Its default value is (connection_pool_size+1)/2.
-Do not use connection_pool_size with values higher then 1 on Apache 2.x prefork or Apache 1.3.x!
+Do not use connection_pool_minsize with values higher then 1 on Apache 2.x with prefork MPM or Apache 1.3.x!
This feature has been added in jk 1.2.16.
@@ -415,7 +419,7 @@ a new ajp13 thread on Tomcat side.
The problem is that after an ajp13 connection is created, the child won't drop it
-until killed. And since the webserver will keep its childs/threads running
+until killed. And since the web server will keep its childs/threads running
to handle high-load, even it the child/thread handle only static contents, you could
finish having many unused ajp13 threads on the Tomcat side.
@@ -440,7 +444,7 @@ This feature has been added in jk 1.2
Only used for a member worker of a load balancer.
-The integer number lbfactor (load-balancing factor) is
+The integer number lbfactor (load balancing factor) is
how much we expect this worker to work, or
the worker's work quota. 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
@@ -472,21 +476,21 @@ Load balancer management includes:
Instantiating the workers in the web server.
-Using the worker's load-balancing factor, perform weighed-round-robin load balancing where
+Using the worker's load balancing factor, perform weighted round-robin load balancing where
high lbfactor means stronger machine (that is going to handle more requests)
Keeping requests belonging to the same session executing on the same Tomcat worker.
-Identifying failed Tomcat workers, suspending requests to them and instead fall-backing on
+Identifying failed Tomcat workers, suspending requests to them and instead fail over on
other workers managed by the lb worker.
-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
+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 fail over so a single
Tomcat process death will not "kill" the entire site.
@@ -524,7 +528,7 @@ sticky_session is set to false. S
is using a Session Manager which can persist session data across multiple
instances of Tomcat.
-The sticky_session setting can be overwritten using the Apache httpd
+The sticky_session setting can be overwritten using the Apache HTTP Server
environment variable JK_STICKY_IGNORE and the worker map extension for
sticky_ignore. This has been added in version 1.2.33.
@@ -572,7 +576,7 @@ without a session cookie or URL encoding
know, when a session is being invalidated, nor will it correct its load numbers
according to session timeouts or worker failover. If you know request URLs, that will be
called without a session ID but should not be counted as new sessions, you should
-add them to the stateless mapping rule extension or set the Apache HTTPD
+add them to the stateless mapping rule extension or set the Apache HTTP Server
environment variable JK_STATELESS for them.
@@ -771,7 +775,7 @@ as a sub worker or member.
-Connect timeout property told webserver to send a PING request on ajp13 connection after
+Connect timeout property told web server to send a PING request on ajp13 connection after
connection is established. The parameter is the delay in milliseconds to wait for the PONG reply.
The default value zero disables the timeout (infinite timeout).
@@ -782,7 +786,7 @@ Disabled by default.
-Prepost timeout property told webserver to send a PING request on ajp13 connection before
+Prepost timeout property told web server to send a PING request on ajp13 connection before
forwarding to it a request. The parameter is the delay in milliseconds to wait for the PONG reply.
The default value zero disables the timeout (infinite timeout).
@@ -798,7 +802,7 @@ So this is not a timeout for the complet
for the maximum time between two packets received from Tomcat. Usually the longest
pause is between sending the request and getting the first packet of the response.
-If the timeout passes without any data received from Tomcat, the webserver will
+If the timeout passes without any data received from Tomcat, the web server will
no longer wait for the rest of the response and send an error to the client (browser).
Usually this does not mean, that the request is also aborted on the Tomcat backend.
If the worker is a member of a load balancer, the load balancer might place the
@@ -806,11 +810,11 @@ worker into an error state and retry the
See also max_reply_timeouts, retries and recovery_options.
-By default (value zero) the webserver will wait forever which could be an issue for you.
+By default (value zero) the web server will wait forever which could be an issue for you.
If you set a reply_timeout, adjust it carefully if you have long running servlets.
-The reply_timeout can be overwritten using the Apache httpd environment variable
+The reply_timeout can be overwritten using the Apache HTTP Server environment variable
JK_REPLY_TIMEOUT and the worker map extension for reply_timeout.
@@ -1163,13 +1167,13 @@ It will limit the number of those connec
process can make.
Cachesize property is used only for multi threaded
-web servers such as Apache 2.0 (worker), IIS and Netscape. The cachesize property
+web servers such as Apache HTTP Server 2.x (all MPMs except prefork), IIS and iPlanet. The cachesize property
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 than Apache or IIS this value has to be set manually.
+the number of threads per child process on the Apache HTTP Server with threaded MPM and set
+its default value to match the current ThreadsPerChild Apache configuration. For IIS the default
+value is 10. For web servers other than Apache or IIS this value has to be set manually.
-Do not use cachesize with values higher then 1 on Apache 2.x prefork or Apache 1.3.x!
+Do not use cachesize with values higher then 1 on Apache 2.x with prefork MPM or Apache 1.3.x!
@@ -1183,7 +1187,7 @@ a new ajp13 thread on Tomcat side.
The problem is that after an ajp13 connection is created, the child won't drop it
-until killed. And since the webserver will keep its childs/threads running
+until killed. And since the web server will keep its childs/threads running
to handle high-load, even it the child/thread handle only static contents, you could
finish having many unused ajp13 threads on the Tomcat side.
@@ -1191,7 +1195,7 @@ finish having many unused ajp13 threads
This directive has been deprecated since 1.2.16.
-The number of seconds that told webserver to cut an ajp13 connection after some time of
+The number of seconds that told web server to cut an ajp13 connection after some time of
inactivity. When choosing an endpoint for a request and the assigned socket is open, it will be
closed if it was not used for the configured time.
It's a good way to ensure that there won't too old threads living on Tomcat side,
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org