Wiki source code of Logging
Version 5.1 by Vincent Massol on 2010/06/02
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}} | ||
| 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 ##[[log4j.properties>>http://fisheye2.cenqua.com/browse/raw,r=trunk/xwiki/xwiki-platform/core/trunk/src/main/resources/log4j.properties]]## file. XWiki' JAR is itself located in your ##WEB-INF/lib/## directory. | ||
| 4 | |||
| 5 | {{info}} | ||
| 6 | By default XWiki is configured to log everything both on the console and in a xwiki.log file located in the directory from where you have started the JVM. 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. | ||
| 7 | {{/info}} | ||
| 8 | |||
| 9 | = Using a custom Log4J configuration = | ||
| 10 | |||
| 11 | The best solution is to create a new ##log4j.properties## file in your ##WEB-INF/classes## directory. It'll thus override the one from the XWiki JAR. As an example, here's a sample configuration: | ||
| 12 | |||
| 13 | {{code language="none"}} | ||
| 14 | ### Direct log messages to stdout | ||
| 15 | log4j.appender.stdout=org.apache.log4j.ConsoleAppender | ||
| 16 | log4j.appender.stdout.Target=System.out | ||
| 17 | log4j.appender.stdout.layout=org.apache.log4j.PatternLayout | ||
| 18 | log4j.appender.stdout.layout.ConversionPattern=%d [%X{url}] [%t] %-5p %-30.30c{2} %x - %m %n | ||
| 19 | |||
| 20 | log4j.appender.file=org.apache.log4j.RollingFileAppender | ||
| 21 | ### This is the path to the XWiki log file. If you don't specify any directory it'll be in the current directory | ||
| 22 | ### Example: /path/to/my/xwiki.log | ||
| 23 | log4j.appender.file.File=xwiki.log | ||
| 24 | log4j.appender.file.MaxFileSize=10MB | ||
| 25 | log4j.appender.file.MaxBackupIndex=50 | ||
| 26 | log4j.appender.file.layout=org.apache.log4j.PatternLayout | ||
| 27 | log4j.appender.file.layout.ConversionPattern=%d [%X{url}] [%t] %-5p %-30.30c{2} %x - %m %n | ||
| 28 | |||
| 29 | ### By default everything that is of warning or severity WARN, ERROR or FATAL is logged both to | ||
| 30 | ### the console and to the xwiki.log file. | ||
| 31 | log4j.rootLogger=warn, stdout, file | ||
| 32 | |||
| 33 | ### Hibernate logging options | ||
| 34 | log4j.logger.org.hibernate=warn | ||
| 35 | log4j.logger.org.hibernate.SQL=warn | ||
| 36 | log4j.logger.org.hibernate.type=warn | ||
| 37 | log4j.logger.org.hibernate.ps.PreparedStatementCache=warn | ||
| 38 | |||
| 39 | ### XWiki logging configuration | ||
| 40 | log4j.logger.org.xwiki=info | ||
| 41 | log4j.logger.com.xpn.xwiki=warn | ||
| 42 | log4j.logger.com.xpn.xwiki.render.XWikiRadeoxRenderEngine=warn | ||
| 43 | log4j.logger.com.xpn.xwiki.store.migration=info | ||
| 44 | |||
| 45 | ### Deactive Struts warnings | ||
| 46 | log4j.logger.org.apache.struts.util.RequestUtils=error | ||
| 47 | |||
| 48 | ### Deactivate JGroups warnings | ||
| 49 | log4j.logger.org.jgroups=error | ||
| 50 | |||
| 51 | ## Deactive PDF Export CSS Applier warnings | ||
| 52 | log4j.logger.info.informatica.doc.style.css.dom=error | ||
| 53 | log4j.logger.org.apache.fop.layoutmgr.inline.ContentLayoutManager=error | ||
| 54 | {{/code}} | ||
| 55 | |||
| 56 | Refer to Log4J's documentation to understand the settings. As an example, to turn on Hibernate's calls, just set the following: | ||
| 57 | |||
| 58 | {{code}} | ||
| 59 | log4j.logger.org.hibernate.SQL=debug | ||
| 60 | {{/code}} | ||
| 61 | |||
| 62 | = Activating the XWiki monitoring feature = | ||
| 63 | |||
| 64 | {{info}} | ||
| 65 | The monitoring feature is already active in the default configuration. | ||
| 66 | {{/info}} | ||
| 67 | |||
| 68 | XWiki has a feature to monitor times spent in its major components. To activate it, you need to: | ||
| 69 | |||
| 70 | * Enable the Monitor plugin by adding/modifying the following plugin definition in the ##xwiki.cfg## configuration file: | ||
| 71 | |||
| 72 | {{code language="none"}} | ||
| 73 | xwiki.plugins=\ | ||
| 74 | [...] | ||
| 75 | com.xpn.xwiki.monitor.api.MonitorPlugin | ||
| 76 | {{/code}} | ||
| 77 | |||
| 78 | * Enable it by adding/modifying the following in the ##xwiki.cfg## configuration file: | ||
| 79 | |||
| 80 | {{code language="none"}} | ||
| 81 | xwiki.monitor=1 | ||
| 82 | {{/code}} | ||
| 83 | |||
| 84 | * Since the plugin logs everything under the ##DEBUG## severity you also need to configure Log4J (as described above) by adding the following in ##log4j.properties##: | ||
| 85 | |||
| 86 | {{code language="none"}} | ||
| 87 | log4j.logger.com.xpn.xwiki.monitor=debug | ||
| 88 | {{/code}} |
