JMX-Based Monitoring¶

Configuring JMX in WSO2 Identity Server¶

JMX is enabled in WSO2 Identity Server by default ensuring that the JMX server starts automatically. Additionally, you can enable JMX separately for the various datasources that are used by WSO2 IS. Once JMX is enabled, you can log in to the JConsole tool and monitor your WSO2 IS instance as explained in the Monitoring WSO2 Identity Server with JConsole section.

Configuring JMX ports for the server¶

The default JMX ports (RMIRegistryPort and the RMIServerPort) are configured in the deployment.toml file (stored in the <IS_HOME>/repository/conf directory) as shown below. If required, you can update these default values.

[monitoring.jmx]
rmi_registry_port = "9999"

[monitoring.jmx]
rmi_server_por = "11111"

Disabling JMX for the server¶

You can disable the JMX server by setting the following property to false in the deployment.toml file.

[monitoring.jmx]
rmi_server_start = false

Enabling JMX for a datasource¶

You can enable JMX for a datasource by adding the jmxEnabled as true element to the datasource configuration. For example, to enable JMX for the default Carbon datasources, add the following property to the deployment.toml file (stored in the <IS_HOME>/repository/conf/ directory).

[database.identity_db.pool_options]
jmxEnabled = true

[database.shared_db]
...
jmx_enable = true

Monitoring WSO2 Identity Server with JConsole¶

Jconsole is a JMX-compliant monitoring tool, which comes with the Java Development Kit (JDK) 1.5 and newer versions. You can find this tool inside your <JDK_HOME>/bin directory. See the instructions on Installing the JDK for more information.

Starting WSO2 Identity Server with JMX¶

First, start WSO2 Identity Server:

1. Open a command prompt and navigate to the <IS_HOME>/bin directory.

2. Execute the WSO2 IS startup script and start the server.

   Linux

   wso2server.sh

   Windows

   wso2server.bat 

   Tip

   If JMX is enabled, the JMX server URL will be published on the console when the server starts as shown below.

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

Once the identity server has started, you can start the JConsole tool as follows:

1. Open a command prompt and navigate to the <JDK_HOME>/bin directory.
2. Execute the jconsole command to open the log-in screen of the Java Monitoring & Management Console as shown below.
   

3. Enter the connection details in the above screen as follows:

   1. Enter the JMX server URL in the Remote Process field. This URL is published on the command prompt when you start the WSO2 server as explained above.

      Tip

      If you are connecting with a remote IP address instead of localhost, you need to bind the JMX service to the externally accessible IP address by adding the following system property to the product startup script stored in the <IS_HOME>/bin directory ( wso2server.sh for Linux and wso2server.bat for Windows). For more information, read Troubleshooting Connection Problems in JConsole .

       -Djava.rmi.server.hostname=<IP_ADDRESS_WHICH_YOU_USE_TO_CONNECT_TO_SERVER>

      Be sure to restart the server after adding the above property.

   2. Enter values for the Username and Password fields to log in.

      Tip

      If you are logging in as the administrator, you can use the same administrator account that is used to log in to the WSO2 IS management console (admin/admin).

      Note

      Make sure that the user ID you are using for JMX monitoring is assigned a role that has the Server Admin permission. See Configuring Roles for further information about configuring roles assigned to users. Any user assigned to the admin role can log in to JMX.

4. Click Connect to open the Java Monitoring & Management Console. The following tabs will be available.

   • Overview: See the Oracle documentation on using JConsole for more information on these tabs.

   • Memory: See the Oracle documentation on using JConsole for more information on these tabs.

     

   • Threads: See the Oracle documentation on using JConsole for more information on these tabs.

     

   • Classes: See the Oracle documentation on using JConsole for more information on these tabs.

     

   • VM: See the Oracle documentation on using JConsole for more information on these tabs.

     

   • MBeans: See the Oracle documentation on using JConsole for more information on these tabs.

     

Using the ServerAdmin MBean¶

When you go to the MBeans tab in the JConsole, the ServerAdmin MBean will be listed under the &org.wso2.carbon domain as shown below.

The ServerAdmin MBean is used for administering the WSO2 Identity Server instance. There are several server attributes such as ServerStatus, ServerData and ServerVersion.

The ServerStatus attribute can take any of the following values:

• RUNNING
• SHUTTING_DOWN
• RESTARTING
• IN_MAINTENANCE

The ServerAdmin MBean has the following operations:

Using the ServiceAdmin MBean¶

This MBean is used for administering services deployed in WSO2 IS. Its attributes are as follows:

The operations available in the ServiceAdmin MBean:

Using the StatisticsAdmin MBean¶

This MBean is used for monitoring system and server statistics. Its attributes are as follows:

Operations available in the Statistics MBean:

Using the DataSource MBean¶

If you have JMX enabled for a datasource connected to the WSO2 IS instance, you can monitor the performance of the datasource using this MBean. The DataSource MBean will be listed as shown below.

Example: If you have JMX enabled for the default Carbon datasources in the deployement.toml file, the JDBC connection pool parameters that are configured for the Carbon datasource will be listed as attributes as shown below. See the performance tuning guide for instructions on how these parameters are configured for a datasource.

Monitoring WSO2 IS with Jolokia¶

Jolokia is a JMX-HTTP bridge, which is an alternative to JSR-160 connectors. It is an agent-based approach that supports many platforms. In addition to basic JMX operations, it enhances JMX monitoring with unique features like bulk requests and fine-grained security policies.

Follow the steps below to use Jolokia to monitor WSO2 IS.

1. Download Jolokia OSGi Agent. (These instructions are tested with the Jolokia OSGI Agent version 1.3.6 by downloading the jolokia-osgi-1.3.6.jar file.)

2. Add it to the <IS-HOME>/repository/components/dropins/ directory.

3. Start WSO2 Identity Server.

Once the server starts, you can read MBeans using Jolokia APIs. Following are a few examples.

• List all available MBeans: http://localhost:9763/jolokia/list (Change the appropriate hostname and port accordingly)
• Reading Heap Memory: http://localhost:9763/jolokia/read/java.lang:type=Memory/HeapMemoryUsage

For more information on the JMX MBeans that are available in WSO2 products, see Monitoring WSO2 IS with JConsole.