Enable API Gateway with JMX

Set up Java Management Extensions to allow remote clients to connect to a JVM and manage or monitor running applications.

2 minute read

Java Management Extensions (JMX) allows remote clients to connect to a JVM and manage or monitor running applications in that JVM. MBeans are the controllable endpoints of your application where remote clients can observe application activity as well as control their inner workings.

For more information on implementing an MBean interface, see the FilterInterceptor example. The sample code can be found in the DEVELOPER_SAMPLES/FilterInterceptorLoadableModule directory. The FilterInterceptor class implements the FilterInterceptorMBean interface.

After you have set up your MBean, you must tell the JMX infrastructure about the MBean so that it can be published to clients. This involves creating a unique name for the MBean and registering it with the MBeanServer. For example:

try {
    MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
    // Construct the ObjectName for the MBean we will register.
    ObjectName name = new ObjectName(
    mbs.registerMBean(this, name);
} catch (Throwable t) {

After you have set up your MBeans and registered them with the MBeanServer you can view them in the management console that your JMX container supports (for example, JConsole). To use JConsole, add the following JVM argument to API Gateway and restart it.

Follow these steps:

  1. Create a file called jvm.xml in the following location:

  2. Edit the jvm.xml file so that the contents are as follows:

        <VMArg name="-Dcom.sun.management.jmxremote"/>
  3. Restart API Gateway.

When you restart the API Gateway instance with the above settings you can connect using Java Monitoring and Management Console (JConsole) and view your MBeans. Launch jconsole (an executable in the bin directory of your Java JDK installation) and select the MBeans tab to see the FilterInterceptorMBean listed on the left. You can see the message total, success, failure, and abort counts.

Last modified March 26, 2020: Update list (e59a25bc)