CollectingETMRepositorySizeMetrics < Deployment

Engineering Lifecycle Management Wiki - Deployment

Community information and contribution guidelines

TWiki > Deployment Web > DeploymentMonitoring > JMXMBeans > MBeansUsage > CollectingETMRepositorySizeMetrics

Revision 3 - 2025-05-22 - 10:21:40 - Main.Mvalenta

<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%">
---+!! Collecting ETM repository size metrics in order to monitor growth
%DKGRAY% Authors: Authors: Main.MichaelValenta<br>
Build basis: 6.0.6.1 and later
%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>

On this page, we provide information on how you can monitor the growth of the data in the repository for the Engineering Test Management (ETM) application using MBeans. Although we will be presenting some information that is ETM specific, most of the information applies to other ELM applications as well.

The ELM MBeans are covered on the release related guides available on the page [[MBeansReference][Reference Guides for ELM JMX MBeans]]. Each guide has a link a zip archive containing an html page that describes the common MBeans provided by Foundation. For 7.1, the link to this document is [[https://jazz.net/wiki/pub/Deployment/MBeansReference71/commonApplicationMBeansDoc-7.1.zip][Common application MBeans (requires file download)]]. The _com.ibm.team.foundation.itemcounts_ MBean described in this document can be used to track the space used by various item types on the database. Over time, this MBean can be used to monitor the growth of the database.

---++ Item Count Details

The _com.ibm.team.foundation.itemcounts_ MBean provides information about each type of item in the repository and their counts in terms of number of states and the overall size of these items in relation to the total size. This is useful to understand the data growth in the system and also the breakdown between the different types of items. Sometimes items like attachments or build results may be growing at an alarming rate and tracking this metric can explain the reason for this growth. Added to this, increase in DB size during a period can also be explained by the items that were added during this period.

*Note:* This MBean is applicable for EWM, ETM, and DOORS Next.

---+++ Serviceability Property

To enable this MBean:

   * Go to the Servicability admin page (<server-url>/admin#action=com.ibm.team.repository.admin.serviceability)
   * Enable this bean by setting Enable Item Count Metrics Mbean to true
      * Member of ItemCountMetricsCollectorTask property group

---+++ Default Frequency of Publishing

The default frequency of publishing is 1 Week (604800 second) but this can be modified in the Serviceability section 

---+++ Object Name

Here is a list of the objects available from the item counts MBean for the main ETM items.

   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.execution.ExecutionElementResult
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.execution.ExecutionResult
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.execution.ExecutionResultGroup
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.execution.TestcaseExecutionRecord
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.execution.TestSuiteExecutionRecord
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.Attachment
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.ExecutionElement2
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.ManualExecutionScript
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.ManualExecutionScriptStepLookup
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.TestCase
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.TestPlan
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.TestSuite
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.VersionedExecutionScript
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.VersionedTestCase
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.VersionedTestPlan
   * com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.VersionedTestSuite

---+++ Attributes

The following screenshots show the attributes available for com.ibm.team.foundation.itemcounts:name=qm,type=itemCountMetrics,typeName=com.ibm.rqm.planning.TestCase

     <img src="%ATTACHURLPATH%/attributes2.png" alt="attributes2.png" width="1000" height="380" />

The main attributes of interest are:

   * itemTypeName - This is the name of the item type
   * noOfStates - This is total number of states that exists in the REPOSITORY.ITEM_STATES system table for this item type
   * statesSize - This is total size of all the states that exists in the REPOSITORY.ITEM_STATES system table for this item type in bytes
   * noOfContents - This is total number of content blobs that exists in the REPOSITORY.CONTENT_STORAGE system table for this item type
   * contentsSize - This is total size of content blobs that exists in the REPOSITORY.CONTENT_STORAGE system table for this item type in bytes
   * sizePercentage - This is percentage of the total size of this item type in relation to the total size of all item types together
   * totalSize - This is sum of all the content objects and state objects for this item type in bytes
   * totalAllSize - This is sum of all the content objects and state objects for all item types in bytes

---++ Use Repodebug to see MBean

To use repodebug to view the output of the bean, go to

   * <server-url>/repodebug/mxBeans
   * From the Domain dropdown choose: com.ibm.team.foundation.itemcounts
   * From the Type dropdown choose: ItemTypeMetrics
   * Click the Search button.

This will show a list of all available objects where each object is associated with a different item type. You can choose an object to see the metrics for the corresponding item type.

 <img src="%ATTACHURLPATH%/objects2.png" alt="objects2.png" width="1140" height="678" />

---+++++!! Related topics: [[MBeansReference71][JMX Application MBeans Reference Guide for ELM 7.1]]

   * [[CollectingDataMetrics][Collecting data related metrics using JMX MBeans]]

<sticky></div></sticky>

Attachments

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	attributes2.png	manage	96.5 K	2025-05-21 - 16:41	Mvalenta
png	objects2.png	manage	283.0 K	2025-05-21 - 16:36	Mvalenta

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.