CollectingDataMetrics < Deployment

Engineering Lifecycle Management Wiki - Deployment
Community information and contribution guidelines
TWiki > Deployment Web > DeploymentMonitoring > JMXMBeans > MBeansUsage > CollectingDataMetrics
Revision 3 - 2020-07-22 - 16:29:22 - TimFeeney
<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 data related metrics using JMX MBeans  
%DKGRAY% Authors: Main.TimFeeney <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>

One element of sizing the servers for the IBM ELM solution is the current and projected data scale (along with data shape, user scale and workload). There are also recommended artifact limits to stay within to keep an application performing well. There are a few different MBeans that will help keep track of data counts.

---++ Item Count Details MBean

This bean will list several objects of various types (i.e. different typeName values), such as _com.ibm.team.workitem.Attachment_ when collected for the Engineering Workflow Management (EWM) application. Each object collected has several attributes with those of prime interest being:
   * __itemTypeName__ - the name of the type of item being counted, e.g. com.ibm.team.workitem.Attachment, com.ibm.team.workitem.WorkItem, com.ibm.team.vvc.ChangeSet
   * __noOfContents__ - how many items of this type exist in the application's repository
   * __totalSize__ - the total size in the application's repository for items of this type
   * __sizePercentage__ - the size of this item type as a percentage of all the other item types in the application's repository

A common use of this information is to see what is contributing to the size of a repository database. For the EWM application, workitem attachments often take up a lot of the space. This bean will help track growth of those items typically taking up most space in the repository. Strategies then can be put in place to reduce their size, such as use of the [[WorkitemAttachmentMigrationUtility][attachment migration utility]] to [[https://trfeeney.wordpress.com/2020/05/29/reduce-your-engineering-workflow-management-database-size-by-removing-orphaned-attachments/][remove orphaned attachments]].

Further, tracking the number of artifacts in a repository for some applications is important given some applications have known size limits. For example, the Engineering Test Management (ETM) application has been [[ELMLargeScaleAndPerformanceReportRelease701][tested with up to 15 million artifacts in v7.0.1]]. Tracking all the relevant item types that contribute to the [[ELMLargeScaleAndPerformanceReportRelease701#Data_volume_and_shape][overall ETM artifact count size]], would be advisable to ensure you stay within the limit and track your growth towards it. This allows you to be proactive in managing growth and taking appropriate actions, such as deploying another application server.

---++ Project Area Information MBean

Whereas the Item Count Details MBean provides data counts at the application repository level, the Project Area Information provides some details on the project areas of an application. There are several attributes of interest, but for purposes of tracking data counts relevant to sizing, consider the following (see the reference documentation for the full list).

   * __workitemCount__ - total number of workitems in an EWM project area
   * __attachmentCount__ - total number of workitem attachments in an EWM project area
   * __attachmentTotalLength__ - total size of workitem attachments in an EWM project area
   * __totalNoOfComponents__ - total number of components in a configuration management enabled project area
   * __totalNoOfStreams__ - total number of streams in a configuration management enabled project area
   * __totalNoOfBaselines__ - total number of baselines in a configuration management enabled project area
   * __rmArtifactCount__ - total number of artifacts in a configuration management enabled DOORS Next project area

There are no known limits for the different EWM data elements (work items, files, builds, etc.) in a project area, however you might find it useful to track which projects are most active and making use of workitems. Per the discussion on the Item Count Details MBean, tracking the size of attachments in a repository is important to help manage the overall EWM database size. Tracking _attachmentTotalLength_ in the Project Area Information MBean allows you to see which projects are the primary contributors to attachment storage.

In [[RequirementsManagement70Performance#DataLimits][7.0 performance: IBM Engineering Requirements Management DOORS Next]], there are recommended data limits for a project area, such as its total artifacts and components. These can be monitored with the _totalNoOfComponents_ and _rmArtifactCount_ attributes of this MBean. 

Note that collecting data for the Item Count Details MBean can be [[CLMExpensiveScenarios#Item_count_metrics][resource intensive]]; care should be taken to when it is scheduled and how frequent.

---++ DOORS Next MBeans

In 7.0, DOORS Next implemented several [[RDNG70Beans][MBeans]] to aid in tracking various data shapes at the repository level. At a minimum, plan to monitor these DOORS Next MBeans:
   * __TotalNumberOfArtifacts__ - total artifacts in a DOORS Next application repository 
   * __TotalNumberOfComponents__ - total components in a DOORS Next application repository 
   * __TotalNumberOfBaselines__ - total baseline configurations in a DOORS Next application repository 
   * __TotalNumberOfStreams__ - total stream configurations in a DOORS Next application repository 
   * __TotalNumberOfLinks__ - total links within and between components and projects in a DOORS Next application repository 

Each of these have their own _Value_ attribute that publishes the count for the data item it is tracking. Of these _TotalNumberOfArtifacts_ and _TotalNumberOfComponents_ have [[RequirementsManagement70Performance#Data_limits_in_7_0][published limits for 7.0]].

Note that calculation of the values for these DOORS Next MBeans can add substantial load on large repositories; care should be taken to when it is scheduled and how frequent.

---+++++!! External links:          

   * [[https://trfeeney.wordpress.com/2018/06/12/how-many-artifacts-do-i-have-in-my-jazz-application-repository/][How many artifacts do I have in my Jazz application repository?]]

<sticky></div></sticky>
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.