This documentation is for WSO2 Enterprise Service Bus version 5.0.0. View documentation for the latest ESB.
Skip to end of metadata
Go to start of metadata

Java Management Extensions (JMX) is a technology that lets you implement management interfaces for Java applications. JConsole is a JMX-compliant monitoring tool, which comes with the Java Development Kit (JDK) 1.5 or later versions.  WSO2 ESB is shipped with inbuilt support for JMX (Java Management Extension) monitoring.  

This section illustrates how you can use JMX monitoring to monitor statistics relating to artifacts that are deployed in your ESB server. This is done using the Mediation Flow Statistics View Mbean.

Follow the steps below to enable and view JMX based mediation flow 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 JConsole tool and connect to the ESB server. For instructions, see Monitoring a WSO2 Product with JConsole in the WSO2 Administration Guide. 
  4. Go to the MBeans tab in the JConsole and navigate to org.apache.synapse/Mediation Flow Statistic View/MediationFlowStatisticsView/Operations to view all available operations. In here, you can view JMX statistics relating to proxy services, REST APIs, inbound endpoints, endpoints and sequences. 

    For example, to view JMX statistics for a proxy service select getProxyServiceJMXStatistics from the list of operations. Provide the artifact name in p0 field under Composite Data and and click getProxyServiceJMXStatistics button to perform the relevant operation invocation. 

The MediationFlowStatisticsView MBean has the following operations:

Operation NameDescription
resetAPIStatisticsClear recorded API statistics and restart recording.
resetProxyStatisticsClear recorded proxy service statistics and restart recording.
resetSequenceStatisticsClear recorded sequence statistics and restart recording.
resetInboundEndpointStatisticsClear recorded inbound endpoint statistics and restart recording.
resetEndpointStatisticsClear recorded endpoint statistics and restart recording.
resetAllStatisticsClear recorded statistics for all ESB artifacts and restart recording.
getProxyServiceJMXStatisticsRetrieve JMX statistics for proxy service.
getSequenceJMXStatisticsRetrieve JMX statistics for sequence.
getAPiJMXStatisticsRetrieve JMX statistics for API.
getInboundEndpointJMXStatisticsRetrieve JMX statistics for inbound endpoint.
getEndpointJMXStatisticsRetrieve JMX statistics for endpoint.

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>

For details on using JMX monitoring to monitor your ESB server, see JMX Monitoring.

  • No labels