Skip to Content

Wiki source code of Monitoring

Version 28.2 by Vincent Massol on 2018/03/06
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 There are various solutions you can use to monitor a running XWiki instance:
6
7 * Install and configure [[JavaMelody>>https://github.com/javamelody/javamelody/wiki]]
8 * [[Use a Profiler>>dev:Community.Profiling]]. This has the advantage of providing advanced information, but has the drawback of being resource intensive and thus slowing the XWiki instance. It also requires a special startup script.
9 * Starting with XWiki 2.4M2 we're now using the [[JMX Technology>>http://en.wikipedia.org/wiki/Java_Management_Extensions]] to provide runtime monitoring of XWiki instances. The following features are currently available:
10 ** Monitor the Velocity macro caches
11 ** Monitor the JBossCache caches XWiki is using to cache Document data, Users & Groups data and more
12 ** (starting with XE 3.1) Monitor the JGroups channel and protocols (when the XWiki Cluster feature is turned on)
13 ** (starting with XE 3.1) Monitor the Logback Logging configuration and change it
14
15 {{info}}
16 XWiki also has a [[Monitor Plugin>>Documentation.AdminGuide.Logging||anchor="HActivatingtheXWikiMonitoringfeature"]] that you can use to monitor execution times. However this plugin is going to be deprecated in the future and replaced by the JMX technology.
17 {{/info}}
18
19 = JavaMelody =
20
21 [[[[image:https://raw.githubusercontent.com/wiki/javamelody/javamelody/resources/screenshots/graphs.png||width="50%"]]>>https://github.com/javamelody/javamelody/wiki/Screenshots#charts||style="width:50%"]]
22
23 To install JavaMelody for XWiki follow these steps (see the [[JavaMelody user guide>>https://github.com/javamelody/javamelody/wiki/UserGuide]] for more details):
24
25 * Download the latest [[javamelody.jar>>https://github.com/javamelody/javamelody/releases]] and [[jrobin-x.jar>>https://github.com/javamelody/javamelody/releases/download/javamelody-core-1.49.0/jrobin-1.5.9.jar]] and put them in the ##WEB-INF/lib## folder
26 * Edit ##web.xml## and add the following information:(((
27 {{code}}
28 ...
29 <filter>
30 <filter-name>monitoring</filter-name>
31 <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
32 </filter>
33 <!-- to enable BASIC authentication with username and password, but do no want to use a realm and "security-constraint"
34 The storage files of statistics and of graphs are stored in the temporary directory of the server, unless if you have defined the "storage-directory" path
35 <filter>
36 <filter-name>javamelody</filter-name>
37 <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
38 <init-param>
39 <param-name>authorized-users</param-name>
40 <param-value>user1:pwd1, user2:pwd2</param-value>
41 </init-param>
42 <init-param>
43 <param-name>storage-directory</param-name>
44 <param-value>/path/of/javamelody/stats</param-value>
45 </init-param>
46 </filter> -->
47 ... other <filter>s from the default web.xml here ...
48
49 <filter-mapping>
50 <filter-name>monitoring</filter-name>
51 <url-pattern>/*</url-pattern>
52 </filter-mapping>
53 ... other <filter-mapping>s from the default web.xml here ...
54
55 <listener>
56 <listener-class>net.bull.javamelody.SessionListener</listener-class>
57 </listener>
58 ... other <listener>s from the default web.xml here ...
59 ...
60 {{/code}}
61 )))
62 * Edit ##hibernate.cfg.xml## and add:(((
63 {{code}}
64 <property name="jdbc.factory_class">net.bull.javamelody.HibernateBatcherFactory</property>
65 {{/code}}
66 )))
67
68 Then restart XWiki and access JavaMelody at ##http:~/~/localhost:8080/xwiki/monitoring##.
69
70 {{warning}}
71 Recent versions of JavaMelody (at least 1.70+ ?) require the configuration in this guide to be adapted like this:
72
73 {{code}}
74 in web.xml:
75 -----------
76
77 <filter>
78 <filter-name>javamelody</filter-name>
79 <filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
80 <async-supported>true</async-supported>
81 </filter>
82 <filter-mapping>
83 <filter-name>javamelody</filter-name>
84 <url-pattern>/*</url-pattern>
85 <dispatcher>REQUEST</dispatcher>
86 <dispatcher>ASYNC</dispatcher>
87 </filter-mapping>
88 <listener>
89 <listener-class>net.bull.javamelody.SessionListener</listener-class>
90 </listener>
91
92
93
94 in hibernate.cfg.xml:
95 ---------------------
96
97 <property name="connection.driver_class">net.bull.javamelody.JdbcDriver</property>
98 <property name="connection.driver">com.mysql.jdbc.Driver</property>
99 {{/code}}
100 {{/warning}}
101
102 = JMX Console =
103
104 Since JMX is a standard you can use [[any JMX-compatible monitoring console>>http://stackoverflow.com/questions/1744900/what-is-the-best-or-most-commonly-used-jmx-console-client]] (most application servers provide a web-based JMX console). There's also a console called [[JConsole>>http://docs.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html]] which is bundled by default in the Java Runtime you're using. To start it, simply execute the ##jconsole## executable.
105
106 {{info}}
107 Note that starting with XWiki 6.3, if you're using the Standalone Distribution (which bundles Jetty) you can now use ##start_xwiki.sh -j## (or ##start_xwiki.sh ~-~-jmx##) to monitor/manage the Jetty instance itself (it adds Jetty-specific MBeans):
108
109 {{image reference="jettymbeans.png"/}}
110 {{/info}}
111
112 == XWiki Caches Monitoring ==
113
114 XWiki can use different cache implementations. The JBoss Cache and JBoss Infinispan implementations have nice JMX features available as shown below.
115
116 Starting with XWiki 3.3 the default implementation is JBoss Infinispan.
117
118 === With JBoss Infinispan ===
119
120 Since JBoss Infinispan natively supports JMX we benefit from this feature directly (JBoss documentation available [[here>>https://docs.jboss.org/author/display/ISPN/Management+Tooling]]).
121
122 {{info}}
123 Prior to XWiki 3.5 the JMX support was not enabled by default. To enable it, edit ##WEB-INF/cache/infinispan/config.xml## and uncomment the two places where the "jmx" string is mentioned
124 {{/info}}
125
126 Example showing the cache list and some statistic for a given cache:
127
128 {{image reference="infinispancache.png"/}}
129
130 Example showing how to clear a given cache from all its entries:
131
132 {{image reference="infinispancacheclearing.png"/}}
133
134 === With JBoss Cache ===
135
136 Since JBoss Cache natively supports JMX we benefit from this feature directly (JBoss documentation available [[here>>https://access.redhat.com/knowledge/docs/en-US/JBoss_Enterprise_Web_Platform/5/html/JBoss_Cache_User_Guide/jmx_reference.html]]).
137
138 Example showing all JBoss Caches in memory in a running instance, showing all the elements in the cache (example on the document cache):
139
140 {{image reference="jbosscache.png"/}}
141
142 Example showing Cache stats (for the document cache):
143
144 {{image reference="jbosscache-stats.png"/}}
145
146 == Velocity Cache Monitoring ==
147
148 Velocity caches Velocity macros. XWiki offers a JMX view of the content of the Velocity caches.
149
150 JConsole examples showing the Velocity Cache monitoring:
151
152 {{image reference="jconsole1.png"/}}
153
154 {{image reference="jconsole2.png"/}}
155
156 == JGroups Monitoring ==
157
158 JConsole example showing the JGroups monitoring:
159
160 {{image reference="jgroups.png"/}}
161
162 Interesting things to do on JGroups in the JMX console:
163
164 * Change the log level on the protocols to enable logging
165 * Disconnect a node from the cluster and reconnect it
166
167 == Logback Monitoring ==
168
169 JConsole example showing how to modify the logging level for a category:
170
171 {{image reference="jmx-logging.png"/}}
172
173 = Tomcat JMX Proxy Servlet =
174
175 Tomcat has a JMX Proxy Servlet bundled in their ##manager## webapp (see [[here>>http://tomcat.apache.org/tomcat-6.0-doc/manager-howto.html]] and [[here>>http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html]] for more details on Tomcat and JMX]].
176
177 Here's some useful URLs to use the JMX Servlet Proxy to list and set JGroups Protocol Levels:
178
179 * To display the current log level for the TCPPING protocol: {{{http://localhost:8080/manager/jmxproxy?qry=jgroups:type=protocol,cluster=event,protocol=TCPPING}}}
180 * To set the log level to ##info## for the TCPPING protocol: {{{http://localhost:8080/manager/jmxproxy?set=jgroups:type=protocol,cluster=event,protocol=TCPPING&att=Level&val=info}}}
181
182 = Others =
183
184 * It's possible to [[write a Groovy script in a wiki page to access the JMX MBeans>>snippets:Extension.JMX Access]].
185 * [[JMX Monitoring Application>>extensions:Extension.JMX Monitoring Application]]
186 * [[XInit>>extensions:Extension.Xinit]]

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected