You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by rd...@apache.org on 2006/02/14 22:39:55 UTC
svn commit: r377843 - /jakarta/commons/proper/logging/trunk/xdocs/guide.xml
Author: rdonkin
Date: Tue Feb 14 13:39:55 2006
New Revision: 377843
URL: http://svn.apache.org/viewcvs?rev=377843&view=rev
Log:
Copied SimpleLog description to user guide (from Javadocs) and edited. Issue #38643.
Modified:
jakarta/commons/proper/logging/trunk/xdocs/guide.xml
Modified: jakarta/commons/proper/logging/trunk/xdocs/guide.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/logging/trunk/xdocs/guide.xml?rev=377843&r1=377842&r2=377843&view=diff
==============================================================================
--- jakarta/commons/proper/logging/trunk/xdocs/guide.xml (original)
+++ jakarta/commons/proper/logging/trunk/xdocs/guide.xml Tue Feb 14 13:39:55 2006
@@ -73,6 +73,8 @@
<li><a href='#Creating A LogFactory Implementation'>Creating A LogFactory Implementation</a></li>
</ol>
</li>
+ <li><a href='#A%20Quick%20Guide%20To%20Simple%20Log'>A Quick Guide To Simple Log</a>
+ </li>
<li><a href='#Frequently Asked Questions'>Frequently Asked Questions</a>
</li>
</ol>
@@ -722,6 +724,66 @@
for details.
</p>
</subsection>
+</section>
+<section name='A Quick Guide To Simple Log'>
+ <p>
+JCL is distributed with a very simple <code>Log</code> implementation named
+<code>org.apache.commons.logging.impl.SimpleLog</code>. This is intended to be a minimal
+implementation and those requiring a fully functional open source logging system are
+directed to <a href='http://logging.apache.org/log4j'>Log4J</a>.
+ </p>
+ <p>
+ <code>SimpleLog</code> sends all (enabled) log messages,
+ for all defined loggers, to <code>System.err</code>. The following system properties
+ are supported to configure the behavior of this logger:</p>
+ <ul>
+ <li><strong>org.apache.commons.logging.simplelog.defaultlog</strong> -
+ Default logging detail level for all instances of SimpleLog.
+ Must be one of:
+ <ul>
+ <li><code>trace</code></li>
+ <li><code>debug</code></li>
+ <li><code>info</code></li>
+ <li><code>warn</code></li>
+ <li><code>error</code></li>
+ <li><code>fatal</code></li>
+ </ul>
+ If not specified, defaults to <code>info</code>. </li>
+ <li><strong>org.apache.commons.logging.simplelog.log.xxxxx</strong> -
+ Logging detail level for a SimpleLog instance named "xxxxx".
+ Must be one of:
+ <ul>
+ <li><code>trace</code></li>
+ <li><code>debug</code></li>
+ <li><code>info</code></li>
+ <li><code>warn</code></li>
+ <li><code>error</code></li>
+ <li><code>fatal</code></li>
+ </ul>
+ If not specified, the default logging detail level is used.</li>
+ <li><strong>org.apache.commons.logging.simplelog.showlogname</strong> -
+ Set to <code>true</code> if you want the <code>Log</code> instance name to be
+ included in output messages. Defaults to <code>false</code>.</li>
+ <li><strong>org.apache.commons.logging.simplelog.showShortLogname</strong> -
+ Set to <code>true</code> if you want the last component of the name to be
+ included in output messages. Defaults to <code>true</code>.</li>
+ <li><strong>org.apache.commons.logging.simplelog.showdatetime</strong> -
+ Set to <code>true</code> if you want the current date and time
+ to be included in output messages. Default is <code>false</code>.</li>
+ <li><strong>org.apache.commons.logging.simplelog.dateTimeFormat</strong> -
+ The date and time format to be used in the output messages.
+ The pattern describing the date and time format is the same that is
+ used in <code>java.text.SimpleDateFormat</code>. If the format is not
+ specified or is invalid, the default format is used.
+ The default format is <code>yyyy/MM/dd HH:mm:ss:SSS zzz</code>.</li>
+ </ul>
+
+ <p>
+In addition to looking for system properties with the names specified
+above, this implementation also checks for a class loader resource named
+<code>"simplelog.properties"</code>, and includes any matching definitions
+from this resource (if it exists).
+ </p>
</section>
<section name='Frequently Asked Questions'>
<p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org