Wiki source code of Logging
Version 1.6 by Vincent Massol on 2007/12/10
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 Logging | ||
| 2 | |||
| 3 | XWiki uses Commons Logging for logging. By default XWiki is configured so that Commons Logging uses log4J. XWiki's Log4J configuration is located inside XWiki's JAR (xwiki.jar), in a <tt>[log4j.properties>http://fisheye2.cenqua.com/browse/~raw,r=trunk/xwiki/xwiki-platform/core/trunk/src/main/resources/log4j.properties]</tt> file. XWiki' JAR is itself located in your <tt>WEB-INF/lib/</tt> directory. | ||
| 4 | |||
| 5 | #info("By default XWiki is configured to log everythinf both on the console and in a xwiki.log file located in the directory from where you have started the JVL. This is usually the directory from where you have started your application server/Servlet container. It's recommended to either start the JVM from a location where it's ok to output the xwiki.log file or to create a custom Log4J configuration as explained below.") | ||
| 6 | |||
| 7 | 1.1 Using a custom Log4J configuration | ||
| 8 | |||
| 9 | The best solution is to create a new <tt>log4j.properties</tt> file in your <tt>WEB-INF/classes</tt> directory. It'll thus override the one from the XWiki JAR. As an example, here's a sample configuration: | ||
| 10 | |||
| 11 | {code:none} | ||
| 12 | ### Direct log messages to stdout | ||
| 13 | log4j.appender.stdout=org.apache.log4j.ConsoleAppender | ||
| 14 | log4j.appender.stdout.Target=System.out | ||
| 15 | log4j.appender.stdout.layout=org.apache.log4j.PatternLayout | ||
| 16 | log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %t %X{url} %c{1}:%M:%L - %m%n | ||
| 17 | |||
| 18 | log4j.appender.file=org.apache.log4j.RollingFileAppender | ||
| 19 | log4j.appender.file.File=xwiki.log | ||
| 20 | log4j.appender.file.MaxFileSize=10MB | ||
| 21 | log4j.appender.file.MaxBackupIndex=50 | ||
| 22 | log4j.appender.file.layout = org.apache.log4j.PatternLayout | ||
| 23 | log4j.appender.file.layout.ConversionPattern = %d{ABSOLUTE} [%t] %-5p %-30.30c{2} %x - %m %n | ||
| 24 | |||
| 25 | ### By default everything that is of warning or severity WARN, ERROR or FATAL is logged both to | ||
| 26 | ### the console and to the xwiki.log file. | ||
| 27 | log4j.rootLogger=warn, stdout, file | ||
| 28 | |||
| 29 | ### Hibernate logging options | ||
| 30 | log4j.logger.org.hibernate=warn | ||
| 31 | log4j.logger.org.hibernate.SQL=warn | ||
| 32 | log4j.logger.org.hibernate.type=warn | ||
| 33 | log4j.logger.org.hibernate.ps.PreparedStatementCache=warn | ||
| 34 | |||
| 35 | ### XWiki logging configuration | ||
| 36 | log4j.logger.com.xpn.xwiki=warn | ||
| 37 | log4j.logger.com.xpn.xwiki.render.XWikiRadeoxRenderEngine=warn | ||
| 38 | |||
| 39 | ### Deactivate Radeox warnings | ||
| 40 | log4j.logger.org.radeox.macro.BaseLocaleMacro=error | ||
| 41 | |||
| 42 | ### Deactivate Struts warnings | ||
| 43 | log4j.logger.org.apache.struts.util.RequestUtils=error | ||
| 44 | |||
| 45 | ### Deactivate JGroups warnings | ||
| 46 | log4j.logger.org.jgroups=error | ||
| 47 | {code} | ||
| 48 | |||
| 49 | Refer to Log4J's documentation to understand the settings. As an example, to turn on Hibernate's calls, just set the following: | ||
| 50 | |||
| 51 | {code} | ||
| 52 | log4j.logger.org.hibernate.SQL=debug | ||
| 53 | {code} |
