This documentation is for WSO2 Enterprise Service Bus version 5.0.0. For the latest ESB, view the latest WSO2 Enterprise Integrator documentation.

All docs This doc
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. Therefore, when you use a WSO2 product, JMX is enabled by default, which allows you to monitor the product using JConsole. 

Go to the WSO2 Administration Guide for detailed instructions on how to configure JMX for a WSO2 product and how to use JConsole for monitoring a product.

MBeans for WSO2 ESB

When JMX is enabled, WSO2 ESB exposes a number of management resources as JMX MBeans that can be used for managing and monitoring the running server. When you start JConsole, you can monitor these MBeans from the MBeans tab. While some of these MBeans (ServerAdmin and DataSource) are common to all WSO2 products, some MBeans are specific to WSO2 ESB. 

The common MBeans are explained in detail in the WSO2 Administration Guide. Listed below are the MBeans that are specific to WSO2 ESB.

For details on using JMX based mediation flow statistics in your ESB server and detailed explanation of the relevant MBeans, see Monitoring JMX Based Statistics

This section summarizes the attributes and operations available for the following ESB specific MBeans:

Connection MBeans

These MBeans provide connection statistics for the HTTP and HTTPS transports. 

You can view the following Connection MBeans:

  • org.apache.synapse/PassThroughConnections/http-listener
  • org.apache.synapse/PassThroughConnections/http-sender
  • org.apache.synapse/PassThroughConnections/https-listener
  • org.apache.synapse/PassThroughConnections/https-sender


Attribute NameDescription
ActiveConnectionsNumber of currently active connections.
ActiveConnectionsPerHostsA map of number of connections against hosts.
LastXxxConnectionsNumber of connections created during last Xxx time period.
RequestSizesMapA map of number of requests against their sizes.
ResponseSizesMapA map of number of responses against their sizes.
LastResetTimeLast time connection statistic recordings was reset.


Operation NameDescription
reset()Clear recorded connection statistics and restart recording.

Latency MBeans

This view provides statistics of the latencies from all backend services connected through the HTTP  and HTTPS transports. These statistics are provided as an aggregate value.

Tip: You need to enable advanced mediation statistics like mediation level latencies. In order to enable them, add following two entries in the file. 


Then you can view the time taken in the mediation layer (request and response) separately from the total latencies.

You can view the following Latency MBeans:

  • org.apache.synapse/PassthroughLatencyView/nio-http-http
  • org.apache.synapse/PassthroughLatencyView/nio-https-https


Attribute NameDescription
AllTimeAvgLatencyAverage latency since latency recording was last reset.
LastxxxAvgLatencyAverage latency for last xxx time period. For example, LastHourAvgLatency returns the average latency for the last hour.
LastResetTimeLast time latency statistic recording was reset.


Operation NameDescription
reset()Clear recorded latency statistics and restart recording.

Threading MBeans

These MBeans are only available in the NHTTP transport and not in the default Pass Through transport.

You can view the following Threading MBeans:

  • org.apache.synapse/Threading/HttpClientWorker
  • org.apache.synapse/Threading/HttpServerWorker


Attribute NameDescription
TotalWorkerCountTotal worker threads related to this server/client.
AvgUnblockedWorkerPercentageTime-averaged unblocked worker thread percentage.
AvgBlockedWorkerPercentageTime-averaged blocked worker thread percentage.
LastXxxBlockedWorkerPercentageBlocked worker thread percentage averaged for last Xxx time period.
DeadLockedWorkersNumber of deadlocked worker threads since last statistics reset.
LastResetTimeLast time thread statistic recordings was reset.


Operation NameDescription
reset()Clear recorded thread statistic and restart recording.

Transport MBeans

For each transport listener and sender enabled in the ESB, there will be an MBean under the org.apache.axis2/Transport domain. For example, when the JMS transport is enabled, the following MBean will be exposed:

  • org.apache.axis2/Transport/jms-sender-n

You can also view the following Transport MBeans:

  • org.apache.synapse/Transport/passthru-http-receiver
  • org.apache.synapse/Transport/passthru-http-sender
  • org.apache.synapse/Transport/passthru-https-receiver
  • org.apache.synapse/Transport/passthru-https-sender


Attribute NameDescription
ActiveThreadCountThreads active in this transport listener/sender.
AvgSizeReceivedAverage size of received messages.
AvgSizeSentAverage size of sent messages.
BytesReceivedNumber of bytes received through this transport.
BytesSentNumber of bytes sent through this transport.
FaultsReceivingNumber of faults encountered while receiving.
FaultsSendingNumber of faults encountered while sending.
LastResetTimeLast time transport listener/sender statistic recording was reset.
MaxSizeReceivedMaximum message size of received messages.
MaxSizeSentMaximum message size of sent messages.
MetricsWindowTime difference between current time and last reset time in milliseconds.
MinSizeReceivedMinimum message size of received messages.
MinSizeSentMinimum message size of sent messages.
MessagesReceivedTotal number of messages received through this transport.
MessagesSentTotal number of messages sent through this transport.
QueueSizeNumber of messages currently queued. Messages get queued if all the worker threads in this transport thread pool are busy.
ResponseCodeTableNumber of messages sent against their response codes.
TimeoutsReceivingMessage receiving timeout.
TimeoutsSendingMessage sending timeout.


Operation NameDescription
start()Start this transport listener/sender.
stop()Stop this transport listener/sender.
resume()Resume this transport listener/sender which is currently paused.
resetStatistics()Clear recorded transport listener/sender statistics and restart recording.
pause()Pause this transport listener/sender which has been started.
maintenenceShutdown(long gracePeriod)Stop processing new messages, and wait the specified maximum time for in-flight requests to complete before a controlled shutdown for maintenence.
  • No labels