You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/11/17 16:01:53 UTC
svn commit: r1410734 -
/maven/site/trunk/src/site/markdown/logging-with-slf4j.md
Author: hboutemy
Date: Sat Nov 17 15:01:52 2012
New Revision: 1410734
URL: http://svn.apache.org/viewvc?rev=1410734&view=rev
Log:
improved formatting
Modified:
maven/site/trunk/src/site/markdown/logging-with-slf4j.md
Modified: maven/site/trunk/src/site/markdown/logging-with-slf4j.md
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/markdown/logging-with-slf4j.md?rev=1410734&r1=1410733&r2=1410734&view=diff
==============================================================================
--- maven/site/trunk/src/site/markdown/logging-with-slf4j.md (original)
+++ maven/site/trunk/src/site/markdown/logging-with-slf4j.md Sat Nov 17 15:01:52 2012
@@ -18,11 +18,11 @@ under the License.
-->
# Maven 3.1.x logging with SLF4J
-We have reached the decision that SLF4J is the best option for a logging API. SLF4J has reached a certain level of Ubiquity and while SLF4J may not be perfect, it's the de facto standard and it's pointless to try and remake another one. SLF4J is used by many prominent Java OSS projects including 15 Apache projects already.
+We have reached the decision that [SLF4J][1] is the best option for a logging API. SLF4J has reached a certain level of Ubiquity and while SLF4J may not be perfect, it's the de facto standard and it's pointless to try and remake another one. SLF4J is used by many prominent Java OSS projects including 15 Apache projects already.
-There are many implementations to choose from, including Logback and Log4J. All the hard work has been done. All the bridges and funnels for other systems function well which allows others to use whatever logging implementation they like in their components while still being able to have integrated logging.
+There are many implementations to choose from, including [Logback][4] and [Log4j2][3]. All the hard work has been done. All the bridges and funnels for other systems function well, which allows others to use whatever logging implementation they like in their components while still being able to have integrated logging.
-The standard Maven distribution, from Maven 3.1.0 onward, uses the [SLF4J API][1] for logging combined with the [SLF4J Simple][1] implementation. Looking at the distribution you will see the following layout where the `simplelogger.properties`, `slf4j-api-1.7.2-jar` and `slf4j-simple-1.7.2.jar` specifically relate to the SLF4J implementation.
+The standard Maven distribution, from Maven 3.1.0 onward, uses the [SLF4J API][6] for logging combined with the [SLF4J Simple][7] implementation. Looking at the distribution you will see the following layout where the `simplelogger.properties`, `slf4j-api-1.7.2-jar` and `slf4j-simple-1.7.2.jar` specifically relate to the SLF4J implementation.
<pre>
m2
@@ -30,14 +30,9 @@ m2
âââ NOTICE.txt
âââ README.txt
âââ bin
-â  âââ m2.conf
-â  âââ mvn
-â  âââ mvn.bat
-â  âââ mvnDebug
-â  âââ mvnDebug.bat
-â  âââ mvnyjp
+â  âââ ...
âââ boot
-â  âââ plexus-classworlds-2.4.jar
+â  âââ ...
âââ conf
â  âââ logging
â  â  âââ simplelogger.properties
@@ -55,43 +50,43 @@ To configure logging with the [SLF4J Sim
<table class="table">
<tr>
-<td><b>org.slf4j.simpleLogger.logFile</b></td>
+<td><code>org.slf4j.simpleLogger.<b>logFile</b></code></td>
<td>The output target which can be the path to a file, or the special values "System.out" and "System.err". Default is "System.err".</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.defaultLogLevel</b></td>
+<td><code>org.slf4j.simpleLogger.<b>defaultLogLevel</b></code></td>
<td>Default log level for all instances of SimpleLogger. Must be one of ("trace", "debug", "info", "warn", or "error"). If not specified, defaults to "info".</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.log.a.b.c</b></td>
+<td><code>org.slf4j.simpleLogger.<b>log.a.b.c</b></code></td>
<td>Logging detail level for a SimpleLogger instance named "a.b.c". Right-side value must be one of "trace", "debug", "info", "warn", or "error". When a SimpleLogger named "a.b.c" is initialized, its level is assigned from this property. If unspecified, the level of nearest parent logger will be used, and if none is set, then the value specified by org.slf4j.simpleLogger.defaultLogLevel will be used.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.showDateTime</b></td>
+<td><code>org.slf4j.simpleLogger.<b>showDateTime</b></code></td>
<td>Set to true if you want the current date and time to be included in output messages. Default is true</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.dateTimeFormat</b></td>
+<td><code>org.slf4j.simpleLogger.<b>dateTimeFormat</b></code></td>
<td>The date and time format to be used in the output messages. The pattern describing the date and time format is defined by SimpleDateFormat. If the format is not specified or is invalid, the number of milliseconds since start up will be output.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.showThreadName</b></td>
+<td><code>org.slf4j.simpleLogger.<b>showThreadName</b></code></td>
<td>Set to true if you want to output the current thread name. Defaults to true.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.showLogName</b></td>
+<td><code>org.slf4j.simpleLogger.<b>showLogName</b></code></td>
<td>Set to true if you want the Logger instance name to be included in output messages. Defaults to true.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.showShortLogName</b></td>
+<td><code>org.slf4j.simpleLogger.<b>showShortLogName</b></code></td>
<td>Set to true if you want the last component of the name to be included in output messages. Defaults to false.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.levelInBrackets</b></td>
+<td><code>org.slf4j.simpleLogger.<b>levelInBrackets</b></code></td>
<td>Should the level string be output in brackets? Defaults to false.</td>
</tr>
<tr>
-<td><b>org.slf4j.simpleLogger.warnLevelString</b></td>
+<td><code>org.slf4j.simpleLogger.<b>warnLevelString</b></code></td>
<td>The string value output for the warn level. Defaults to WARN.</td>
</tr>
</table>
@@ -120,3 +115,5 @@ If you want use a different logging impl
[3]: http://logging.apache.org/log4j/2.x/slf4j-impl/
[4]: http://logback.qos.ch
[5]: http://eclipse.org/m2e/
+|6]: http://slf4j.org/apidocs/
+[7]: http://www.slf4j.org/apidocs/org/slf4j/impl/SimpleLogger.html