CLM606ServiceabilityComponentMBeanMapping < Deployment

r3 - 2019-03-07 - 15:14:22 - RalphSchoonYou are here: TWiki >

Deployment Web > DeploymentMonitoring > CLM606MXBeans > CLM606ServiceabilityComponentMBeanMapping

<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%">
---+!! CLM 6.0.6 Serviceability Component MBean Mapping <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/todo.png" alt="todo.png" width="50" height="50" align="right"> 
%DKGRAY% Authors: [[Main.RalphSchoon][Ralph Schoon]] <br>
Build basis: CLM 6.0.6
%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>

Following the documentation and articles around [[DeploymentMonitoring][CLM Monitoring]] and understanding how to change the configuration of the CLM products to enable data collection for specific MBeans can be challenging. For easier navigation see the attached [[%ATTACHURL%/CLM_Serviceability_Component_MBean_Mapping_V1_6_publish.pdf][attached CLM Serviceability Component MBean Mapping table]].

The table tries to provide a central place to look up information about MBeans and MBeans based monitoring in CLM. The table provides a simple way to find the names of the available MBeans that can be configured. It provides a mapping between the MBeans, the available tasks collecting the monitoring information, the advanced properties used to configure them and the Web Administration UI. The table also connects available documentation about monitoring tasks to the MBeans and the Administration aspect. Dependent on which information is available it can be used in various ways.

Please note that the UI and admin properties refers to RTC 6.0.6. The reference documentation for the Task Names with the document links refer to the documentation for 6.0.5. The differences should be very small. See [[CLM606MXBeans][CLM 6.0.6 Monitoring Managed Beans Reference]] for changes.

---++ How to find the information related to an MBean from article hints?

One challenge is to understand how to relate documentation such as article [[https://jazz.net/library/article/91590][CLM Monitoring]] and [[https://jazz.net/library/article/91971][Monitoring your Rational Team Concert cluster]] to the documentation available in [[CLMMonitoringMBeans][CLM Managed Beans Reference]].

As an example open in [[https://jazz.net/library/article/91971#cluster_member][Monitoring your Rational Team Concert cluster - Cluster member data metrics]]. See the line 

"To enable the Cluster Metrics MBean, set the *Enable Cluster Metrics MBean* property of CommonMetricsCollectorTask to true."  

The following questions come to mind:

   * Where in the administration UI is this done? 
   * Which teamserver.properties might be related to this MBean?
   * Which default collection frequency is set for this MBean?
   * Which detailed information about the related collection task and the MBean is available?

---+++ How can I find the administration UI ?

For the main applications the MBeans that are configurable in the Advanced Properties for the server. To find out more about how to administer this MBean use the key word *Cluster Metrics MBean* from the article and search the table. 

The text is found in the column _Bean Name_. To understand how the UI would look like for the *Cluster Metrics MBean*, follow the information to the right. Go to the _UI Screen Shot_ column. It shows the Advanced Properties UI section for the MBean. Use the MBean name to search the Browser window to locate the setting.
 
The row containing the highlighted *Cluster Metrics MBean* found in the advanced properties administration UI shows the entry to enable the data collection for the MBean found.

---+++ Which teamserver.properties advanced attribute ID is related to this MBean?

This is of interest if the teamserver properties are configured for automatic deployments. To locate the information use the key word *Cluster Metrics MBean* from the article and search the table. 

The Text is found in the column _Bean Name_. To understand how to enable data collection for the *Cluster Metrics MBean*, follow the information to the right. Go to the _Advanced Property_ column for the row found for the *Cluster Metrics MBean*. This entry contains the advanced properties ID for the MBean in this row. Set the value to true, to enable the data collection. For *Cluster Metrics MBean* set com.ibm.team.serviceability.CommonMetricsCollectorTask.enableClusterMemberDataMetricsMBean=true in the =teamserver.properties= of the application. 

---+++ Which detailed information about the related collection task and the MBean is available?

---++++ What is the default value and what is the range for this MBean?

In the next column to the right _Default_ see the default is false. In the column _Range_, see the valid values for the property. This is usually true/false to enable or disable data collection. 

---++++ What is the data collection frequency for this MBean?

Note that the row containing the found name *Cluster Metrics MBean* is in a section that shows two more MBean names and additional related rows. Go to the first row of the section to find how to control the data collection frequency for the MBeans mentioned in this section. The advanced property ID com.ibm.team.serviceability.CommonMetricsCollectorTask.fixedDelay is related to this task. The collection frequency is in seconds.  The default is 3600 seconds. Changing the value will impact all the MBeans of this section. 

---++++ Related properties?

Some collection tasks require additional properties to be set. The information about these properties can be found in the section found for the MBean.

---++ Which MBeans are available and how to configure them

To understand which MBeans are available, how to enable them and understand the purpose of the MBeans, use the column _Bean name_ to locate the available MBeans. The information available for configuring this MBean can be located to the right of the MBean name and in the section the MBean is located. 

Which detailed information can be found is explained above.

---++ More information contained in the table

   * Each section is usually related to advanced properties that have a common namespace. This can be found in the column _Advanced Property Namespace_. Note that the pattern is not always consistent.
   * Each section is usually related to one Task collecting the MBeans. The Task is another search key for the advanced properties administration UI and can be found in column _TaskID used in UI_.
   * The first column _Task name with Doc Link (6.0.5)_ contains a link to the detailed description for the task and the related MBeans. Currently the version is 6.0.5. the differences should be minor. 
   * A key explains the columns, shows a UI example and contains relevant links to articles and the [[DeploymentWebHome][Deployment Wiki]].

---+++++!! Related topics: 

   * [[CLMMonitoringMBeans][CLM Managed Beans Reference]]
   * [[CLM606MXBeans][CLM 6.0.6 Monitoring Managed Beans Reference]]
   * [[DeploymentWebHome][Deployment web home]]
   * [[https://jazz.net/library/article/91590][CLM Monitoring]]
   * [[https://jazz.net/library/article/91971][Monitoring your Rational Team Concert cluster]]


---+++++!! Additional contributors: [[Main.TimFeeney][Tim Feeney]]

<sticky></div></sticky>
   * [[%ATTACHURL%/CLM_Serviceability_Component_MBean_Mapping_V1_6_publish.pdf][CLM_Serviceability_Component_MBean_Mapping_V1_6_published.pdf]]: CLM Serviceability Component MBean Mapping V1.6 helps to connect the different related information sources for CLM Monitoring and MBeans.

Attachments

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
pdf	CLM_Serviceability_Component_MBean_Mapping_V1_6_publish.pdf	manage	321.1 K	2019-03-07 - 15:08	RalphSchoon	CLM Serviceability Component MBean Mapping V1.6 helps to connect the different related information sources for CLM Monitoring and MBeans.

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 IBM and non-IBM 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.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.