Monitor HST Enterprise Caching

Info: This feature in Bloomreach Content requires a standard or premium license. Contact Bloomreach for details.

The Second Level Page Cache and Cluster-Wide Caching features (both using Redis) were deprecated in version 14 and removed in version 15.0. The Stale Page Caching feature was also removed but reintroduced in versions 15.7 and 16.1.

Overview

This page describes how to monitor HST Enterprise Caching using logging and JMX.

For an overview of Enterprise Caching, see Understand HST Enterprise Caching.
For configuration instructions, see Enable and Configure HST Enterprise Caching.

When to Monitor Enterprise Caching

Monitor Enterprise Caching to:

Track cache performance and statistics
Diagnose caching behavior in development and production environments
Validate cache configuration and effectiveness

Logging

You can monitor enterprise cache activity by configuring loggers in your Log4j2 configuration files.

Development Environment

Add the following <Logger/> elements to your log4j2-dev.xml file to enable debug-level logging for enterprise caching:

<Logger additivity="false" name="org.hippoecm.hst.cache" level="debug">
  <AppenderRef ref="messages"/>
</Logger>
<Logger additivity="false" name="com.onehippo.cms.spring.cache" level="debug">
  <AppenderRef ref="messages"/>
</Logger>

Production Environment

To monitor cache logging in production, add these <Logger/> elements to your log4j2-dist.xml file:

<Logger additivity="false" name="org.hippoecm.hst.cache" level="debug"/>
<Logger additivity="false" name="com.onehippo.cms.spring.cache" level="debug"/>

Important:
Setting the log level to debug in production can generate a large volume of log data. Use debug level only for temporary validation. After confirming correct operation, reduce the log level to avoid excessive logging.

JMX Monitoring

Enterprise Caching exposes cache statistics and performance metrics via JMX MBeans. The MBean names depend on the web application context. For example, if the webapp is deployed as site, the MBeans use site in their names. If deployed as intranet, the names use intranet instead.

The following MBeans are available for community and enterprise caching:

org.onehippo.hst:type=Caching,name=#/site_PageCache
org.onehippo.hst:type=Caching,name=#/site_BinariesCache
org.onehippo.hst:type=Caching,name=#/site_WebFilesCache
com.onehippo.cms.spring.cache:type=CacheStats,name=/site_stalePageCache

# With Redis, brXM 14.x only
com.onehippo.cms.spring.cache:type=CacheProfile,name=/site_clusterCache
com.onehippo.cms.spring.cache:type=CacheProfile,name=/site_secondLevelCache
com.onehippo.cms.spring.cache:type=CacheStats,name=/site_clusterCache
com.onehippo.cms.spring.cache:type=CacheStats,name=/site_secondLevelCache

MBean Details

The org.onehippo.hst beans provide general cache statistics for:
- PageCache
- BinariesCache
- WebFilesCache
If Stale Page Cache is enabled, org.onehippo.hst:type=Caching,name=#/site_PageCache includes statistics for both the Stale Page Cache and the community First Level Page Cache.
brXM 14 only: If Second Level Page Cache is enabled, org.onehippo.hst:type=Caching,name=#/site_PageCache also includes Second Level Page Cache statistics.
The com.onehippo.cms.spring.cache beans with type CacheProfile report timing information for get and put operations in the cluster-wide Redis cache.
The com.onehippo.cms.spring.cache beans with type CacheStats provide statistics for the enterprise caches.