Global Configuration Management (GCM) application MBeans for ELM 7.x

In ELM 7.0, GCM introduced basic metrics and statistics on the usage of GCM to guide deployment, best practices and recommendations for usage. This information is available via a metrics page on the GCM UI and JMX MBeans visible through MBean Utilities or an enterprise monitoring tool.

Formal documentation of the GCM MBeans is not yet available. In the mean time, this page provides some temporary documentation for the MBeans. For more information, see 495434: Provide basic GC metrics which provided the original capability and 506795: document existing GCM metrics which is tracking the documentation to be provided.

The metrics are provided per project area and across all project areas (in same GCM repository). Types of metrics include:

• Size and composition of global configuration (GC) trees
• Number of global components and GCs (by type)
• Counts of GC, local configuration (LC), and external GC contributions

Advanced Property

There are two steps needed to provide regularly updated metrics via an MBean. First, the metrics need to be collected and second the metrics need to be published in the requisite MBean.

To enable periodic collection of the metrics, set "Enable periodic GC metrics collection" to true on the GCM Serviceability tab (https://hostname:port/gc/admin#action=com.ibm.team.repository.admin.serviceability) and set the collection frequency or schedule. Note that metrics collection can be invoked on demand as well from the Global Configuration Metrics page (https://hostname:port/gc/metrics) page. GC metrics data persists in the repository between restarts.

To enable publishing of the metrics to an MBean, set "Enable GC metrics MBean" to true on the GCM Serviceability tab and set the collection frequency or schedule. Note the default for this property is true. If metrics collection is disabled, the MBean will be populated with the metrics from the last collection, which may be nothing if the collection has never been run.

Object Name

com.ibm.team.gc.application:name=<<contextRoot>>,
  type=globalConfigurationsAndComponents,
  scope=projectArea,
  projectAreaName=<<projectAreaName>>,
  projectAreaUri=<<projectAreaUri>>

or

com.ibm.team.gc.application:name=<<contextRoot>>,
  type=globalConfigurationsAndComponents,
  scope=allActiveProjectAreas

Default Frequency

• 24 hours for metrics collection (com.ibm.team.gc.service.metrics.GcMetricsCollectorTask)
• 15 seconds before publication of saved GC metrics after startup (com.ibm.team.gc.service.metrics.GcMetricsPublishSavedMetricsOnStartupTask)

Attributes

The following is a sample list of GCM MBean attributes when scope=projectArea for a test project area called "JKE Banking (Global Configuration)"

The following is a sample list of GCM MBean attributes when scope=allActiveProjectAreas

Related topics: JMX MBeans for ELM application monitoring