CLM Server Monitoring Agent on Tomcat (DEPRECATED: CLM Server Monitoring is no longer supported and was dropped in version 6.0.3.)

Authors: Boris Kuschel (BorisKuschel) , Celso Gonzalez (CelsoGonzalez), Gerald Mitchell (GeraldMitchell)
Build basis: Collaborative Lifecycle Management CSM Agent 5.0.1 and above

Overview

Designed to monitor Collaborative Lifecycle Management deployments, the CLM Server Monitoring (CSM) Agent provides reports and visualizations to identify key problem areas related to product user activity and resource bottlenecks identified by the CLM Server Monitoring plug-in

Prerequisites

• CLM Server to be monitored
  • Jazz Team Server, Rational Team Concert, Rational Quality Management from CLM 4.0.6 or higher Installation
  • Apache Tomcat
    • • NOTE: Support for application server information during monitoring is not supported for Tomcat at this time. Tomcat must use the IBM JDK; the Oracle JDK is not currently supported for Tomcat.
      • Follow instructions for JMX for WAS: To enable JMX on WebSphere
      • Follow instructions for unsecured JMX for Apache Tomcat: To enable JMX on Tomcat
  • For Rational DOORS Next Generation support, CLM must be at least version 5.0.1
  • See the CLM version specific documentation for other CLM and application-related requirements
  • The CLM Server to be monitored must be started, setup, and running with the plugin enabled to connect CLM Server Monitoring Agent to the CLM server. * CSM Agent
  • x86-64 hardware
  • Windows or Linux, 64-bit operating system
  • LAN connection to CLM 4.0.6 or higher Installation
  • Sizing requirements similar to the appropriate Jazz Team Server CLM version

Assumptions

This documentation page is for the embedded Tomcat that comes with the CSM version shipping with a CLM release. This documentation page assumes a Linux operating system.

Installation instructions

• CSM Agent is installed through the Installation Manager using the launch pad under custom installation for CLM 5.0.1 and above.

• • Hosting the CSM Agent embedded Apache Tomcat application server and the CLM application server on the same operating system instance requires an additional step due to the application servers being configured to use the same default listening port.
  • When using the CSM Agent embedded Tomcat application server on the same machine as a non-default Tomcat application server hosting CLM, you will need to check to see if you need to change the port of the CSM Agent Tomcat to prevent a listening port conflict (the default http port 9080 and https port 9443 will not conflict with CSM Agent embedded defaults.). Instructions can be found here .
• For CSM Agent embedded Apache Tomcat versions, the listening port is already configured to https 10443 by default and does not have conflict with the CLM embedded Tomcat nor default external application server listening ports. Please confirm that no other systems are running using the CSM embedded Tomcat.

• WARNING: The CLM Server Monitoring Agent should never be installed in the same Java Virtual Machine as any CLM application(s). This means that it should not be installed in the same application server instance.
  • Do NOT install the CSM Agent into the CLM embedded Tomcat instance.
  • CLM and CSM Agent can run on the same machine but not the same application server JVM instance, but should be considered carefully production deployments, as they will use the same memory, disk storage, and processing power and the CLM Server Monitoring Agent would then affect CLM performance as reflected in the CSM Agent.
  • CSM Agent does JVM monitoring and would itself affect the results, affecting performance like memory and processing usage conflicts, causing java cores to have additional impacts, disk space contention, and other possible side effects.
  • CSM Agent using the embedded Tomcat cannot monitor CLM on WebSphere in a manner that is supported. It is not a recommended configuration and is difficult to complete and maintain successfully. An idea of how to do is here.

Installation setup for CSM Agent using embedded Apache Tomcat to monitor a CLM installation running on Apache Tomcat

Overview of tasks

• Installation will occur through the Launchpad and Installation Manager.
• Make customizations to the Tomcat for configuration as needed for your environment.
• Start the Tomcat instance.
• Using a browser, go to the CSM Agent setup and complete.
• Configure the CSM Agent server as needed, with users, licenses, and properties, and assure the application is running smoothly.
• Create a new Server Monitoring Project, for the CLM deployments you want to monitor.
• Create JMX connections to the CLM servers within the projects.
• Configure the Monitor settings and rules.

Follow the steps for Generic CSM Agent Setup unless otherwise requested

Installation with Launchpad and Installation Manager

The embedded Tomcat application server will then be already installed and configured, and have the CSM Agent application, /csm, already installed.

Customizing Tomcat as needed.

Changing ports

TBD under Construction. (follow the steps as indicated for Tomcat in the Knowledge Center for your version of CSM and CLM. )

Configuring a separated Tomcat instance to have CSM installed

TBD under Construction. (follow the steps as indicated for Tomcat in the Knowledge Center for your version of CSM and CLM. )

Starting the Tomcat instance.

Starting the embedded Tomcat instance.

go to the installation directory on the CSM server, as indicated during Installation. We will assume /opt/IBM/CSMAgent was the install directory and we are using linux. from the command line, as an administrator of sufficient privileges to run the server, issue the command /opt/IBM/CSMAgent/server/startServer.sh & to start the embedded Tomcat and CSM Agent. you can see in the command window or the logs when the server has started /csm and has started the application server successfully.

Starting a separated Tomcat instance.

TBD under Construction. (follow the steps as indicated for Tomcat in the Knowledge Center for your version of CSM and CLM. )

CSM Agent setup wizard

Follow the general instructions for Generic CSM Agent Setup from browser.

Configure the CSM Agent server as needed

Follow the general instructions for CSM Agent application configuration.

Create a new Server Monitoring Project

Follow the general instructions for CSM Agent project creation.

Create JMX connections to the CLM servers within the projects.

Connecting to a CLM running on Tomcat

Use the JSR160RMI option when creating your CSM Agent JMX connection

Configure the Monitor settings and rules.

CSM Agent instructions for connection settings and rules in Monitors

Related topics:

External links:

• None

Additional contributors: None