Monitoring JMX Based Statistics

WSO2 ESB is shipped with inbuilt support for JMX (Java Management Extension) monitoring. JMX is a common method to manage and monitor the runtime parameters of a remote server. Follow the steps below to view JMX based statistics for WSO2 ESB.

1. Enable mediation flow statistics in the <ESB_HOME>/repository/conf/synapse.properties file as shown below.

   mediation.flow.statistics.enable=true
   mediation.flow.statistics.tracer.collect.payloads=true
   mediation.flow.statistics.tracer.collect.properties=true

2. Start the WSO2 ESB server. For more information, see Running the Product.
3. Open the J Console in your computer and connect to the ESB server.
4. Navigate to org.apache.synapse => Mediation Flow Statistics View => Operation. Click on the required ESB artifact and do the relevant operation invocation. JMX statistics relating to proxy services, REST APIs, inbound endpoints, endpoints and sequences can be viewed as shown in the examples below.
   • JMX statistics for a proxy service
      
   • JMX statistics for a REST API
      

Disabling the JMX observer

The JMX observer can be disabled by adding the following property to the  <ESB_HOME>/repository/conf/carbon.xml file.

<MediationFlowStatisticConfig> 
	<JmxPublishingDisable>true</JmxPublishingDisable>
</MediationFlowStatisticConfig>