Monitoring (XWiki.org)

There are 2 solutions you can use to monitor a running XWiki instance:

* [[Use a Profiler>>http://dev.xwiki.org/xwiki/bin/view/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 startupscript.

3

* Starting with XWiki Enterprise 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:

4

** Monitor the Velocity macro caches

5

** Monitor the JBossCache caches XWiki is using to cache Document data, Users & Groups data and more

6

** Monitor the JGroups channel and protocols (when the XWiki Cluster feature is turned on)

7

8

9

XWiki also has a [[Monitor Plugin>>platform:AdminGuide.Logging#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.

= JMX Console =

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 such a console called [[JConsole>>http://java.sun.com/developer/technicalArticles/J2SE/jconsole.html]] and which is bundled by default in the Java Runtime you're using. To start it, simply execute the ##jconsole## executable.

15

16

== Velocity Cache Monitoring ==

17

18

JConsole examples showing the Velocity Cache monitoring:

image:jconsole1.png

image:jconsole2.png