Monitor with the IBM Tivoli Enterprise Monitoring Agent for WebSphere eXtreme Scale

WebSphere eXtreme Scale Administration Guide > Monitor the deployment environment > Vendor tools

Monitor with the IBM Tivoli Enterprise Monitoring Agent for WebSphere eXtreme Scale

The IBM Tivoli Enterprise Monitoring Agent is a feature-rich monitoring solution that you can use to monitor databases, operating systems and servers in distributed and host environments. WebSphere eXtreme Scale includes a customized agent that you can use to introspect eXtreme Scale management beans. This solution works effectively for both stand-alone eXtreme Scale and WebSphere Application Server deployments.

Before you begin

Install WebSphere eXtreme Scale Version 7.0.0 or later.
Install IBM Tivoli Monitoring v6.2.1 with fix pack 2 or later.
Install the Tivoli OS agent on each server or host on which eXtreme Scale servers run.
Install the WebSphere eXtreme Scale agent, which you can download for free from the IBM Open Process Automation Library (OPAL) site.

Complete the following steps to install and configure the Tivoli Monitoring Agent:

Procedure
Install the Tivoli Monitoring Agent for WebSphere eXtreme Scale.
Download the Tivoli installation image and extract its files to a temporary directory.
Install eXtreme Scale application support files.
Install eXtreme Scale application support on each of the following deployments.

Tivoli Enterprise Portal Server (TEPS)
Enterprise Desktop client (TEPD)
Tivoli Enterprise Monitoring Server (TEMS)

From the temporary directory that you created, start a new command window and run the appropriate executable file for your platform. The installation script automatically detects your Tivoli deployment type (TEMS, TEPD, or TEPS). You can install any type on a single host or on multiple hosts; and all of the three deployment types require the installation of the eXtreme Scale agent application support files.
In the Installer window, verify that the selections for the Tivoli Components deployed are correct. Click Next.
If you are prompted, submit the hostname and administrative credentials. Click Next.
Select the Monitor Agent for WebSphere eXtreme Scale. Click Next.
You are notified of what installation actions are to be performed. Click Next, and you can see the progress of the installation until completion.
After completing the procedure, all application support files required by WebSphere eXtreme Scale agent are installed.
Install the agent on each of the eXtreme Scale nodes.
You install a Tivoli OS agent on each of the computers. You do not need to configure or start this agent. Use the same installation image from the previous step to run the platform specific executable file.
As a guideline, you need to install only one agent per host. Each agent is capable of supporting many instances of eXtreme Scale servers. For best performance, use one agent instance for monitoring about 50 eXtreme Scale servers.

From the installation wizard welcome screen, click Next to open the screen to specify installation path information.
For the Tivoli Monitoring installation directory field, enter or browse to C:\IBM\ITM (or /opt/IBM/ITM). Then for the Location for installable media field, verify that the displayed value is correct and click Next.
Select the components to add, such as Perform a local install of the solution and click Next.
Select the applications for which to add support for by selecting the application, such as Monitor Agent for WebSphere eXtreme Scale, and click Next.
You can see the progress until application support is added successfully.

Repeat these steps on each of the eXtreme Scale nodes. You can also use silent installation. See the IBM Tivoli Monitoring Information Center for more information about silent installation.
Configure the WebSphere eXtreme Scale agent.
Each of the agents installed need to be configured to monitor any catalog server, eXtreme Scale server, or both.
The steps to configure Windows and UNIX platforms are different. Configuration for the Windows platform is completed with the Manage Tivoli Monitoring Services user interface. Configuration for UNIX platforms is command-line based.
Use the following steps to initially configure the agent on Windows

From the Manage Tivoli Enterprise Monitoring Services window, click Start > All Programs > IBM Tivoli Monitoring > Manage Tivoli Monitoring Services.
Right click on Monitor Agent for WebSphere eXtreme Scale and select Configure using default, which opens a window to create a unique instance of the agent.
Choose a unique name: for example, instance1, and click Next.

If you plan to monitor stand-alone eXtreme Scale servers, complete the following steps:

Update the Java™ parameters, ensure that the Java Home value is correct. JVM arguments can be left empty. Click Next.
Select the type of MBean server connection type, Use JSR-160-Complaint Server for stand-alone eXtreme Scale servers. Click Next.
If security is enabled, update User ID and Password values. Leave the JMX service URL value as is. You override this value later. Leave the JMX Class Path Information field as it is. Click Next.
To configure the servers for the agent on Windows...

Set up subnode instances of eXtreme Scale servers in the WebSphere eXtreme Scale Grid Servers pane. If no container servers exist on the computer, click Next to proceed to the catalog service pane.
If multiple eXtreme Scale container servers exist on the computer, configure the agent to monitor each one server.
You can add as many eXtreme Scale servers as you require, if their names and ports are unique, by clicking New. (When an eXtreme Scale server is started, a JMXPort value must be specified.)
After you configure the container servers, click Next, which brings you to the WebSphere eXtreme Scale Catalog Servers pane.
If you have no catalog servers, click OK. If you have catalog servers, add a new configuration for each server, as you did with the container servers. Again, choose a unique name, preferably the same name that is used when starting the catalog service. Click OK to finish.

If you plan to monitor servers for the agent on eXtreme Scale servers that are embedded within a WebSphere Application Server process, complete the following steps:

Update the Java parameters, ensure that the Java Home value is correct. JVM arguments can be left empty. Click Next.
Select the MBean server connection type. Select the WebSphere Application Server version that is appropriate for the environment. Click Next.
Verify the WebSphere Application Server information in the panel is correct. Click Next.
Add only one subnode definition. Give the subnode definition a name, but do not update the port definition. Within WebSphere Application Server environment, data can be collected from all the application server that are managed by the node agent that is running on the computer. Click Next.
If there no catalog servers exist in the environment, click OK. If you have catalog servers, add a new configuration for each catalog server, similarly to the container servers. Choose a unique name for the catalog service, preferably the same name that you use when starting the catalog service. Click OK to finish.

The container servers do not need to be collocated with the catalog service.
Now that the agent and servers are configured and ready, on the next window, right click on instance1 to start the agent.
To configure the agent on the UNIX platform on the command line...
An example follows for stand-alone servers that uses a JSR160 Compliant connection type. The example shows three eXtreme Scale containers on the single host (rhea00b02) and the JMX listener addresses are 15000,15001 and 15002 respectively. There are no catalog servers.
Output from the configuration utility displays in monospace italics, while the user response is in monospace bold. (If no user response was required, the default was selected by pressing the enter key.)
rhea00b02 # ./itmcmd config -A xt
Agent configuration started...
Enter instance name (default is: ): inst1
Edit "Monitoring Agent for WebSphere eXtreme Scale" settings? [ 1=Yes, 2=No ] (default is: 1):
Edit 'Java' settings? [ 1=Yes, 2=No ] (default is: 1):
Java home (default is: C:\Program Files\IBM\Java50): /opt/OG61/java
Java trace level [ 1=Error, 2=Warning, 3=Information, 4=Minimum Debug, 5=Medium Debug, 6=Maximum Debug,
                7=All ] (default is: 1):
JVM arguments (default is: ):
Edit 'Connection' settings? [ 1=Yes, 2=No ] (default is: 1):
MBean server connection type [ 1=JSR-160-Compliant Server, 2=WebSphere Application Server version 6.0, 
3=WebSphere Application Server version 6.1, 4=WebSphere Application Server version 7.0 ] (default is: 1): 1
Edit 'JSR-160-Compliant Server' settings? [ 1=Yes, 2=No ] (default is: 1):
JMX user ID (default is: ):
Enter JMX password (default is: ):          
Re-type : JMX password (default is: ):
JMX service URL (default is: service:jmx:rmi:///jndi/rmi://localhost:port/objectgrid/MBeanServer):
----------------------------------------
JMX Class Path Information
JMX base paths (default is: ):
JMX class path (default is: ):
JMX JAR directories (default is: ):
Edit 'WebSphere eXtreme Scale Catalog Service' settings? [ 1=Yes, 2=No ] (default is: 1): 2
Edit 'WebSphere eXtreme Scale Grid Servers' settings? [ 1=Yes, 2=No ] (default is: 1): 1
No 'WebSphere eXtreme Scale Grid Servers' settings available?
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 1
WebSphere eXtreme Scale Grid Servers (default is: ): rhea00b02_c0
JMX service URL (default is: service:jmx:rmi:///jndi/rmi://localhost:<port>/objectgrid/MBeanServer): 
service:jmx:rmi:///jndi/rmi://localhost:15000/objectgrid/MBeanServer

'WebSphere eXtreme Scale Grid Servers' settings:  WebSphere eXtreme Scale Grid Servers=ogx
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 1
WebSphere eXtreme Scale Grid Servers (default is: ): rhea00b02_c1
JMX service URL (default is: service:jmx:rmi:///jndi/rmi://localhost:<port>/objectgrid/MBeanServer):
service:jmx:rmi:///jndi/rmi://localhost:15001/objectgrid/MBeanServer

'WebSphere eXtreme Scale Grid Servers' settings:  WebSphere eXtreme Scale Grid Servers= rhea00b02_c1
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 1
WebSphere eXtreme Scale Grid Servers (default is: ): rhea00b02_c2
JMX service URL (default is: service:jmx:rmi:///jndi/rmi://localhost:<port>/objectgrid/MBeanServer): 
service:jmx:rmi:///jndi/rmi://localhost:15002/objectgrid/MBeanServer

'WebSphere eXtreme Scale Grid Servers' settings:  WebSphere eXtreme Scale Grid Servers= rhea00b02_c2
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 5

Will this agent connect to a TEMS? [1=YES, 2=NO] (Default is: 1):
TEMS Host Name (Default is: rhea00b00):

Network Protocol [ip, sna, ip.pipe or ip.spipe] (Default is: ip.pipe):

     Now choose the next protocol number from one of these:
     - ip
     - sna
     - ip.spipe
     - 0 for none
Network Protocol 2 (Default is: 0):
IP.PIPE Port Number (Default is: 1918):
Enter name of KDC_PARTITION (Default is: null):

Configure connection for a secondary TEMS? [1=YES, 2=NO] (Default is: 2):
Enter Optional Primary Network Name or 0 for "none" (Default is: 0):
Agent configuration completed...
The previous example creates an agent instance called “inst1”, and updates the Java Home settings. The eXtreme Scale container servers are configured, but the catalog service is not configured.
The previous procedure creates a text file of the following format in the directory: <ITM_install>/config/<host>_xt_<instance name>.cfg.

Example: rhea00b02_xt_inst1.cfg
It is best to edit this file with the choice of plain text editor. An example of the content of such the file follows:
INSTANCE=inst2 [SECTION=KQZ_JAVA [ { JAVA_HOME=/opt/OG61/java }  { JAVA_TRACE_LEVEL=ERROR }  ]
SECTION=KQZ_JMX_CONNECTION_SECTION [ { KQZ_JMX_CONNECTION_PROPERTY=KQZ_JMX_JSR160_JSR160 }  ]
SECTION=KQZ_JMX_JSR160_JSR160 [ { KQZ_JMX_JSR160_JSR160_CLASS_PATH_TITLE= }  
{ KQZ_JMX_JSR160_JSR160_SERVICE_URL=service:jmx:rmi:///jndi/rmi://localho
st:port/objectgrid/MBeanServer }  { KQZ_JMX_JSR160_JSR160_CLASS_PATH_SEPARATOR= }  ]
SECTION=OGS:rhea00b02_c1 [ { KQZ_JMX_JSR160_JSR160_SERVICE_URL=service:jmx:
rmi:///jndi/rmi://localhost:15001/objectgrid/MBeanServer }  ]
SECTION=OGS:rhea00b02_c0 [ { KQZ_JMX_JSR160_JSR160_SERVICE_URL=service:jmx:
rmi:///jndi/rmi://localhost:15002/objectgrid/MBeanServer }  ]
SECTION=OGS:rhea00b02_c2 [ { KQZ_JMX_JSR160_JSR160_SERVICE_URL=service:jmx:
rmi:///jndi/rmi://localhost:15002/objectgrid/MBeanServer }  ]]
An example that shows a configuration on a WebSphere Application Server deployment follows:
rhea00b02 # ./itmcmd config -A xt
Agent configuration started...
Enter instance name (default is: ): inst1
Edit "Monitoring Agent for WebSphere eXtreme Scale" settings? [ 1=Yes, 2=No ] (default is: 1): 1
Edit 'Java' settings? [ 1=Yes, 2=No ] (default is: 1): 1
Java home (default is: C:\Program Files\IBM\Java50): /opt/WAS61/java
Java trace level [ 1=Error, 2=Warning, 3=Information, 4=Minimum Debug, 5=Medium Debug, 6=Maximum Debug,
                7=All ] (default is: 1):
JVM arguments (default is: ):
Edit 'Connection' settings? [ 1=Yes, 2=No ] (default is: 1):
MBean server connection type [ 1=JSR-160-Compliant Server, 2=WebSphere Application Server version 6.0, 
3=WebSphere Application Server version 6.1, 4=WebSphere Application Server version 7.0 ] (default is: 1): 4
Edit 'WebSphere Application Server version 7.0' settings? [ 1=Yes, 2=No ] (default is: 1):WAS user ID (default is: ):
Enter WAS password (default is: ):     
Re-type : WAS password (default is: ):
WAS host name (default is: localhost): rhea00b02
WAS port (default is: 2809):
WAS connector protocol [ 1=rmi, 2=soap ] (default is: 1):
WAS profile name (default is: ): default
----------------------------------------
WAS Class Path Information
WAS base paths (default is: C:\Program Files\IBM\WebSphere\AppServer;/opt/IBM/WebSphere/AppServer): /opt/WAS61
WAS class path (default is: runtimes/com.ibm.ws.admin.client_6.1.0.jar;runtimes/com.ibm.ws.ejb.thinclient_7.0.0.jar):
WAS JAR directories (default is: lib;plugins):
Edit 'WebSphere eXtreme Scale Grid Servers' settings? [ 1=Yes, 2=No ] (default is: 1):
No 'WebSphere eXtreme Scale Grid Servers' settings available?
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 1
WebSphere eXtreme Scale Grid Servers (default is: ): rhea00b02
JMX service URL (default is: service:jmx:rmi:///jndi/rmi://localhost:<port>/objectgrid/MBeanServer):

'WebSphere eXtreme Scale Grid Servers' settings:  WebSphere eXtreme Scale Grid Servers=rhea00b02
Edit 'WebSphere eXtreme Scale Grid Servers' settings, [1=Add, 2=Edit, 3=Del, 4=Next, 5=Exit] (default is: 4): 5
Edit 'WebSphere eXtreme Scale Catalog Service' settings? [ 1=Yes, 2=No ] (default is: 1): 2
Will this agent connect to a TEMS? [1=YES, 2=NO] (Default is: 1):
TEMS Host Name (Default is: rhea00b02):

Network Protocol [ip, sna, ip.pipe or ip.spipe] (Default is: ip.pipe):

     Now choose the next protocol number from one of these:
     - ip
     - sna
     - ip.spipe
     - 0 for none
Network Protocol 2 (Default is: 0):
IP.PIPE Port Number (Default is: 1918):
Enter name of KDC_PARTITION (Default is: null):

Configure connection for a secondary TEMS? [1=YES, 2=NO] (Default is: 2):
Enter Optional Primary Network Name or 0 for "none" (Default is: 0):
Agent configuration completed...
rhea00b02 #
For WebSphere Application Server deployments, you do not need to create multiple sub nodes. The eXtreme Scale agent connects to the node agent to gather all the information from application servers for which it is responsible.
SECTION=CAT signifies a catalog service line whereas SECTION=OGS signifies an eXtreme Scale server configuration line.
Configure the eXtreme Scale servers.
When eXtreme Scale container servers are started, without specifying the -JMXServicePort argument, an MBean server is assigned a dynamic port. The agent needs to know in advance with which JMX port to communicate. The agent does not work with dynamic ports.
When you start the servers, specify the -JMXServicePort <port_number> argument when you start the eXtreme Scale server using the startOgServer.sh | .bat command. Running this command ensures that the JMX server within the process listens to a static pre-defined port.
For the previous examples in a UNIX installation, two eXtreme Scale servers need to be started with ports set:

"-JMXServicePort" "15000" (for rhea00b02_c0)
"-JMXServicePort" "15001" (for rhea00b02_c1)

Start the WebSphere eXtreme Scale agent.
Assuming the inst1 instance was created, as in the previous example, issue the following commands.

cd <ITM_install>/bin
itmcmd agent –o inst1 start xt

Stop the WebSphere eXtreme Scale agent.
Assuming “inst1” was the instance created, as in the previous example, issue the following commands.

cd <ITM_install>/bin
itmcmd agent –o inst1 stop xt
Results

After all servers are configured and started, MBeans data is displayed on the IBM Tivoli Portal console. Predefined workspaces show graphs and data metrics at each node level.
The following workspaces are defined: WebSphere eXtreme Scale Grid Servers node for all nodes monitored.

eXtreme Scale Transactions View
eXtreme Scale Primary Shard View
eXtreme Scale Memory View
eXtreme Scale ObjectMap View

You can also configure the own workspaces. For more information, see the information about customizing workspaces in the IBM Tivoli Monitoring Information Center.

Parent topic
Vendor tools

Related concepts

Vendor tools
Statistics overview

Related tasks

Monitor eXtreme Scale with Hyperic HQ

+
Search Tips | Advanced Search