WSO2 AppServer 4.1.2

• Release Notes
• Contents
• Home

Downloads

• Releases

Documentation

• User Guide
• Architecture Guide
• Installation Guide
• Building Source
• Running Behind a Proxy
• Clustering Guide
• Changing Keys
• JMX Monitoring
• WebApp Deployment
• Data Services
• Carbon Apps
• Security Scenarios
• Class Loading

Samples

• Chad
• Commodity Quote
• Flickr
• JAXWS
• JiBX
• MTOM
• Mail
• STS
• Trader
• Tiny URL
• Metadata Exchange
• WS-Transfer
• XKMS
• JSON
• Client API
• WebApp

Resources

• Library
• Features

Get Involved

• Checkout Source
• Mailing Lists
• Issue Tracking

Project Info

• License
• Dependencies

[Download] | [Documentation Index] | [Release Note]

JMX Based Monitoring

Contents

• Introduction
• Using jconsole to Manage & Monitor AppServer

Introduction

Java Management Extensions (JMX) is a technology that lets you implement management interfaces for Java applications. A management interface, as defined by JMX, is composed of named objects - called MBeans (Management Beans). MBeans are registered with a name (an ObjectName) in an MBeanServer. To manage (a) resource(s) in your application, you will write an MBean that defines its management interface, and then register that MBean in your MBeanServer. The content of the MBeanServer can then be exposed through various protocols, implemented by protocol connectors, or protocol adaptors. The first version of JMX based monitoring is available in this release. Some of the monitoring & management capabilities available in the Management Console have also been exposed via JMX.

Using jconsole to Manage & Monitor AppServer

This section introduces some of the MBeans in AppServer and their usages. We will use jconsole which ships with J2SDK 1.5 and newer version in the course of this documentaton.

JMX is by default enabled in WSO2 Carbon. You can change the JMX configuration by editing the jmx.xml file which is inside CARBON_HOME/repository/conf/advanced/ directory.

You can configure JMX ports, RMIRegistryPort and RMIServerPort from the "Ports" section of the carbon.xml (inside CARBON_HOME/repository/conf) as follows.

        <JMX>
        <!--The port RMI registry is exposed-->
        <RMIRegistryPort>9999</RMIRegistryPort>
        <!--The port RMI server should be exposed-->
        <RMIServerPort>11111</RMIServerPort>
        </JMX>
    

If JMX is enabled, when the server starts up, it will print the JMX Server URL on the console as follows.

        INFO {org.wso2.carbon.core.init.CarbonServerManager} -  JMX Service URL  : service:jmx:rmi://<your-ip>:11111/jndi/rmi://<your-ip>:9999/jmxrmi
    

---

Now go to the command prompt and you can start Jconsole by using the command 'jconsole'

As shown in the above image, you can connect to Carbon by providing the above URL as the Remote Process URL. You can type in the default username and password combination admin/admin to login. Note that this is the same administrator account that is used for looging in, in the Management Console. Any user having the admin role can login to JMX.

---

Here is the first window you will see when you login.

---

Click on the MBeans tab and you will see the org.wso2.carbon domain, which will contain some MBeans as shown below.

ServerAdmin MBean

The ServerAdmin MBean is used for administering the AppServer server instance

The above screen shows the Server attributes such as the ServerStatus, ServerData & ServerVersion. The ServerStatus can be either RUNNING, SHUTTING_DOWN, RESTARTING or IN_MAINTENANCE.

---

The above screen shows the operations available in the ServerAdmin MBean.

• shutdown - forcefully shutdown the server
• restart - forcefully restart the server
• restartGracefully - wait till all current requests are served and then restart
• shutdownGracefully - wait till all current requests are served and then shutdown
• startMaintenance - switch the server to maintenance mode. No new requests will be accepted while the server is in maintenance
• endMaintenance - switch the server to normal mode, if it was switched to maintenance mode earlier.

ServiceAdmin MBean

The ServiceAdmin MBean is used for adminsitering services deployed on AppServer The above screen shows the attributes:

• NumberOfActiveServices - The number of services which can currently serve requests
• NumberOfInactiveServices - The number of services which have been disabled by an administrator
• NumberOfFaultyServices - The number of services which are faulty

---

The above screen shows the operations available in the ServiceAdmin MBean.

• startService(p1:string) - The p1 parameter is the service name. You can activate a service using this operation.
• stopService(p1:string) - The p1 parameter is the service name. You can deactivate/disable a service using this operation.

Statistics MBean

The Statistics MBean is used for monitoring system and server statistics The above screen shows the attributes:

• AvgSystemResponseTime - The average response time for all the services deployed in the system. The beginning of the measurement is the time at which the server started.
• MaxSystemResponseTime - The maximum response time for all the services deployed in the system. The beginning of the measurement is the time at which the server started.
• MinSystemResponseTime - The minimum time for all the services deployed in the system. The beginning of the measurement is the time at which the server started.
• SystemFaultCount - The total number of faults that occurred in the system since the server was started.
• SystemRequestCount - The total number of requests that has been served by the system since the server was started
• SystemResponseCount - The total number of response that has been sent by the system since the server was started

---

The above screen shows the operations available in the Statistics MBean.

• getServiceRequestCount(p1:string) - The p1 parameter is the service name. You can get the total number of requests received by this service since the time it was deployed, using this operation.
• getServiceResponseCount(p1:string) - The p1 parameter is the service name. You can get the total number of responses sent by this service since the time it was deployed, using this operation.
• getServiceFaultCount(p1:string) - The p1 parameter is the service name. You can get the total number of fault responses sent by this service since the time it was deployed, using this operation.
• getMaxServiceResponseTime(p1:string) - The p1 parameter is the service name. You can get the maximum response time of this service since deployment.
• getMinServiceResponseTime(p1:string) - The p1 parameter is the service name. You can get the minimum response time of this service since deployment.
• getAvgServiceResponseTime(p1:string) - The p1 parameter is the service name. You can get the average response time of this service since deployment.
• getOperationRequestCount(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the total number of requests received by this operation since the time its service was deployed, using this operation.
• getOperationResponseCount(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the total number of responses sent by this operation since the time its service was deployed, using this operation.
• getOperationFaultCount(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the total number of fault responses sent by this operation since the time its service was deployed, using this operation.
• getMaxOperationResponseTime(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the maximum response time of this operation since deployment.
• getMinOperationResponseTime(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the minimum response time of this operation since deployment.
• getAvgOperationResponseTime(p1:string, p2:string) - The p1 parameter is the service name. The p2 parameter is the operation name. You can get the average response time of this operation since deployment.