CLMServerMonitoringAgent < Deployment

r42 - 2020-06-02 - 15:13:34 - TimFeeneyYou are here: TWiki >
Deployment Web > DeploymentMonitoring > CLMServerMonitoring > CLMServerMonitoringAgent
<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!! <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/new.png" alt="new.png" width="50" height="50" align="right"/> CLM Server Monitoring Agent %RED%(DEPRECATED: CLM Server Monitoring is no longer supported and was dropped in version 6.0.3.)%ENDCOLOR%
<img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/constantchange.png" alt="constantchange.png" width="50" height="50" align="right"/>
<!--img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/uc.png" alt="uc.png" width="50" height="50" align="right"-->
%DKGRAY% Authors: Boris Kuschel (Main.BorisKuschel) , Celso Gonzalez (Main.CelsoGonzalez), Gerald Mitchell (Main.GeraldMitchell)<br>
Build basis: Collaborative Lifecycle Management Server Monitoring Agent 5.0.1 and above
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>

<sticky><div style="margin:15px;"></sticky>

---++ Overview

*Note: The CLM Server Monitoring (CSM) Agent was deprecated in 6.0.3.*

#CLMServerMonitoringAgentOverview
   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 [[https://jazz.net/wiki/bin/view/Deployment/CLMServerMonitoringPlugin][CLM Server Monitoring plug-in]]

---++ Prerequisites
#CLMServerMonitoringAgentPrerequisites
   * 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: [[https://jazz.net/wiki/bin/view/Deployment/JazzMonitoringThroughJMX#Using_JSR160RMI_Connector_for_JC][To enable JMX on !WebSphere]]
            * Follow instructions for unsecured JMX for Apache Tomcat: [[https://jazz.net/wiki/bin/view/Deployment/JazzMonitoringThroughJMX#Option_1_JMX_not_secured][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
      * 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 

---++ Installation instructions
#CLMServerMonitoringAgentInstallation 
   * CLM Server Monitoring Agent is installed through the Installation Manager using the launch pad under custom installation for CLM 5.0.1 and above.
   * If you tried prior versions such as CLM Server Monitoring Agent Tech Preview versions 4.0.6 and 5.0.0, download the CLM 5.0.2 agent from jazz.net.
   * CLM Server Monitoring Agent embedded Apache Tomcat versions, the listening port is pre-configured to https 10443  by default and does not have conflict with the CLM embedded Tomcat nor default external application server listening ports.

   * 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 CLM Server Monitoring Agent into the CLM embedded Tomcat instance.
      * Do NOT install CLM Server Monitoring Agent into the same WebSphere application server cell as the CLM 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 javacores to have additional impacts, disk space contention, and other possible side effects.

---+++ Installation setup for CSM Agent using embedded Apache Tomcat to monitor a CLM installation  running on Apache Tomcat
   * Application server is already installed. 
   * Please proceed or make customizations as needed for any other of your application servers in your environment.
   * Continue to  CLM Server Monitoring Agent setup.

---+++ Installation setup for CSM Agent using embedded Apache Tomcat to monitor a CLM installation running on !WebSphere,

*WARNING:  this configuration is NOT SUPPORTED.  Please use CSM Agent on !WebSphere to communicate with a CLM on !WebSphere.*

   1. Linux: Change the CSM Agent {CSMInstall}/server/server.startup.sh to include the following lines
      Example:
      <verbatim>/opt/CSM/server/server.startup.sh</verbatim>
      After the _JAVA_OPTS="$JAVA_OPTS -Xmn512M"_ line:
      <verbatim>
      JAVA_OPTS="$JAVA_OPTS -Dcom.ibm.SSL.ConfigURL=file://"`pwd`"/tomcat/conf/ssl.client.props"
      JAVA_OPTS="$JAVA_OPTS -Dcom.ibm.CORBA.ConfigURL=file://"`pwd`"/tomcat/conf/sas.client.props"
      JAVA_OPTS="$JAVA_OPTS -Dcom.ibm.SOAP.ConfigURL=file://"`pwd`"/tomcat/conf/soap.client.props"
      JAVA_OPTS="$JAVA_OPTS -Dcom.ibm.IPC.ConfigURL=file://"`pwd`"/tomcat/conf/ipc.client.props"
      JAVA_OPTS="$JAVA_OPTS -Djava.security.auth.login.config=file://"`pwd`"/tomcat/conf/wsjaas.conf"
      JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.keyStoreType=PKCS12 -Djavax.net.ssl.keyStore="`pwd`"/tomcat/etc/key.p12 -Djavax.net.ssl.keyStorePassword=WebAS"
      JAVA_OPTS="$JAVA_OPTS -Djavax.net.ssl.trustStoreType=PKCS12 -Djavax.net.ssl.trustStore="`pwd`"/tomcat/etc/trust.p12 -Djavax.net.ssl.trustStorePassword=WebAS"
      </verbatim>
   1. Windows: Change the CSM Agent {CSMInstall}\server\server.startup.bat to include the following lines
      Example:
      <verbatim>C:\CSM\server\server.startup.bat</verbatim>
      After the _set JAVA_OPTS=%JAVA_OPTS% -Xmn512M_ line:
      <verbatim>
      set JAVA_OPTS=%JAVA_OPTS% -Dcom.ibm.SSL.ConfigURL=file:///%PATH_URL%tomcat/conf/ssl.client.props
      set JAVA_OPTS=%JAVA_OPTS% -Dcom.ibm.CORBA.ConfigURL=file:///%PATH_URL%tomcat/conf/sas.client.props    
      set JAVA_OPTS=%JAVA_OPTS% -Dcom.ibm.SOAP.ConfigURL=file:///%PATH_URL%tomcat/conf/soap.client.props
      set JAVA_OPTS=%JAVA_OPTS% -Dcom.ibm.IPC.ConfigURL=file:///%PATH_URL%tomcat/conf/ipc.client.props
      set JAVA_OPTS=%JAVA_OPTS% -Djava.security.auth.login.config=file:///%PATH_URL%tomcat/conf/wsjaas.conf
      set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.keyStoreType=PKCS12 -Djavax.net.ssl.keyStore="%PATH_URL%tomcat/etc/key.p12 -Djavax.net.ssl.keyStorePassword=WebAS
      set JAVA_OPTS=%JAVA_OPTS% -Djavax.net.ssl.trustStoreType=PKCS12 -Djavax.net.ssl.trustStore="%PATH_URL%tomcat/etc/trust.p12 -Djavax.net.ssl.trustStorePassword=WebAS
      </verbatim>
   1. Copy Files from !WebSphere Application Server
      Some files need to be copied from the CLM !WebSphere application server installation into the CSM Agent embedded tomcat directory. 
      If you use CSM_HOME the appropriate files should be copied from the !WebSphere Application Server that hosts the CLM application, so the file system on the CLM Server Monitoring host might look as follows. 
      WAS_HOME below refers to the installation directory and WAS_PROFILE_HOME to the profile directory of !WebSphere where these files can be found:
      (Copy the following using the appropriate operating system separators and semantics, and in binary if using file transfer protocols allow.)
      *  {WAS_HOME}/runtimes/ to {CSM_HOME}/server/tomcat/lib/
         *     com.ibm.ws.admin.client_{x.y.z}.jar
         *     com.ibm.ws.ejb.thinclient_{x.y.z.}jar
         *     com.ibm.ws.orb_{x.y.z}.jar 
         * Note: Make sure to change the version of the x.y.z format to match that of the origin WebSphere application server. Example: *com.ibm.ws.admin.client_8.0.0.jar, com.ibm.ws.ejb.thinclient_8.0.0.jar. and com.ibm.ws.orb_8.0.0.jar* for WebSphere Application Server 8.
      * {WAS_HOME}/plugins/ to {CSM_HOME}/server/tomcat/lib/
         *     javax.j2ee.management.jar
         *     com.ibm.ws.security.crypto.jar
      * {WAS_HOME}/etc/ to {CSM_HOME}/server/tomcat/etc/
         *    tmx4jTransform.jar
---++++ JConsole Setup *required
   !WebSphere JMX connections require certain JAR files and configuration files to be available in order to connect. It is recommended to try to connect to !WebSphere Application Server from the host where the agent is installed by using !JConsole. If !JConsole is unable to connect, the agent will not be able to either, because the same connection mechanism is used. Furthermore, running JConsole successfully will seed the trust store with the certificate avoiding having to use the keytool.   In the scripts, you should configure the following values (note of these values for future reference and configuration):
   * =JAVA_HOME=: Should point to an JDK as this is where JConsole executable is found. This is not included in the JRE
   * =CSM_HOME=: Should point to CSM Installation Directory. eg. /opt/CSM or C:\CSM
   * =HOST=: The CLM Application host to connect to (where !WebSphere Application Server is installed)
   * =PORT=:  Check the value of "BOOTSTRAP_ADDRESS" (usually either 9809 or 2809 by default), at *Servers > Server Types > App Servers > <your_server> > Ports* in the !WebSphere Application Server Admin console where the CLM application is installed on
   * Make sure to change the x.y.z version of the *com.ibm.ws.admin.client_8.0.0.jar, com.ibm.ws.ejb.thinclient_8.0.0.jar. and com.ibm.ws.orb_8.0.0.jar* files to match that of the !WebSphere Application Server installation where the files originate in the instructions
   * These scripts must be executed from $CSM_HOME/server/tomcat. It's best to copy the jconsole script into that directory and execute it from there.
      * Windows CMD:
      <verbatim>
      @echo off
      set JAVA_HOME=C:\Java
      set CSM_HOME=C:\CSM
      set HOST=clmjts.jazz.net
      set PORT=2809
      set CLASSPATH="%JAVA_HOME%\lib\jconsole.jar"
      set CLASSPATH=%CLASSPATH%;"%JAVA_HOME%\jre\lib\ibmpkcs.jar"
      set CLASSPATH=%CLASSPATH%;"%JAVA_HOME%\jre\lib\ext\ibmkeycert.jar"
      set CLASSPATH=%CLASSPATH%;"%JAVA_HOME%\jre\lib\ext\ibmjceprovider.jar"
      set CLASSPATH=%CLASSPATH%;"%CSM_HOME%\server\tomcat\lib\com.ibm.ws.admin.client_8.0.0.jar"   
      set CLASSPATH=%CLASSPATH%;"%CSM_HOME%\server\tomcat\lib\com.ibm.ws.ejb.thinclient_8.0.0.jar"
      set CLASSPATH=%CLASSPATH%;"%CSM_HOME%\server\tomcat\lib\com.ibm.ws.orb_8.0.0.jar"
      set CLASSPATH=%CLASSPATH%;"%CSM_HOME%\server\tomcat\lib\javax.j2ee.management.jar"
      
      "%JAVA_HOME%\bin\java" -classpath %CLASSPATH% -Dcom.ibm.IPC.ConfigURL=file:"%CSM_HOME%/server/tomcat/conf/ipc.client.props" -Dcom.ibm.CORBA.ConfigURL=file:"%CSM_HOME%/server/tomcat/conf/sas.client.props" -Dcom.ibm.SOAP.ConfigURL=file:"%CSM_HOME%/server/tomcat/conf/soap.client.props" -Dcom.ibm.SSL.ConfigURL=file:"%CSM_HOME%/server/tomcat/conf/ssl.client.props" sun.tools.jconsole.JConsole service:jmx:rmi://%HOST%:%PORT%/jndi/JMXConnector
      </verbatim>
      * UNIX BASH:
      <verbatim>
      #!/bin/bash
      JAVA_HOME=/opt/java
      CSM_HOME=/opt/CSM
      HOST=clmjts.jazz.net
      PORT=2809
      
      CLASSPATH=$JAVA_HOME/lib/jconsole.jar
      CLASSPATH=$CLASSPATH:$JAVA_HOME/jre/lib/ibmpkcs.jar  
      CLASSPATH=$CLASSPATH:$JAVA_HOME/jre/lib/ext/ibmkeycert.jar
      CLASSPATH=$CLASSPATH:$JAVA_HOME/jre/lib/ext/ibmjceprovider.jar 
      CLASSPATH=$CLASSPATH:$CSM_HOME/server/tomcat/lib/com.ibm.ws.admin.client_8.0.0.jar
      CLASSPATH=$CLASSPATH:$CSM_HOME/server/tomcat/lib/com.ibm.ws.ejb.thinclient_8.0.0.jar
      CLASSPATH=$CLASSPATH:$CSM_HOME/server/tomcat/lib/com.ibm.ws.orb_8.0.0.jar
      CLASSPATH=$CLASSPATH:$CSM_HOME/server/tomcat/lib/javax.j2ee.management.jar
      
      $JAVA_HOME/bin/java \
      	-classpath $CLASSPATH \
      	-Dcom.ibm.IPC.ConfigURL=file:$CSM_HOME/server/tomcat/conf/ipc.client.props \   
         	-Dcom.ibm.CORBA.ConfigURL=file:$CSM_HOME/server/tomcat/conf/sas.client.props \
            	-Dcom.ibm.SOAP.ConfigURL=file:$CSM_HOME/server/tomcat/conf/soap.client.props \
         	-Dcom.ibm.SSL.ConfigURL=file:$CSM_HOME/server/tomcat/conf/ssl.client.props \
      	sun.tools.jconsole.JConsole \
      	service:jmx:rmi://$HOST:$PORT/jndi/JMXConnector
      </verbatim>
---+++ Installation setup for CSM Agent on WebSphere to a CLM
   Follow the instructions for Install a CLM application on !WebSphere (JTS for example) found [[http://pic.dhe.ibm.com/infocenter/clmhelp/v4r0m6/topic/com.ibm.jazz.install.doc/topics/t_deploy_was.html][here]] . *The war for CSM is csm.war and context is /csm*

---++++ If connecting CSM Agent to a CLM application hosted on a different !WebSphere Application Server
   In addition this further step are required if the !WebSphere Application server hosting CSM is not in the same realm as the CLM applications they are monitoring (default for stand alone, non-ND WAS)
   1. In the !WebSphere Integrated Solutions console to  *Global Security-> Java Authentication and Authorization Service ->Application logins* 
   <br/><img src="%ATTACHURLPATH%/Selection_531.png" alt="Selection_531.png" /><br/>
   1. Click on *WSLogin* 
   <br/><img src="%ATTACHURLPATH%/Selection_532.png" alt="Selection_532.png" /><br/>
   1. Click on *com.ibm.ws.security.common.auth.module.WSLoginModuleImpl*
   1. Ensure that "Use login module proxy" is set and that use_realm_callback and use_appcontext_callback are set to true 
   <br/><img src="%ATTACHURLPATH%/Selection_533.png" alt="Selection_533.png" /><br/>
   1. You will also need to import the CLM Application Server's certificate into the node default trust store. To do this :
      * Go to the !WebSphere Integrated Solutions Console 
      * Navigate to Security->SSL certificate and key management->Key stores and certificates->NodeDefaultTrustStore 
      * Click on the Signer Certificate Link and click the "Retrieve from port" button. 
      * In the dialog that follows specify the https port of the CLM application we will be monitoring to retrieve the certificate (ex. 9443). 
         * Enter something recognizable for the name, such as "alias".
         * The fully qualified host name for the CLM Server should be entered in the "Host" field
         * After entering the Host, Port, and Alias fields, click on the "Retrieve signer information"

---++++ JConsole Setup
   In the scripts, you should configure the following values (note of these values for future reference and configuration):
   * =WAS_HOME=: Should point to an !WebSphere Home Directory eg. /opt/IBM/WebSphere/AppServer or C:\Progra~1\WebSphere\AppServer
   * =WAS_PROFILE_HOME=: Should point to WAS profile being used. eg. /opt/IBM/WebSphere/AppServer/profiles/AppSrv01 or C:\Progra~1\WebSphere\AppServer\profiles\AppSrv01
   * =HOST=: The CLM Application host to connect to (where !WebSphere Application Server is installed)
   * =PORT=:  Check the value of "BOOTSTRAP_ADDRESS" (usually either 9809 or 2809 by default), at *Servers > Server Types > App Servers > <your_server> > Ports* in the !WebSphere Application Server Admin console where the CLM application is installed on
   * Make sure to change the version of the *com.ibm.ws.admin.client_8.0.0.jar, com.ibm.ws.ejb.thinclient_8.0.0.jar. and com.ibm.ws.orb_8.0.0.jar* files to match that of the !WebSphere Application Server installation in the instructions
      * Windows CMD:
<verbatim>
      @echo off
      set WAS_HOME=C:\Progra~1\IBM\WebSphere\AppServer
      set WAS_PROFILE=AppSrv01
      set WAS_PROFILE_HOME=%WAS_HOME%\profiles\%WAS_PROFILE%

      set CLM_HOST=clm.jkebanking.net
      set CLM_PORT=2809
      set CLM_JMX_PROTOCOL=rmi

      call "%WAS_PROFILE_HOME%\bin\setupCmdLine.bat"

      set CLASSPATH="%JAVA_HOME%\lib\jconsole.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\java\lib\tools.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\java\jre\lib\ibmpkcs.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\java\jre\lib\ext\ibmkeycert.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\java\jre\lib\ext\ibmjceprovider.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\runtimes\com.ibm.ws.admin.client_8.5.0.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\runtimes\com.ibm.ws.ejb.thinclient_8.5.0.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\runtimes\com.ibm.ws.orb_8.5.0.jar"
      set CLASSPATH=%CLASSPATH%;"%WAS_HOME%\plugins\javax.j2ee.management.jar"

      "%JAVA_HOME%\bin\java" -classpath %CLASSPATH% -Dcom.ibm.IPC.ConfigURL=file:"%WAS_PROFILE_HOME%\properties\ipc.client.props" -Dcom.ibm.CORBA.ConfigURL=file:"%WAS_PROFILE_HOME%\properties\sas.client.props" -Dcom.ibm.SOAP.ConfigURL=file:"%WAS_PROFILE_HOME%\properties\soap.client.props" -Dcom.ibm.SSL.ConfigURL=file:"%WAS_PROFILE_HOME%\properties\ssl.client.props" sun.tools.jconsole.JConsole service:jmx:%CLM_JMX_PROTOCOL%://%CLM_HOST%:%CLM_PORT%/jndi/JMXConnector
</verbatim>
      * UNIX BASH:
      <verbatim>
      #!/bin/bash
      WAS_HOME=/opt/IBM/WebSphere/AppServer
      WAS_PROFILE=AppSrv01
      WAS_PROFILE_HOME=$WAS_HOME/profiles/$WAS_PROFILE

      CLM_HOST=clm.jkebanking.net
      CLM_PORT=2809
      CLM_JMX_PROTOCOL=rmi

      $WAS_PROFILE_HOME/bin/setupCmdLine.sh

      CLASSPATH=$JAVA_HOME/lib/jconsole.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/java/lib/tools.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/java/jre/lib/ibmpkcs.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/java/jre/lib/ext/ibmkeycert.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/java/jre/lib/ext/ibmjceprovider.jar 
      CLASSPATH=$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.admin.client_8.5.0.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.ejb.thinclient_8.5.0.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/runtimes/com.ibm.ws.orb_8.5.0.jar
      CLASSPATH=$CLASSPATH:$WAS_HOME/plugins/javax.j2ee.management.jar
      
      $JAVA_HOME/bin/java -classpath $CLASSPATH -Dcom.ibm.IPC.ConfigURL=file:$WAS_PROFILE_HOME/properties/ipc.client.props -Dcom.ibm.CORBA.ConfigURL=file:$WAS_PROFILE_HOME/properties/sas.client.props -Dcom.ibm.SOAP.ConfigURL=file:$WAS_PROFILE_HOME/properties/soap.client.props  -Dcom.ibm.SSL.ConfigURL=file:$WAS_PROFILE_HOME/properties/ssl.client.props sun.tools.jconsole.JConsole service:jmx:$CLM_JMX_PROTOCOL://$CLM_HOST:$CLM_PORT/jndi/JMXConnector
      </verbatim>
   
---++ CLM Server Monitoring Agent instructions
#CLMServerMonitoringAgentStartSetup #Setup_instructions
   1. Start the CSM agent Application Server and application.  
      * For CSM Agent on the embedded tomcat on Windows, execute the {CSM_HOME}\server\startup.server.bat script as an Administrator.
      * For CSM Agent on the embedded tomcat on Linux, execute the {CSM_HOME}/server/startup.server.sh script as an Administrator.
      * For CSM Agent on WebSphere Application Server make sure the application server is started and that the CSM application is started using the WebSphere Administration Console.
   1. Run the setup by using the public URL of CLM Server Monitoring. Example: https://<hostname.domain>:9443/csm/setup
      * Follow the instructions for [[http://pic.dhe.ibm.com/infocenter/clmhelp/v4r0m5/index.jsp?topic=%2Fcom.ibm.jazz.install.doc%2Ftopics%2Fc_post_install.html][Jazz Team Server]]
---++ CLMServerMonitoring Agent Configuration instructions
#CLMServerMonitoringAgentConfiguration
---+++ CLM Server Monitoring Agent 5.0 Tech Preview, 5.0.1, and higher first steps
---++++ Adding CLM Friends (5.0 and higher)
   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 <CSM Public base URI>/admin and click "Friends (Outbound)" in the left hand menu. Then click the "Add..." link on the right.
      <br/><img src="%ATTACHURLPATH%/Selection_543.png" alt="Selection_543.png" width="941" height="588" /><br/>
   1. In the Add Friend dialog add the information as it applies the friend server you are adding:
      * *Name:* Any recognizable name<br/>
      * *Root Services URI:* <CLM Application base URI>/rootservices
      * *OAuth secret:* A secret/password used for this trust relationship (any value)
      * *Re-type secret:* Retype above entry
      * *Trusted:* Set to true
   1. Click "Create Friend"
      <br/><img src="%ATTACHURLPATH%/Selection_544.png" alt="Selection_544.png" width="867" height="582" /><br/>
      On successful completion the following message will appear then click next.
      <br/><img src="%ATTACHURLPATH%/Selection_545.png" alt="Selection_545.png" width="584" height="29" /><br/>
   1.  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. 
      <br/><img src="%ATTACHURLPATH%/Selection_546.png" alt="Selection_546.png" width="867" height="312" /><br/>
   1. Approve the request when asked. The "Consumer Name" is what the CSM server will be recognized as in the consumer list.
      <br/><img src="%ATTACHURLPATH%/Selection_547.png" alt="Selection_547.png" width="760" height="261" /><br/>
   1. Once finished the friend will be added to Friends List:
      <br/><img src="%ATTACHURLPATH%/Selection_548.png" alt="Selection_548.png" width="702" height="212" /><br/>
---++++ 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 <CLM Application base URI>/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 javacores. This user must be a Jazz Admin. Click the pencil beside the CSM consumer.
      <br/><img src="%ATTACHURLPATH%/Selection_555.png" alt="Selection_555.png" width="936" height="682" /><br/>
   1. Edit Consumer Key Properties and add the Jazz Admin user be selecting "Select User..." <br />
      <img src="%ATTACHURLPATH%/Selection_551.png" alt="Selection_551.png" width="942" height="368" />
      The functional user should now be set:
      <br/><img src="%ATTACHURLPATH%/Selection_552.png" alt="Selection_552.png" width="586" height="26" /><br/>
      and the consumer user added to the consumer list entry on the consumer page.
      <br/><img src="%ATTACHURLPATH%/Selection_556.png" alt="Selection_556.png" width="635" height="30" /><br/>
---++++ Configuring the WAIT reporting tool  (5.0 and higher)
   When javacores are fetched several properties need to be specified in order for the javacores to be uploaded to WAIT once the activity is complete. These properties can be specified in the <CSM Public base URI>/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
      <br/><img src="%ATTACHURLPATH%/Selection_557.png" alt="Selection_557.png" width="963" height="612" /><br/>
---+++ CLM Server Monitoring steps, all versions
---++++ CLM Server Monitoring project creation
   1. Users can be created and assigned "CLM Server Monitoring - User (Early Access)" CALs. Ten licenses are included in the preview.
   1. Go to https://<hostname.domain>:9443/csm/admin#action=com.ibm.team.process.manageProjectAreas and click "Create a Project Area" called "CLM Server Monitoring."
      * You will need to deploy the process templates to get the CLM Server Monitoring template.
      * 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.
         <br/><img src="%ATTACHURLPATH%/Selection_507.png" alt="Selection_507.png" /><br/>
   1. Click "Save."
   1. Assign the "Team Member" role to any users assigned to the project. 
      <br/><img src="%ATTACHURLPATH%/Selection_508.png" alt="Selection_508.png" /><br/>
   1. 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.
   1. Select *JMX Connections -> Create-> Create Connection*.
      <br/><img src="%ATTACHURLPATH%/Create_JMX_Connection.png" alt="Create_JMX_Connection.png" width="736" height="355" /><br/>
---+++++ Connecting to WebSphere (JVM)
   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* because the application you are trying to monitor is deployed to !WebSphere Application Server.
      * 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 the !WebSphere Application Server admin user name and password. 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.
      * Use *JSR160RMI* (, *RMI* or *SOAP*) as the protocol. Ensure that whatever protocol is used, that the connector is enabled on the CLM application server's connector configuration as specified in [[https://jazz.net/wiki/bin/view/Deployment/JazzMonitoringThroughJMX#Using_JSR160RMI_Connector_for_JC][To enable JMX on !WebSphere]]
         <br/><img src="%ATTACHURLPATH%/Selection_534.png" alt="Selection_534.png" /><br/>
   1. Click "Save".
---+++++ Connecting to Apache Tomcat (JVM)
   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 *JSR160* because the application you are trying to monitor is deployed to Apache Tomcat.
      * 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 the check box, you also need to complete the *User Name* and *Password* fields.
      * Enter the *Host Name* and *Port*: This is the host name of the server to monitor and the port used by the JMX server (the default is 1099).
         <br/><img src="%ATTACHURLPATH%/Selection_535.png" alt="Selection_535.png" /><br/>
   1. 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 [[https://jazz.net/wiki/bin/view/Deployment/JazzMonitoringThroughJMX][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.
   1. Select *JMX Connections -> Browse-> Connections*.
      <br/><img src="%ATTACHURLPATH%/List_Connections.png" alt="List_Connections.png" width="687" height="338" /><br/>
   1. Click the connection to activate.
   1. Select the *Activate* check box and save your changes.
      <br/><img src="%ATTACHURLPATH%/Connection_Activation.png" alt="Connection_Activation.png" width="922" height="111" /><br/>
   1. If the connection is successfully activated, you see the list of available domains displayed in the *Provided Domains* section.
      <br/><img src="%ATTACHURLPATH%/Activated_Connection.png" alt="Activated_Connection.png" width="523" height="238" /><br/> 
---+++ CLM Server Monitoring configuration
   1. Click the domain of the activated connection. Example: team.server./jazz@9443
   1. Ensure that the !AllMonitorsEnabled and !DiagnosticsEnabled check boxes are selected.
   1. Add rules, based on the example rules  at [[https://jazz.net/wiki/bin/view/Deployment/CLMServerMonitoringRules][CLMServerMonitoringRules]].
      *Note: image below from CSM Agent 4.0.6. CSM Agent 5.0 and higher use a different format for rules. see [[https://jazz.net/wiki/bin/view/Deployment/CLMServerMonitoringRules][CLMServerMonitoringRules]].
      <br/><img src="%ATTACHURLPATH%/Selection_512.png" alt="Selection_512.png" /><br/>
   1. 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
      <br/><img src="%ATTACHURLPATH%/Open_Monitor.png" alt="Open_Monitor.png" width="1063" height="599" /><br/>
   1. Enter a new value in the *Threshold* field and save your changes.
      <br/><img src="%ATTACHURLPATH%/Update_Monitor.png" alt="Update_Monitor.png" width="1146" height="601" /><br/>
---++ Usage scenario
#CLMServerMonitoringAgentScenario
---+++++!! Related topics: 
[[UsingWAITInTheCLMServerMonitoringAgent][Using WAIT in the CLM Server Monitoring Agent]]

---+++++!! External links:          
   * None
---+++++!! Additional contributors: None
<sticky></div></sticky>
Attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	Activated_Connection.png	manage	4.3 K	2014-01-23 - 23:48	UnknownUser	Provided Domains when the connection is activated
png	Connection_Activation.png	manage	3.7 K	2014-01-23 - 23:48	UnknownUser	Activate a Connection
png	Connection_Editor.png	manage	30.8 K	2014-01-23 - 21:35	UnknownUser	Connection Editor
png	Create_JMX_Connection.png	manage	72.6 K	2014-01-23 - 20:59	UnknownUser	Create a JMX Connection action
png	List_Connections.png	manage	68.6 K	2014-01-23 - 23:36	UnknownUser	List Connections Action
png	Open_Monitor.png	manage	27.0 K	2014-01-24 - 04:25	UnknownUser	Provided Domain Monitors
png	Selection_505.png	manage	22.7 K	2014-01-23 - 15:19	UnknownUser	Enable ADMIN user
png	Selection_506.png	manage	39.7 K	2014-01-23 - 15:42	UnknownUser	ADMIN User Cal
png	Selection_507.png	manage	40.7 K	2014-01-23 - 15:55	UnknownUser	Create CLM Server Monitoring Project
png	Selection_508.png	manage	26.0 K	2014-01-23 - 21:18	UnknownUser	Add Role
png	Selection_510.png	manage	31.6 K	2014-01-23 - 23:54	UnknownUser	WAS Connection Dialog
png	Selection_512.png	manage	75.3 K	2014-01-24 - 00:41	UnknownUser	Domain Configuration
png	Selection_531.png	manage	51.1 K	2014-02-19 - 21:27	UnknownUser	Global Security JAAS
png	Selection_532.png	manage	18.9 K	2014-02-19 - 21:27	UnknownUser	WSLogin
png	Selection_533.png	manage	24.1 K	2014-02-19 - 21:28	UnknownUser	WSLogin JAAS Configuration
png	Selection_534.png	manage	38.8 K	2014-02-19 - 21:48	UnknownUser
png	Selection_535.png	manage	30.9 K	2014-02-19 - 22:01	UnknownUser
png	Selection_543.png	manage	95.1 K	2014-03-10 - 20:48	UnknownUser	Friends
png	Selection_544.png	manage	42.6 K	2014-03-10 - 20:48	UnknownUser	Add Friend
png	Selection_545.png	manage	4.0 K	2014-03-10 - 20:49	UnknownUser	Add Friend Success
png	Selection_546.png	manage	24.4 K	2014-03-10 - 20:49	UnknownUser	Authorize Provisional Key
png	Selection_547.png	manage	24.2 K	2014-03-10 - 20:50	UnknownUser	Authorize Provisional Key Request
png	Selection_548.png	manage	29.3 K	2014-03-10 - 20:51	UnknownUser	Friend Added to Friends List
png	Selection_551.png	manage	27.1 K	2014-03-10 - 20:53	UnknownUser	Edit Consumer Key Properties
png	Selection_552.png	manage	2.7 K	2014-03-10 - 20:53	UnknownUser	Functional User
png	Selection_555.png	manage	74.8 K	2014-03-10 - 20:52	UnknownUser	Consumers
png	Selection_556.png	manage	3.3 K	2014-03-10 - 20:52	UnknownUser	Consumer User Added
png	Selection_557.png	manage	55.2 K	2014-03-10 - 20:54	UnknownUser	WAIT Properties
png	Update_Monitor.png	manage	18.3 K	2014-01-24 - 04:26	UnknownUser	Modify Monitor Threshold
Deployment
Community information and contribution guidelines
Status icon key:
To do
Under construction
New
Updated
Constant change
None - stable page
Smaller versions of status icons for inline text:
Copyright © 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.