JMX Management Beans Support
Overview
Bloomreach Content provides several JMX MBeans by default to support monitoring of the CMS and Site applications. By default, these MBeans are accessible only on localhost. This page lists the default MBeans and describes how to add custom MBeans to your site application.
You can register additional MBeans in your site application by using the HST Container's support for MBeans, which integrates with Spring Framework JMX Integration Support.
Default Exposed MBeans
Repository
The following MBean exposes statistics for the JackRabbit content repository:
org.hippoecm.repository:type=Repository,name=statistics
Site
The following MBeans monitor the HST session pools for the various site users:
org.onehippo.hst:type=SessionPool,name=defaultorg.onehippo.hst:type=SessionPoolCounter,name=defaultorg.onehippo.hst:type=SessionPool,name=previeworg.onehippo.hst:type=SessionPoolCounter,name=previeworg.onehippo.hst:type=SessionPool,name=binariesorg.onehippo.hst:type=SessionPoolCounter,name=binariesorg.onehippo.hst:type=SessionPool,name=writableorg.onehippo.hst:type=SessionPoolCounter,name=writableorg.onehippo.hst:type=SessionPool,name=hstconfigreaderorg.onehippo.hst:type=SessionPoolCounter,name=hstconfigreader
Each of these MBeans implements either org.hippoecm.hst.core.jcr.pool.PoolingRepositoryMBean (for pool configurations and current state) or org.hippoecm.hst.core.jcr.pool.PoolingCounterMBean (for monitoring counters).
Cache Monitoring
-
brXM 16:
The HST exposes MBeans for cache instances using the Caffeine library. MBeans are available for:- The runtime cache used by the binaries servlet (
BinariesCache) - The page cache (
PageCache) - The cache for static Webfiles (
WebFileSCache)
- The runtime cache used by the binaries servlet (
-
brXM 14 & 15:
The HST exposes MBeans for each Ehcache instance. MBeans provide runtime statistics and configuration for:- The cache used by the binaries servlet (
binariesCache) - The page cache (
hstPageBlockingCache) - The cache for static Webfiles (
hstWebFileCache)
For more information on monitoring Ehcache, refer to the Ehcache documentation.
- The cache used by the binaries servlet (
Targeting
If your project uses targeting, the following MBeans provide monitoring for the four relevance data stores:
com.onehippo.cms.targeting:type=Targeting,name=RequestLogStatcom.onehippo.cms.targeting:type=Targeting,name=StatisticsStatcom.onehippo.cms.targeting:type=Targeting,name=VisitStatcom.onehippo.cms.targeting:type=Targeting,name=VisitorStat
The following MBean exposes the current configuration of the Visitor Service:
com.onehippo.cms.targeting:type=Targeting,name=VisitorService
Remote Access
By default, Bloomreach Content restricts MBean access to localhost. To enable remote access, configure the appropriate system properties for your JVM or your application container (for example, see Tomcat JMX remote configuration). You can use tools such as JConsole to monitor MBeans remotely.