JMX Quick Start Guide

Tomcat

For Tomcat servers, enter the following commands in the startup script.

WebLogic

For WebLogic, enter the following commands in the startup script.

You need to enable this on the Administrative page. Navigate to Domain > Configuration > General page > Advanced options. Then, select usePlatformMBean and exportPlatformMBean.

JBoss

Enter the following commands to enable JBoss to send JMX data. Change the host name and IP address to /etc/hosts to connect. The server name cannot be listed under 127.0.0.1.

Using a text editor of your choice, edit /opt/jboss/bin/run.sh. Add #Setup jmx remoting.

Use the JBoss MBeanServerBuilder.

Use the jboss logmanager.

GlassFish

First, increase the monitoring to HIGH on the Web Admin page. Then, enter the following commands to enable GlassFish version 3.1 to send JMX data.

In the domain configuration file /glassfish/domains/domain1/config/domain.xml find <java-config> and add the following.

Find <admin-service> and add/modify,

WebSphere 6.1

1. From the command line interface (CLI), enter the following commands.

   1. Install the server.

      $ yum install compat-libstdc++-* libXp libXmu

   2. Run the server.

      $ /etc/init.d/webspherejmxserverNode01_was.init start

2. Log in via the admin console and make sure that the JMX RMI connection is established.

   1. Use the Python script ListPorts to get the admin port.

      $ ./wsadmin.sh -conntype none -lang jython -profileName AppSrv01 -f /opt/ListPorts.py

   2. Log on to the server.

      admin:admin

3. Return to the CLI and disable security.

   $ ./wsadmin.sh -conntype NONE

   wsadmin>securityoff

   wsadmin>$AdminConfig save

4. Connect with the following script.

   #!/bin/bash

   HOST=

   PORT=

   WAS_HOME=/home/dkozlowski/IBM/WebSphere/AppServer

   CLIENTSAS="-Dcom.ibm.CORBA.ConfigURL=file:`pwd`/sas.client.props"

   PROVIDER="-Djava.naming.provider.url=corbaname:iiop:$HOST:$PORT"

   PROPS=

   #PROPS="$PROPS $CLIENTSAS"

   #PROPS="$PROPS $PROVIDER"

   CLASSPATH=

   CLASSPATH="$CLASSPATH:$WAS_HOME/java/lib/tools.jar"

   CLASSPATH="$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.admin.client_7.0.0.jar"

   CLASSPATH="$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.ejb.thinclient_7.0.0.jar"

   CLASSPATH="$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.orb_7.0.0.jar"

   CLASSPATH="$CLASSPATH:$WAS_HOME/java/lib/jconsole.jar"

   URL=service:jmx:iiop://$HOST:$PORT/jndi/JMXConnector

   java -classpath $CLASSPATH $PROPS sun.tools.jconsole.JConsole $URL

WebSphere 8.5

1. Log on to the WebSphere Admin Console.

2. On the left, click + next to Servers to expand the options.

3. Click + next to Server Types to display the Server Types options.

4. Click the WebSphere application servers link to display the application servers on the right.
   

5. Click on the server to administer.
   

6. On the right side of the page, under Server Infrastructure, click Administration services to display the Administration Services options.
   

7. In the Additional Properties section, click JMX Connectors.
   

8. Select the SOAPConnector check box, if needed.
   

9. Return to the previous page.

10. In the General Properties section, click the Remote connector drop-down and select SOAPConnector.
    

11. Click Apply.

12. Return to the Servers page to find the port for SevOne NMS to use to monitor the device.
    

13. In the Communications section, click + next to Ports to expand the Ports list.

14. Make a note of the SOAP_CONNECTOR_ADDRESS port number. This port number is used for the device on the Edit Device page. For details please refer to section Enable JMX Plugin.

Best Practices

The following are best practices when managing JMX object types.

1. For any JMX object types that you want to enable, make sure that they are enabled before discovering the applicable device. Otherwise, you will need to rediscover the device.

2. Only enable the object types that you want for the applicable device; do not enable all object types. Enabling all object types can slow down discovery.

Manage

Perform the following steps to add and edit JMX object types.

1. From the navigation bar, click Administration and select Monitoring Configuration, then Object Types.
   

2. Click the Filter drop-down and select JMX Poller. In the Object Types hierarchy on the left, you will see the object types that the JMX plugin can poll.
   

3. Click Add to display the Add JMX Object Type pop-up. To edit an existing object type, select the object type and click under Actions.
   

4. In the Name field, enter the object type name.

5. In the Domain field, enter the object type domain.

6. In the Type field, enter the type of the object type.

7. In the Class Name field, enter the class name of the object type.

8. In the Alias field, enter the alias of the object type.

9. Select the Enabled check box to enable the JMX plugin to poll the indicator types of the object type.

10. Select the check box for the Note field to enable it for editing. Enter any additional information you would like to include.

11. Click Save As New.

Manage JMX Atomic Indicator Types

Perform the following steps on the Object Types page to add and edit JMX atomic indicator types.

1. In the Object Types hierarchy on the left, select the object type that you would like to create an indicator type for.

2. On the right side of the page, under Indicator Types, click Add Atomic Indicator Type to display the Add JMX Indicator Type pop-up. To edit an existing indicator type, select the indicator type and click under Actions.
   

3. In the Indicator Name field, enter the name of the indicator type.

4. In the Description field, enter the name to display.

5. Click the Indicator Type drop-down and select one of the following options:

   • GAUGE - for indicators that have specific values when polled.

   • COUNTER32 - for 32-bit indicators that continue to increment. If you select this option, you can select the Has Precalculated Deltas check box to total the delta/differences between polls. This provides the ability to graph things like the number of errors in a day, for example.

   • COUNTER64 - for 64-bit indicators that continue to increment. If you select this option, you can select the Has Precalculated Deltas check box.

6. Click the Measure As drop-down and select a data unit to measure in.

7. Click the Display As drop-down and select a display unit.

8. Select the Maximum Value check box to indicate that the indicator type has a maximum value.

9. Select the Default allowed for new devices check box to have the plugin poll this indicator type by default when the object type is enabled and when the plugin for a device is enabled.

10. In the Note field, enter any additional information you would like to include.

11. Click Save As New.

Manage JMX Synthetic Indicator Types

Using synthetic indicator types, you can create your own key performance indicators (KPIs) even when those KPIs such as, Percent Usage, Percent Loss, Percent Error, and Percent Idle, do not exist for a device. For example, let's say that you want to monitor voice gateways to find out which primary rate interface (PRI) is getting the most usage. Typical poll metrics can tell you the busy status of individual bearer channels, or B channels, but they cannot tell you the sum of the statuses for all the B channels. This makes it difficult to find out the total usage of a particular PRI.

In SevOne NMS, you can create a single indicator type that tells you what percentage of a PRI is being used.

You will need the following:

• An existing indicator type that tells you how many busy B channels there are for a given PRI. Let's call this BChannelsBusy.

• The total number of B channels for our PRI. i.e., number 23.

Using this information, a synthetic indicator type can be created with an expression to perform the following calculation.

The new synthetic indicator type will tell the user what percentage of the PRI is being used. There is no need to look up the number of busy B channels and perform calculations manually.

Perform the following steps on the Object Types page to add and edit JMX synthetic indicator types.

1. In the Object Types hierarchy on the left, click on an object type to display its indicator types on the right. If the object type does not have any indicator types, the Add Synthetic Indicator Type button will not appear.
   

2. Click Add Synthetic Indicator Type to display the Add Synthetic Indicator Type pop-up. To edit an existing synthetic indicator type, select the indicator type and click under Actions.
   

3. In the Indicator Name field, enter the name of the synthetic indicator type.

4. In the Description field, enter the name to display.

   You will see the indicator description displayed in reports and elsewhere in the user interface. Keep this in mind when creating the indicator type description. For example, when you look at an object's indicators, you will notice that they are listed based on the first word of their description. If you have the two indicators Received Bytes and Sent Bytes, they may not appear together. However, if you use the descriptions Bytes Received and Bytes Sent, the indicators will appear in close proximity to each other.

5. The Synthetic Indicator Expression field is where you define the calculation. Perform the following actions to create the expression for this field.

   A red border around the Synthetic Indicator Expression field indicates that your calculation is invalid. This also means that your graph results will be incorrect.

   1. In the Available Source Indicators field on the right, select an indicator type to use in the expression. Drag and drop it into the Synthetic Indicator Expression field.

      The Available Source Indicators field contains the indicator types for the object type that you selected a few steps ago.

   2. Enter the applicable operators to formulate your calculation in the Synthetic Indicator Expression field. For a list of available operators, please refer to section Acceptable Operators.

   3. Drag any additional indicator types from the Available Source Indicators field and enter additional mathematical symbols to complete the expression in the Synthetic Indicator Expression field.

6. The Maximum Value Expression field allows you define the maximum value calculation for the indicator type. Perform the following actions to create the expression for this field.

   1. In the Available Source Indicators field on the right, select an indicator type to use in the expression. Drag and drop it into the Maximum Value Expression field.

   2. Enter the applicable operators to formulate your calculation in the Maximum Value Expression field. For a list of available operators, please refer to section Acceptable Operators.

   3. Drag any additional indicator types from the Available Source Indicators field and enter additional mathematical symbols to complete the expression in the Maximum Value Expression field.

7. Click the Measure As drop-down and select a data unit.

8. Click the Display As drop-down and select a display unit.

9. Select the Default allowed for new devices check box to have the plugin poll this indicator type by default when the object type is enabled and when the plugin for a device is enabled.

10. In the Note field, enter any additional information you would like to include.

11. Click Save As New.

Acceptable Operators

The following operators / characters are acceptable in the expression formula.

• + add

• - subtract

• * multiply

• / divide

• && logical AND

• || logical OR

• <= less than or equal to

• >= greater than or equal to

• ! not equal to

• == equal to

• > greater than

• < less than

• ^ raise x to the power of y

• % modulus

• ?: if...then...else

• isnan is Not a Number. This evaluates to 1 if the value is not a number. Otherwise, it evaluates to 0.

• isValid is valid. This evaluates to 1 if the value has been discovered and is not isnan. Otherwise, it evaluates to 0.

• useIfValid use if valid. This evaluates to the value if it has been discovered and is not isnan. It evaluates to the second argument otherwise.

If your calculation results in either of the following invalid values, there will be a gap in your graph.

• Not a Number (NAN)

• Infinity (+/-INF).

The following describes how SevOne NMS attempts to prevent invalid values. These are listed in the order they are processed.

• Zero divided by zero results in NAN.

• Any positive value divided by zero results in +INF.

• Any negative value divided by zero results in -INF.

• Zero multiplied by +/-INF results in NAN.

• Any value added to, subtracted from, multiplied by, divided by, or divided from NAN results in NAN.

• Any value compared to NAN (<, <=, ==, >=, >) results in 0. NAN != NAN.

• Any value compared to +INF is less than +INF, except that +INF == +INF

• Any value compared to -INF is greater than -INF, except that -INF == -INF

• Any value added to or subtracted from +INF results in +INF

• Any positive value multiplied by +/-INF results in +/-INF

• Any value divided by +/-INF results in 0