Author: markt
Date: Mon Mar 19 14:30:26 2018
New Revision: 1827204
URL: http://svn.apache.org/viewvc?rev=1827204&view=rev
Log:
List AccessLogValve attributes in alphabetical order
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=1827204&r1=1827203&r2=1827204&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/trunk/webapps/docs/config/valve.xml Mon Mar 19 14:30:26 2018
@@ -114,12 +114,47 @@
<attributes>
+ <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
+ request. Default value: <code>true</code>
+ </p>
+ </attribute>
+
<attribute name="className" required="true">
<p>Java class name of the implementation to use. This MUST be set to
<strong>org.apache.catalina.valves.AccessLogValve</strong> to use the
default access log valve.</p>
</attribute>
+ <attribute name="condition" required="false">
+ <p>The same as <code>conditionUnless</code>. This attribute is
+ provided for backwards compatibility.
+ </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
+ not null. For example, if this value is set to
+ <code>important</code>, then a particular request will only be
logged
+ if <code>ServletRequest.getAttribute("important") != null</code>.
+ The use of Filters is an easy way to set/unset the attribute
+ in the ServletRequest on many different requests.
+ </p>
+ </attribute>
+
+ <attribute name="conditionUnless" required="false">
+ <p>Turns on conditional logging. If set, requests will be
+ logged only if <code>ServletRequest.getAttribute()</code> is
+ null. For example, if this value is set to
+ <code>junk</code>, then a particular request will only be logged
+ if <code>ServletRequest.getAttribute("junk") == null</code>.
+ The use of Filters is an easy way to set/unset the attribute
+ in the ServletRequest on many different requests.
+ </p>
+ </attribute>
+
<attribute name="directory" required="false">
<p>Absolute or relative pathname of a directory in which log files
created by this valve will be placed. If a relative path is
@@ -128,15 +163,11 @@
(relative to $CATALINA_BASE).</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="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 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="fileDateFormat" required="false">
@@ -150,26 +181,24 @@
</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
- <code>fileDateFormat</code> is ignored.
- Default value: <code>true</code>
+ <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="renameOnRotate" required="false">
- <p>By default for a rotatable log the active access log file name
- will contain the current timestamp in <code>fileDateFormat</code>.
- During rotation the file is closed and a new file with the next
- timestamp in the name is created and used. When setting
- <code>renameOnRotate</code> to <code>true</code>, the timestamp
- is no longer part of the active log file name. Only during rotation
- the file is closed and then renamed to include the timestamp.
- This is similar to the behavior of most log frameworks when
- doing time based rotation.
- Default value: <code>false</code>
- </p>
+ <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">
@@ -180,23 +209,22 @@
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 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="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>.
+ <attribute name="renameOnRotate" required="false">
+ <p>By default for a rotatable log the active access log file name
+ will contain the current timestamp in <code>fileDateFormat</code>.
+ During rotation the file is closed and a new file with the next
+ timestamp in the name is created and used. When setting
+ <code>renameOnRotate</code> to <code>true</code>, the timestamp
+ is no longer part of the active log file name. Only during rotation
+ the file is closed and then renamed to include the timestamp.
+ This is similar to the behavior of most log frameworks when
+ doing time based rotation.
+ Default value: <code>false</code>
</p>
</attribute>
@@ -210,48 +238,6 @@
<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
- not null. For example, if this value is set to
- <code>important</code>, then a particular request will only be
logged
- if <code>ServletRequest.getAttribute("important") != null</code>.
- The use of Filters is an easy way to set/unset the attribute
- in the ServletRequest on many different requests.
- </p>
- </attribute>
-
- <attribute name="conditionUnless" required="false">
- <p>Turns on conditional logging. If set, requests will be
- logged only if <code>ServletRequest.getAttribute()</code> is
- null. For example, if this value is set to
- <code>junk</code>, then a particular request will only be logged
- if <code>ServletRequest.getAttribute("junk") == null</code>.
- The use of Filters is an easy way to set/unset the attribute
- in the ServletRequest on many different requests.
- </p>
- </attribute>
-
- <attribute name="condition" required="false">
- <p>The same as <code>conditionUnless</code>. This attribute is
- provided for backwards compatibility.
- </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
- request. Default value: <code>true</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="resolveHosts" required="false">
<p>This attribute is no longer supported. Use the connector
attribute <code>enableLookups</code> instead.</p>
@@ -260,6 +246,20 @@
<b>%h</b> in the value of <code>pattern</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
+ <code>fileDateFormat</code> is ignored.
+ Default value: <code>true</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>
+
</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
