Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This site contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

JMX Monitoring

In this document

JMX Monitoring

Elastic Path Commerce exposes application metrics via JMX (Java Monitoring Extensions).

Application JMX Metrics

The following JMX metrics are available:

Metrics JMX Path(s)
Camel statistics for asynchronous messaging 
  1. org.apache.camel
Core caching configuration and statistics - for both application and OpenJPA data caches 
  1. net.sf.ehcache
  2.     CacheConfiguration
  3.        <context>-CacheManager    
  4.     CacheStatistics
  5.        <context>-CacheManager
Cortex combined transaction statistics - counts, response times, rates 
  1. EP-RelOS
  2.     EP-RelOS.<host>.COMBINED.ALL.<scope>
  3.     EP-RelOS.<host>.COMBINED.CREATE.<scope>
  4.     EP-RelOS.<host>.COMBINED.DELETE.<scope>
  5.     EP-RelOS.<host>.COMBINED.READ.<scope>
  6.     EP-RelOS.<host>.COMBINED.UPDATE.<scope>
Cortex per-resource transaction statistics - counts, response times, rates 
  1. EP-RelOS
  2.     EP-RelOS.<host>.resource.<resourceName>.ALL.<scope>
  3.     EP-RelOS.<host>.resource.<resourceName>.CREATE.<scope>
  4.     EP-RelOS.<host>.resource.<resourceName>.DELETE.<scope>
  5.     EP-RelOS.<host>.resource.<resourceName>.READ.<scope>
  6.     EP-RelOS.<host>.resource.<resourceName>.UPDATE.<scope>
Cortex request scope caching 
  1. EP-RelOS
  2.     EP-RelOS.<host>.RequestCache.*
Cortex executor statistics 
  1. EP-RelOS
  2.     EP-RelOS.<host>.executorService.*
Quartz jobs in Batch Server and Search Server 
  1. quartz
  2.     QuartzScheduler
  3.         BatchJMXScheduler
  4.         SearchServerJmxScheduler
Search Server indexing 
  1. com.elasticpath.search
Solr indexes 
  1. solr/<indexName>

Enabling JMX Remote Connections

To enable JMX remote connections to your production server:

  1. Open your server's startup script with a text editor.
  2. Modify JAVA_OPTS to include the following: 
    1. -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=6969 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false
    Copy
    This will allow a JMX client to connect to port 6969.
  3. Restart the server.