Hide last authors
Manuel Smeria 12.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Silvia Macovei 4.1 4
Vincent Massol 16.1 5 XWiki uses [[SLF4J>>http://www.slf4j.org/]] for logging. By default XWiki is configured so that SLF4J uses [[Logback>>http://logback.qos.ch/]]. XWiki's Logback configuration is located in the ##[[WEB-INF/classes/logback.xml>>https://raw.github.com/xwiki/xwiki-platform/master/xwiki-platform-core/xwiki-platform-web/src/main/resources/logback.xml]]## file.
Vincent Massol 1.1 6
Manuel Smeria 12.2 7 XWiki is also configured by default so that any logs generated by 3rd part JARs used by XWiki (i.e. in the XWiki classpath at runtime) will automatically find their ways to the output defined by the Logback configuration file. This is active for Apache Commons Logging (JCL) and Log4J. This is achieved by using [[a SLF4J Bridge>>http://www.slf4j.org/legacy.html]] for both logging frameworks (it's the ##log4j-over-slf4j-*.jar## and ##jcl-over-slf4j-*.jar## files that provide this feature).
Vincent Massol 11.1 8
Vincent Massol 21.1 9 = Log Location =
Vincent Massol 1.4 10
Vincent Massol 22.1 11 == Main Logs ==
12
Vincent Massol 21.1 13 By default XWiki is configured to log everything on the console only. Whether the console is captured by your Servlet Container or not depends on the container you use.
14
15 Here are some potential locations you can check, depending on the [[installation method>>xwiki:Documentation.AdminGuide.Installation.WebHome||anchor="HInstallationMethods"]] you've chosen::
16 * If you use the [[XWiki Debian packaging>>xwiki:Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]], and thus using Tomcat, it's in ##/var/log/tomcat*/catalina.out##.
17 * If you use the [[XWiki Docker packaging>>https://github.com/xwiki-contrib/docker-xwiki/blob/master/README.md]] it's in the console that started Tomcat, or if you started it in background, you can get them with ##docker logs <container id>##.
18 * If you use the [[XWiki Standalone packaging>>Documentation.AdminGuide.InstallationStandalone]], then it's in the console and also in ##data/logs/<date>.output.log##.
19 * If you use the [[Manual WAR packaging>>Documentation.AdminGuide.InstallationWAR]], then it depends on the Servlet engine you've used and how you've configured it. You could check in ##/var/log/tomcat*/catalina.out## on unix or ##<tomcat home>/logs/catalina.out## for Tomcat.
20
Vincent Massol 22.1 21 == Job Logs ==
22
23 XWiki has the concept of [[jobs>>extensions:Extension.Job Module.WebHome]] (e.g. when you install or upgrade an Extension or when you delete pages, they all execute in a job). Very often, jobs capture the logs and output them in job log files located in the [[permanent directory>>Documentation.AdminGuide.Configuration.WebHome#HPermanentDirectory]], under the ##jobs## subdirectories. Log files are named ##log.xml##.
24
25 Note that some features allow you to see view these logs in the UI. For exampe the Extension Manager has a UI so that you can [[review the logs when an extension was installed, or updated>>extensions:Extension.Extension Manager Application#HProgressLog]].
26
Vincent Massol 16.1 27 = Configuring Logging =
Vincent Massol 1.1 28
Vincent Massol 14.1 29 There are various ways in which you can configure what to log.
30
Vincent Massol 17.2 31 See also the [[Logging section of the Debugging page>>dev:Community.Debugging#HLogging]] for specific details on some loggers.
Vincent Massol 17.1 32
Anca Luca 20.1 33 {{info}}
34 Of the 3 methods proposed under, only the Manual method is persistent **after a server restart**. So if your server might restart/be restarted and you want the log configuration to be kept after this restart, the only method is adding them to logback.xml.
35 {{/info}}
Anca Luca 18.1 36
Vincent Massol 16.1 37 == Manually ==
Vincent Massol 13.1 38
Anca Luca 20.1 39 Simply edit the Logback configuration file (##logback.xml## in ##WEB-INF/classes## in your web application folder) and restart the Servlet container for it to take effect.
Vincent Massol 13.1 40
Vincent Massol 16.1 41 == Using the Log Application ==
Vincent Massol 13.1 42
43 Starting with XWiki 4.2 a new [[Logging Application>>extensions:Extension.Logging Application]] is available in your wiki's administration UI and you can use it to configure the log levels for all features.
44
Anca Luca 20.1 45 == Using JMX ==
Vincent Massol 13.1 46
Manuel Smeria 12.2 47 [[LogBack exposes its configuration with JMX>>http://logback.qos.ch/manual/jmxConfig.html]] making it possible to use a JMX console to modify the logging configuration at runtime, thus not needing to restart the Servlet container. This is very useful in production when needing to debug an issue.
Vincent Massol 8.1 48
Ecaterina Moraru (Valica) 20.4 49 See the [[Monitoring Guide>>Documentation.AdminGuide.Monitoring]] for more details on using JMX with XWiki.
Vincent Massol 8.1 50
Vincent Massol 16.1 51 = Analyzing logs with Lilith =
Vincent Massol 9.1 52
53 [[Lilith>>http://lilith.huxhorn.de/]] is a logging and access event viewer. It makes it easy to analyze large quantities of logs. To use it, configure XWiki's Logging to send events to the Socket appender. Add the following to the ##logback.xml## file:
54
55 {{code language="xml"}}
56 ...
57 <appender name="socket" class="ch.qos.logback.classic.net.SocketAppender">
58 <RemoteHost>localhost</RemoteHost>
59 <Port>4560</Port>
60 <ReconnectionDelay>170</ReconnectionDelay>
61 <IncludeCallerData>true</IncludeCallerData>
62 </appender>
63 ...
64 {{/code}}
65
66 And add the new appender to the list of appenders to use. For example:
67
68 {{code language="xml"}}
69 ...
70 <root level="warn">
71 <appender-ref ref="stdout"/>
72 <appender-ref ref="socket"/>
73 </root>
74 ...
75 {{/code}}
76
77 Open Lilith (it's a desktop application) and it'll automatically listen on port 4560 so when you start XE you'll see its logs show up in Lilith.
78
79 For example:
80
Silvia Macovei 10.2 81 [[image:lilith.png||style="width:950px"]]
Vincent Massol 9.1 82
Vincent Massol 11.1 83 == Using a different SLF4J implementation ==
84
Thomas Mortagne 15.1 85 If you wish, for example, to use Log4J to log all logs produced by XWiki you can do so by doing the following ([[described in the SLF4J manual>>http://www.slf4j.org/manual.html]]):
Anca Luca 20.1 86
Manuel Smeria 12.2 87 * Remove the Logback SLF4J implementation from the classpath by removing ##WEB-INF/lib/logback-classic-*.jar## and ##WEB-INF/lib/logback-core-*.jar##
88 * Remove the Log4J over SLF4J JAR from the classpath by removing ##WEB-INF/lib/log4j-over-slf4j-*.jar##
Vincent Massol 11.2 89 * Add the Log4J SLF4J implementation to the classpath: ##slf4j-log4j*-*.jar##
90 * Add Log4J itself to the classpath
Vincent Massol 11.1 91
Vincent Massol 16.1 92 = Older XWiki versions =
Vincent Massol 8.1 93
Vincent Massol 16.1 94 XWiki versions 3.0 and older use Commons Logging for logging. By default XWiki was configured so that Commons Logging was using log4J. XWiki's Log4J configuration was located inside XWiki's JAR (xwiki-core-x.y.jar), in a ##[[log4j.properties>>https://raw.github.com/xwiki/xwiki-platform/13e01088e74c170452088a56fe54fb76a7ecb041/xwiki-platform-core/xwiki-platform-oldcore/src/main/resources/log4j.properties]]## file. XWiki' JAR is itself located in your ##WEB-INF/lib/## directory.
Vincent Massol 8.1 95
96 {{info}}
Vincent Massol 16.1 97 By default XWiki was configured to log everything on the console only.
Vincent Massol 8.1 98 {{/info}}
99
100 == Using a custom Log4J configuration ==
101
Vincent Massol 16.1 102 The best solution was 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:
Vincent Massol 1.1 103
Silvia Macovei 4.1 104 {{code language="none"}}
Vincent Massol 1.6 105 ### Direct log messages to stdout
Vincent Massol 1.1 106 log4j.appender.stdout=org.apache.log4j.ConsoleAppender
107 log4j.appender.stdout.Target=System.out
108 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
Vincent Massol 3.3 109 log4j.appender.stdout.layout.ConversionPattern=%d [%X{url}] [%t] %-5p %-30.30c{2} %x - %m %n
Vincent Massol 1.1 110
Vincent Massol 1.6 111 ### By default everything that is of warning or severity WARN, ERROR or FATAL is logged both to
112 ### the console and to the xwiki.log file.
Jerome 6.1 113 log4j.rootLogger=warn, stdout
Vincent Massol 1.1 114
Vincent Massol 1.6 115 ### Hibernate logging options
Vincent Massol 1.1 116 log4j.logger.org.hibernate=warn
117 log4j.logger.org.hibernate.SQL=warn
118 log4j.logger.org.hibernate.type=warn
119 log4j.logger.org.hibernate.ps.PreparedStatementCache=warn
120
Vincent Massol 1.6 121 ### XWiki logging configuration
Vincent Massol 3.3 122 log4j.logger.org.xwiki=info
Vincent Massol 1.1 123 log4j.logger.com.xpn.xwiki=warn
124 log4j.logger.com.xpn.xwiki.render.XWikiRadeoxRenderEngine=warn
Vincent Massol 2.1 125 log4j.logger.com.xpn.xwiki.store.migration=info
Vincent Massol 1.1 126
Vincent Massol 2.1 127 ### Deactive Struts warnings
Vincent Massol 1.1 128 log4j.logger.org.apache.struts.util.RequestUtils=error
129
Vincent Massol 1.6 130 ### Deactivate JGroups warnings
Vincent Massol 1.1 131 log4j.logger.org.jgroups=error
Vincent Massol 2.1 132
133 ## Deactive PDF Export CSS Applier warnings
134 log4j.logger.info.informatica.doc.style.css.dom=error
135 log4j.logger.org.apache.fop.layoutmgr.inline.ContentLayoutManager=error
Silvia Macovei 4.1 136 {{/code}}
Vincent Massol 1.1 137
138 Refer to Log4J's documentation to understand the settings. As an example, to turn on Hibernate's calls, just set the following:
139
Silvia Macovei 4.1 140 {{code}}
Vincent Massol 1.1 141 log4j.logger.org.hibernate.SQL=debug
Silvia Macovei 4.1 142 {{/code}}
Vincent Massol 3.1 143
Vincent Massol 8.1 144 = Activating the XWiki Monitoring feature =
Vincent Massol 3.1 145
Silvia Macovei 4.1 146 {{info}}
147 The monitoring feature is already active in the default configuration.
148 {{/info}}
Vincent Massol 3.1 149
150 XWiki has a feature to monitor times spent in its major components. To activate it, you need to:
151
Anca Luca 20.1 152 * Enable the Monitor plugin by adding/modifying the following plugin definition in the ##xwiki.cfg## configuration file:(((
Silvia Macovei 4.1 153 {{code language="none"}}
Vincent Massol 3.1 154 xwiki.plugins=\
155 [...]
156 com.xpn.xwiki.monitor.api.MonitorPlugin
Silvia Macovei 4.1 157 {{/code}}
Manuel Smeria 12.2 158 )))
Anca Luca 20.1 159 * Enable it by adding/modifying the following in the ##xwiki.cfg## configuration file:(((
Silvia Macovei 4.1 160 {{code language="none"}}
Vincent Massol 3.1 161 xwiki.monitor=1
Silvia Macovei 4.1 162 {{/code}}
Manuel Smeria 12.2 163 )))
Anca Luca 20.1 164 * Since the plugin logs everything under the ##DEBUG## severity you also need to configure the XWiki Logging (as described above) by setting the ##com.xpn.xwiki.monitor## category to the ##DEBUG## level.(((
Vincent Massol 8.1 165 For example for Logback it means adding the following in ##logback.xml##:
166
Silvia Macovei 4.1 167 {{code language="none"}}
Guillaume Fenollar 12.1 168 <logger name="com.xpn.xwiki.monitor" level="debug"/>
Vincent Massol 8.1 169 {{/code}}
170
171 And for older XWiki versions using Log4J it means adding the following in ##log4j.properties##:
172
173 {{code language="none"}}
Vincent Massol 3.1 174 log4j.logger.com.xpn.xwiki.monitor=debug
Silvia Macovei 4.1 175 {{/code}}
Vincent Massol 8.1 176 )))

Get Connected