References > Component Monitor Types > JMX Monitor

JMX monitor

This component monitor tests a Java application server. This monitor can be monitored agentless or with the Orion agent. When monitoring with the Orion agent for Linux, the monitor does not use the JMX bridge service.

Java Management Extensions (JMX) is not supported using the Orion agent for Windows.

We recommend only testing JMX components one at a time for best agent performance and results. When testing a large number or all JMX component monitors in the Edit Application page, the agent is put under heavy load and could return incorrect results.

When monitoring Tomcat, we recommend using the Tomcat Server monitor.

Prerequisites

The JMX connector must be enabled on the Java application server.

The JMX monitor requires a Java Virtual Machine (JVM) version 1.6 or later.

Credentials

You may need either JMX credentials or none at all. This depends on the credentials required based on the configuration of your Java application server.

JMX Configurations for Orion agent for Linux

For JMX configurations, you need to install and configure WebSphere per your Linux distribution. For details, see the IBM WebSphere documentation site.

The overall steps include:

  1. Get and install WebSphere. You may require credentials for the installation.
  2. During installation, you can turn off the secure storage option as this is not needed. You may need to create a new package group. Make sure to select the Application Server during installation. You may also need to create an administrator account.
  3. Start and stop the WebSphere AppServer.
  4. Access the WebSphere AppServer console to continue configurations. You can access by pointing a browser to http://<websphere-host>:9060/ibm/console. You may need to open a port to 9060 on the websphere host. Use the credentials for the account created during installation.
  5. You need to expose the JMX platform mbeans in the WebSphere AppServer using the console. Click Servers > Server Types > WebSphere application servers and select the listed application server.
  6. Locate the Java and Process Management > Process definition. In the dialog box titled "Generic JVM arguments" enter the following:

    Djavax.management.builder.initial=

    There is nothing after the = sign.

    Dcom.sun.management.jmxremote=true

    Dcom.sun.management.jmxremote.port=8686

    Dcom.sun.management.jmxremote.ssl=false

    Dcom.sun.management.jmxremote.authenticate=false

  7. Restart the AppServer.

Field Descriptions

Description

This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which is automatically saved. The variable to access this field is ${UserDescription}.

Component Type

This describes the type of monitor you are using.

Enable Component

This option determines whether or not the component is enabled. Disabling this component leaves it in the application as deactivated and does not influence application availability or status.

Credential for Monitoring

This allows you to set JMX credentials for querying MBeans. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential.

Count statistic as difference

Select this option to change the statistic to be the difference in query values between polling cycles. This measure is the difference in polled values and trend that statistic. This is a constantly increasing value, as it tracks total collection time since the JVM started.

Port Number

This field allows you to specify the port number used for JMX connections.

Protocol

This field allows you to choose between using Remote Method Invocation (RMI) and Invocation over Internet Inter-Orb Protocol (IIOP). Note: RMI should be correctly referred to as RMI/JRMP and IIOP as RMI/IIOP based on JMX Specifications.

URL Path

This field is for the last part of the JMX service URL. This follows hostname:portnumber and begins with a slash. For example: service:jmx:rmi:///jndi/rmi://HostName:portnumber/jmxrmi

Custom URL Format

Optional, enter a custom format for the URL. You can use the following available macros: ${IP}, ${PORT}, ${PROTOCOL}, or ${PATH}. Leave the field empty to use the default format (set by default).

Object Name

This field is for the unique string identifier of an MBean in the form of <domain -name>:<key property >.

Attribute Name

This field is for the name of an MBean attribute.

Key

This is used for monitoring composite attributes, which consist of key:value pairs.

SAM only supports monitoring of numerical data type attributes.

Convert Value

Checking the Convert Value check box opens the Formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the drop down lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion value.

Statistic Threshold

This field allows you to specify when a threshold that indicates a warning or critical level has been breached. Logical operators are in the drop down followed by a blank field for you to enter the value of this threshold. For example: Less than 15 for warning, Less than 5 for critical. See setting Application Monitor Thresholds for more information.

User Notes

This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}.