Author: rjung
Date: Wed Dec 5 11:53:12 2012
New Revision: 1417372
URL: http://svn.apache.org/viewvc?rev=1417372&view=rev
Log:
Logically reorder attribute docs for ALV.
It was neither alphabetical nor especially
logical before. Hope this one is better.
Modified:
tomcat/trunk/webapps/docs/config/valve.xml
Modified: tomcat/trunk/webapps/docs/config/valve.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/valve.xml?rev=1417372&r1=1417371&r2=1417372&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/trunk/webapps/docs/config/valve.xml Wed Dec 5 11:53:12 2012
@@ -119,70 +119,28 @@
(relative to $CATALINA_BASE).</p>
</attribute>
- <attribute name="encoding" required="false">
- <p>Character set used to write the log file. An empty string means
- to use the system default character set. Default value: use the
- system default character set.
- </p>
- </attribute>
-
- <attribute name="locale" required="false">
- <p>The locale used to format timestamps in the access log
- lines. Any timestamps configured using an
- explicit SimpleDateFormat pattern (<code>%{xxx}t</code>)
- are formatted in this locale. By default the
- default locale of the Java process is used. Switching the
- locale after the AccessLogValve is initialized is not supported.
- Any timestamps using the common log format
- (<code>CLF</code>) are always formatted in the locale
- <code>en_US</code>.
- </p>
- </attribute>
-
- <attribute name="maxLogMessageBufferSize" required="false">
- <p>Log message buffers are usually recycled and re-used. To prevent
- excessive memory usage, if a buffer grows beyond this size it will
be
- discarded. The default is <code>256</code> characters. This should
be
- set to larger than the typical access log message size.</p>
- </attribute>
-
- <attribute name="pattern" required="false">
- <p>A formatting layout identifying the various information fields
- from the request and response to be logged, or the word
- <code>common</code> or <code>combined</code> to select a
- standard format. See below for more information on configuring
- this attribute.</p>
- </attribute>
-
<attribute name="prefix" required="false">
<p>The prefix added to the start of each log file's name. If not
specified, the default value is "access_log.".</p>
</attribute>
- <attribute name="requestAttributesEnabled" required="false">
- <p>Set to <code>true</code> to check for the existence of request
- attributes (typically set by the RemoteIpValve and similar) that should
- be used to override the values returned by the request for remote
- address, remote host, server port and protocol. If the attributes are
- not set, or this attribute is set to <code>false</code> then the values
- from the request will be used. If not set, the default value of
- <code>false</code> will be used.</p>
- </attribute>
-
- <attribute name="resolveHosts" required="false">
- <p>This attribute is no longer supported. Use the connector
- attribute <code>enableLookups</code> instead.</p>
- <p>If you have <code>enableLookups</code> on the connector set to
- <code>true</code> and want to ignore it, use <b>%a</b> instead of
- <b>%h</b> in the value of <code>pattern</code>.</p>
- </attribute>
-
<attribute name="suffix" required="false">
<p>The suffix added to the end of each log file's name. If not
specified, the default value is "" (a zero-length string),
meaning that no suffix will be added.</p>
</attribute>
+ <attribute name="fileDateFormat" required="false">
+ <p>Allows a customized timestamp in the access log file name.
+ The file is rotated whenever the formatted timestamp changes.
+ The default value is <code>.yyyy-MM-dd</code>.
+ If you wish to rotate every hour, then set this value
+ to <code>.yyyy-MM-dd.HH</code>.
+ The date format will always be localized
+ using the locale <code>en_US</code>.
+ </p>
+ </attribute>
+
<attribute name="rotatable" required="false">
<p>Flag to determine if log rotation should occur.
If set to <code>false</code>, then this file is never rotated and
@@ -205,6 +163,44 @@
</p>
</attribute>
+ <attribute name="pattern" required="false">
+ <p>A formatting layout identifying the various information fields
+ from the request and response to be logged, or the word
+ <code>common</code> or <code>combined</code> to select a
+ standard format. See below for more information on configuring
+ this attribute.</p>
+ </attribute>
+
+ <attribute name="encoding" required="false">
+ <p>Character set used to write the log file. An empty string means
+ to use the system default character set. Default value: use the
+ system default character set.
+ </p>
+ </attribute>
+
+ <attribute name="locale" required="false">
+ <p>The locale used to format timestamps in the access log
+ lines. Any timestamps configured using an
+ explicit SimpleDateFormat pattern (<code>%{xxx}t</code>)
+ are formatted in this locale. By default the
+ default locale of the Java process is used. Switching the
+ locale after the AccessLogValve is initialized is not supported.
+ Any timestamps using the common log format
+ (<code>CLF</code>) are always formatted in the locale
+ <code>en_US</code>.
+ </p>
+ </attribute>
+
+ <attribute name="requestAttributesEnabled" required="false">
+ <p>Set to <code>true</code> to check for the existence of request
+ attributes (typically set by the RemoteIpValve and similar) that should
+ be used to override the values returned by the request for remote
+ address, remote host, server port and protocol. If the attributes are
+ not set, or this attribute is set to <code>false</code> then the values
+ from the request will be used. If not set, the default value of
+ <code>false</code> will be used.</p>
+ </attribute>
+
<attribute name="conditionIf" required="false">
<p>Turns on conditional logging. If set, requests will be
logged only if <code>ServletRequest.getAttribute()</code> is
@@ -233,17 +229,6 @@
</p>
</attribute>
- <attribute name="fileDateFormat" required="false">
- <p>Allows a customized timestamp in the access log file name.
- The file is rotated whenever the formatted timestamp changes.
- The default value is <code>.yyyy-MM-dd</code>.
- If you wish to rotate every hour, then set this value
- to <code>.yyyy-MM-dd.HH</code>.
- The date format will always be localized
- using the locale <code>en_US</code>.
- </p>
- </attribute>
-
<attribute name="buffered" required="false">
<p>Flag to determine if logging will be buffered.
If set to <code>false</code>, then access logging will be written
after each
@@ -251,6 +236,21 @@
</p>
</attribute>
+ <attribute name="maxLogMessageBufferSize" required="false">
+ <p>Log message buffers are usually recycled and re-used. To prevent
+ excessive memory usage, if a buffer grows beyond this size it will
be
+ discarded. The default is <code>256</code> characters. This should
be
+ set to larger than the typical access log message size.</p>
+ </attribute>
+
+ <attribute name="resolveHosts" required="false">
+ <p>This attribute is no longer supported. Use the connector
+ attribute <code>enableLookups</code> instead.</p>
+ <p>If you have <code>enableLookups</code> on the connector set to
+ <code>true</code> and want to ignore it, use <b>%a</b> instead of
+ <b>%h</b> in the value of <code>pattern</code>.</p>
+ </attribute>
+
</attributes>
<p>Values for the <code>pattern</code> attribute are made up of literal
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
