Skip to main content
Feedback

Enabling remote JMX on an API Gateway

To monitor the status of an API Gateway, use the Properties panel to enable Remote JMX (Java Management Extensions) for the runtime.

Before you begin

If you are monitoring the status of a runtime cluster or runtime cloud, setting the Remote JMX properties enables JMX on each node in the cluster. To read more about monitoring and managing using JMX technology go to Java 7 JMX enablement options or Java 8 JMX enablement options.

Procedure

  1. Go to Manage > Runtime Management.

  2. Select the runtime from the list.

  3. In Settings & Configuration, click Properties.

    The runtime Properties panel opens.

  4. Click the Advanced tab.

  5. Select the JMX Remote Port property (-Dcom.sun.management.jmxremote.port), click Add a Property, and type a port number in the Property Value field.

    The recommended port is 5002. If port 5002 is not available, you can specify a different port. Make sure the port is open in the firewall and that no two runtime containers use the same port number.

  6. Select the JMX Remote RMI Port property (-Dcom.sun.management.jmxremote.rmi.port), click Add a Property, and type a port number in the Property Value field.

    The recommended port is 5002. If port 5002 is not available, you can specify a different port. Make sure the port is open in the firewall and that no two runtime containers use the same port number.

  7. Select the JMX Remote SSL property (-Dcom.sun.management.jmxremote.ssl) and click Add a Property.

    The Property Value check box is cleared by default, which means the property is set to false and the SSL security protocol is not used.

    To enable SSL security, select the check box. The property is set to true.

  8. Select the JMX Remote Authentication property (-Dcom.sun.management.jmxremote.authenticate) and click Add a Property.

    The Property Value check box is cleared by default, which means the property is set to false and password authentication is not used.

    To enable authentication, select the check box. The property is set to true. A jmxremote.password file is required.

  9. Click Save.

    Because changes to these properties do not take effect until the runtime or runtime cluster is restarted, you are prompted to restart. You have the option to restart now or restart later.

After you have enabled Remote JMX on the runtime, configure a Java monitoring tool such as JVisualVM for JMX management, connect to the runtime, and then restart the runtime.

On this Page