Wiki source code of Monitoring

Version 35.1 by Thomas Mortagne on 2024/04/10

version	line-number	content
6.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
13.2	5	There are various solutions you can use to monitor a running XWiki instance:
26.1	6
29.1	7	* Install and configure [[Glowroot>>https://glowroot.org]]
24.2	8	* Install and configure [[JavaMelody>>https://github.com/javamelody/javamelody/wiki]]
26.1	9	* [[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.
32.1	10	* XWiki is using the [[JMX Technology>>http://en.wikipedia.org/wiki/Java_Management_Extensions]] to provide runtime monitoring of XWiki instances. The following features are available:
31.2	11	** Monitor the InfiniSpan caches XWiki is using to cache Document data, Users & Groups data and more
	12	** Monitor the JGroups channel and protocols (when the XWiki Cluster feature is turned on)
	13	** Monitor the Logback Logging configuration and change it
35.1	14	** Monitor Solr
32.1	15	** Monitor Apache DBCP connection pool
	16	** Monitor Hibernate
1.1	17
2.3	18	{{info}}
26.4	19	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.
2.3	20	{{/info}}
	21
29.1	22	= Glowroot =
	23
30.2	24	{{image reference="glowroot.png" width="650px"/}}
29.1	25
	26	There is nothing specific about XWiki when you install Glowroot, just follow [[the standard documentation>>https://github.com/glowroot/glowroot/wiki/Agent-Installation-%28with-Embedded-Collector%29]].
	27
13.2	28	= JavaMelody =
	29
33.1	30	[[~[~[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%"]]
13.2	31
24.2	32	To install JavaMelody for XWiki follow these steps (see the [[JavaMelody user guide>>https://github.com/javamelody/javamelody/wiki/UserGuide]] for more details):
26.1	33
34.1	34	* Download the latest 1.x version of [[javamelody.jar>>https://github.com/javamelody/javamelody/releases]] and [[jrobin-x.jar>>https://repo1.maven.org/maven2/org/jrobin/jrobin/1.5.9/jrobin-1.5.9.jar]] and put them in the ##WEB-INF/lib## folder
34.2	35	** {{warning}}JavaMelody v2.x moved to Jakarta EE and is not compatible with XWiki{{/warning}}
13.2	36	* Edit ##web.xml## and add the following information:(((
	37	{{code}}
	38	...
	39	<filter>
	40	<filter-name>monitoring</filter-name>
	41	<filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
	42	</filter>
25.1	43	<!-- to enable BASIC authentication with username and password, but do no want to use a realm and "security-constraint"
28.1	44	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
25.1	45	<filter>
	46	<filter-name>javamelody</filter-name>
	47	<filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
	48	<init-param>
	49	<param-name>authorized-users</param-name>
	50	<param-value>user1:pwd1, user2:pwd2</param-value>
	51	</init-param>
28.1	52	<init-param>
	53	<param-name>storage-directory</param-name>
	54	<param-value>/path/of/javamelody/stats</param-value>
	55	</init-param>
25.1	56	</filter> -->
13.2	57	... other <filter>s from the default web.xml here ...
	58
	59	<filter-mapping>
	60	<filter-name>monitoring</filter-name>
	61	<url-pattern>/*</url-pattern>
	62	</filter-mapping>
	63	... other <filter-mapping>s from the default web.xml here ...
	64
	65	<listener>
	66	<listener-class>net.bull.javamelody.SessionListener</listener-class>
	67	</listener>
	68	... other <listener>s from the default web.xml here ...
	69	...
	70	{{/code}}
	71	)))
	72	* Edit ##hibernate.cfg.xml## and add:(((
	73	{{code}}
	74	<property name="jdbc.factory_class">net.bull.javamelody.HibernateBatcherFactory</property>
	75	{{/code}}
	76	)))
	77
26.1	78	Then restart XWiki and access JavaMelody at ##http:~/~/localhost:8080/xwiki/monitoring##.
13.2	79
27.1	80	{{warning}}
	81	Recent versions of JavaMelody (at least 1.70+ ?) require the configuration in this guide to be adapted like this:
	82
	83	{{code}}
	84	in web.xml:
	85	-----------
	86
	87	<filter>
	88	<filter-name>javamelody</filter-name>
	89	<filter-class>net.bull.javamelody.MonitoringFilter</filter-class>
	90	<async-supported>true</async-supported>
	91	</filter>
	92	<filter-mapping>
	93	<filter-name>javamelody</filter-name>
	94	<url-pattern>/*</url-pattern>
	95	<dispatcher>REQUEST</dispatcher>
	96	<dispatcher>ASYNC</dispatcher>
	97	</filter-mapping>
	98	<listener>
	99	<listener-class>net.bull.javamelody.SessionListener</listener-class>
	100	</listener>
	101
	102
	103
	104	in hibernate.cfg.xml:
	105	---------------------
	106
	107	<property name="connection.driver_class">net.bull.javamelody.JdbcDriver</property>
	108	<property name="connection.driver">com.mysql.jdbc.Driver</property>
	109	{{/code}}
	110	{{/warning}}
	111
1.1	112	= JMX Console =
	113
17.3	114	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.
1.1	115
24.1	116	{{info}}
	117	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):
22.1	118
24.1	119	{{image reference="jettymbeans.png"/}}
	120	{{/info}}
	121
11.1	122	== XWiki Caches Monitoring ==
	123
14.1	124	XWiki can use different cache implementations. The JBoss Cache and JBoss Infinispan implementations have nice JMX features available as shown below.
11.1	125
17.3	126	Starting with XWiki 3.3 the default implementation is JBoss Infinispan.
14.1	127
	128	=== With JBoss Infinispan ===
	129
	130	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]]).
	131
17.3	132	{{info}}
26.1	133	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
17.3	134	{{/info}}
14.1	135
	136	Example showing the cache list and some statistic for a given cache:
	137
17.3	138	{{image reference="infinispancache.png"/}}
14.1	139
20.1	140	Example showing how to clear a given cache from all its entries:
	141
	142	{{image reference="infinispancacheclearing.png"/}}
	143
14.1	144	=== With JBoss Cache ===
	145
17.3	146	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]]).
14.1	147
11.1	148	Example showing all JBoss Caches in memory in a running instance, showing all the elements in the cache (example on the document cache):
	149
17.2	150	{{image reference="jbosscache.png"/}}
11.1	151
	152	Example showing Cache stats (for the document cache):
	153
17.2	154	{{image reference="jbosscache-stats.png"/}}
11.1	155
4.1	156	== Velocity Cache Monitoring ==
1.1	157
12.2	158	Velocity caches Velocity macros. XWiki offers a JMX view of the content of the Velocity caches.
	159
4.1	160	JConsole examples showing the Velocity Cache monitoring:
	161
17.2	162	{{image reference="jconsole1.png"/}}
1.1	163
17.2	164	{{image reference="jconsole2.png"/}}
1.1	165
4.1	166	== JGroups Monitoring ==
	167
	168	JConsole example showing the JGroups monitoring:
	169
17.2	170	{{image reference="jgroups.png"/}}
4.1	171
	172	Interesting things to do on JGroups in the JMX console:
26.1	173
4.1	174	* Change the log level on the protocols to enable logging
	175	* Disconnect a node from the cluster and reconnect it
	176
10.1	177	== Logback Monitoring ==
	178
33.1	179	Since XWiki 14.8 Logback no longer support JMX so you won't be able to use JMX to update your logging configuration.
	180
10.1	181	JConsole example showing how to modify the logging level for a category:
	182
17.2	183	{{image reference="jmx-logging.png"/}}
10.1	184
7.1	185	= Tomcat JMX Proxy Servlet =
	186
	187	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]].
	188
	189	Here's some useful URLs to use the JMX Servlet Proxy to list and set JGroups Protocol Levels:
26.1	190
7.1	191	* To display the current log level for the TCPPING protocol: {{{http://localhost:8080/manager/jmxproxy?qry=jgroups:type=protocol,cluster=event,protocol=TCPPING}}}
	192	* 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}}}
	193
18.1	194	= Others =
7.1	195
28.2	196	* It's possible to [[write a Groovy script in a wiki page to access the JMX MBeans>>snippets:Extension.JMX Access]].
18.1	197	* [[JMX Monitoring Application>>extensions:Extension.JMX Monitoring Application]]
31.1	198	* [[Clearing Document Caches with JMX>>snippets:Extension.Clear Document Caches.WebHome]]
19.1	199	* [[XInit>>extensions:Extension.Xinit]]

Wiki source code of Monitoring

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected