r4 - 2020-06-02 - 15:17:54 - TimFeeneyYou are here: TWiki >  Deployment Web > DeploymentMonitoring > CLMServerMonitoring > CLMServerMonitoringAgent > CLMServerMonitoringCSMAgentSetup

CLM Server Monitoring Agent Setup (DEPRECATED: CLM Server Monitoring is no longer supported and was dropped in version 6.0.3.) todo.png

Authors: GeraldMitchell
Build basis: CLM 4.0.6 or higher, CSM Agent 5.0.1 or higher


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 This page is for the setup of
  • CLM Server Monitoring Agent 5.0.1 or higher


  • CLM Server to be monitored
    • Jazz Team Server, Rational Team Concert, Rational Quality Management from CLM 4.0.6 or higher Installation
    • WebSphere Application Server or 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. * CLM Server Monitoring Agent is installed in an Application Server and the application started. If this is not the case, start the process at: CSM Agent information. * CLM is running.

CLM Server Monitoring Agent Setup Wizard

  1. go to the CSM Agent setup wizard at https://csmagent.intranetsite.local:10443/csm/setup or equivalent address. Remember, this address should use the public URL you intend to use.
    1. Enter User ID ADMIN
    2. Enter Password ADMIN
  2. You must now choose between Express and Custom Setup. Use Express if you are doing an evaluation, otherwise consider Custom to configure a different Database Server and setup a Data Warehouse. Make your choice and click Next.
    1. If you chose Express setup
      1. IF this page has warning about your URI name, consider changing your CSM Agent URI as you would for any CLM application. Check that you understand and click next.
      2. Create the Administrator. Enter the User ID, Name, Password, Password, and eMail as requested. Click Next.
      3. Click Next and choose to receive CLM Server Monitoring license.
      4. Click finish.

CLM Server Monitoring Agent Configuration instructions

Adding Licenses

Possible Extra step: Receiving new licenses. See Technote 1694739 Errors "At least one of the Client Access Licenses has expired" and "there are no licenses available" reported when CLM Server Monitoring Early Access licenses have expired 5.0.1 and 5.0.2 started with evaluation licenses. If your license have expired,
  1. Retrieve the new licenses and place them on the client system where the browser has access.
  2. Go to https://localhost:10443/csm/admin#action=com.ibm.team.repository.admin.manageLicenses
  3. Click Add.. on the Client License Types.
  4. Find the new licenses on your client system. Choose the licenses file (which is possibly something like CSM_User_EA.jar).
  5. Click Next
  6. Accept the terms (if you determine you can do so after reading).
  7. Click Finish

Adding Users

Adding CLM Friends

A friend relationship needs to be established between the applications being monitored and the monitor agent to collect information from the monitors. In order for the CSM agent to be able to collect javacores and other artifacts that are a result of plug-in actions, the CSM Agent needs to log into the Application and fetch this information securely. To simplify this operation, a friend relationship needs to be established between the applications being monitored and the CSM agent. To do this we add the applications being monitored as friends, and in the case where no SSO is enabled identify a user in the CLM application who will act on behalf of the CSM agent.
  1. Go to the CSM Administration page at /admin and click "Friends (Outbound)" in the left hand menu. (/admin#action=com.ibm.team.repository.admin.friends) Then click the "Add..." link on the right.
  2. In the Add Friend dialog add the information as it applies the friend server you are adding:
    • Name: Any recognizable name
    • Root Services URI: /rootservices
    • OAuth secret: A secret/password used for this trust relationship (any value)
    • Re-type secret: Retype above entry
    • Trusted: Set to true
  3. Click "Create Friend"
    On successful completion the following message will appear then click next.
  4. Authorize the provisional key. Click "Grant access for the provisional key". You may be asked to log into the CLM application at this point in order to grant access.
  5. Approve the request when asked. The "Consumer Name" is what the CSM server will be recognized as in the consumer list.
  6. Once finished the friend will be added to Friends List:

Enable SSO between CSM and CLM

If SSO is not enabled between CSM and the CLM applications (most likely true),
  1. Login into the application friend we just added through and navigate to the administration interface at /admin. Go to "Consumers (Inbound)". The CSM server consumer we just added should be listed there. We want to add the user that the consumer (CSM) will use locally to fetch the Java cores. This user must be a Jazz Admin. Click the pencil beside the CSM consumer.
  2. Edit Consumer Key Properties and add the Jazz Admin user be selecting "Select User..."
    Selection_551.png The functional user should now be set:
    and the consumer user added to the consumer list entry on the consumer page.

Configuring the WAIT reporting tool

When Java cores are fetched several properties need to be specified in order for the Java cores to be uploaded to WAIT once the activity is complete. These properties can be specified in the /admin advanced properties page.
  • WAIT Server: The WAIT server to use for uploading the reports
  • WAIT Server Email: The email address used by the WAIT Server for generating the reports
  • WAIT Server User: Specified if the WAIT server is protected by a username
  • WAIT Server Password: Specified if the WAIT server is protected by a username
For more on WAIT, read Using WAIT in the CLM Server Monitoring Agent.

CLM Server Monitoring project creation

  1. Users can be created and assigned "CLM Server Monitoring - User (Early Access)" CALs. Ten licenses are included.
  2. Go to /admin#action=com.ibm.team.process.manageProjectAreas
  3. Click "Create a Project Area" and create a new project. Note most examples will use "CLM Server Monitoring" however if planning on multiple project areas, you may choose to name your project areas differently so that you may easily keep track of what a project area is used for monitoring.
  4. Click "Deploy Predefined Templates" and in the alert click OK.
    • At a minimum, you will need to add a Jazz Admin user to the project (for JMX Connection User) along with any other users who you want to have access.
  5. Click Save when the templates are deployed.
  6. You will need to add users as a Jazz Admin user to the project and as a Team member.
  7. Go to Administrators
  8. Add
  9. Type and select the user by name.
  10. Add
  11. Close.
  12. Go to Members
  13. Add
  14. Type and select the user by name.
  15. Add
  16. Close.
  17. Assign the "Team Member" role to any users assigned to the project.
    1. in the Members area between the check box and the user name there is a menu that allows selecting Process Roles...
    2. Select that option
    3. In the dialog click Team Member so that it is highlighted.
    4. Click Add
    5. Click "Save."
  18. Click "Save."

CLM Server Monitoring JMX connection setup

Depending on the application server you want to monitor, follow the instructions in the !WebSphere Application Server or the Tomcat section. (Where the CLM applications are installed).
  1. Go to https://<hostname.domain>:9443/csm/web/projects/CLM%20Server%20Monitoring#action=com.ibm.team.dashboard.viewDashboard to access the project you created.
  2. Select JMX Connections -> Create-> Create Connection.
Connecting to the CLM Application Server (JVM) with a JMX Connection
  1. Complete the connection information:
    • The connection ID: This must be a unique string or number. You cannot have two connections with the same ID.
    • The connection Name: This is optional but can help you find your connection in a list.
    • The connection Type: Choose !WebSphere if the application you are trying to monitor is deployed to WebSphere Application Server, and JSR160 for Tomcat. WARNING: only connect to WebSphere if also hosting CSM Agent on WebSphere.
    • NOTE: it is recommended to use the SOAP protocol for WebSphere.
    • Select the Jazz user that will be used to create problem records. The user must be assigned a CSM User CAL and be a Jazz Admin user
    • Select the Secure Connection check box if the JMX server on your application only accepts secure connections. If you select this check box, you also need to complete the User Name and Password fields. This is theApplication Server admin user name and password. NOTE: The Realm field is the authentication realm of the CLM application's application server. This can be found on the CLM application server WebSphere Integrated Solutions console in Global Security->Realm name. You can also find this value from JConsole login window (the first field).
    • Enter the Host Name and Port: This is the host name of the server to monitor and the port used by the JMX server. Use the value used for HOST and PORT from the JConsole script.
  2. Click "Save".

CLM Server Monitoring connection activation

To successfully activate a connection, you must first ensure that CLM Server Monitoring is enabled on the server that you want to monitor. See Jazz monitoring through JMX for details on how to enable JMX monitoring. To activate a connection, perform the following steps.
  1. Go to https://<hostname.domain>:9443/csm/web/projects/CLM%20Server%20Monitoring#action=com.ibm.team.server.monitoring.agent.jmx.viewConnections.
  2. Select JMX Connections -> Browse-> Connections.
  3. Click the connection to activate.
  4. Select the Activate check box and save your changes.
  5. If the connection is successfully activated, you see the list of available domains displayed in the Provided Domains section.

CLM Server Monitoring configuration

  1. Click the domain of the activated connection. Example: team.server./jazz@9443
  2. Ensure that the AllMonitorsEnabled and DiagnosticsEnabled check boxes are selected.
  3. Add rules, based on the example rules at CLMServerMonitoringRules.
    image below from CSM Agent 4.0.6. CSM Agent 5.0 and higher use a different format for rules. see CLMServerMonitoringRules.
  4. Click "Save".

CLM Server Monitoring threshold modification

  1. Navigate to one of the domains of the activated connection and click one of the monitors. Example: Request
  2. Enter a new value in the Threshold field and save your changes.

Related topics:
Using WAIT in the CLM Server Monitoring Agent

Related topics: Deployment web home, Deployment web home

External links:

Additional contributors: TWikiUser, TWikiUser

Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r4 < r3 < r2 < r1 | More topic actions
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.