Distributed Cache Metrics

The data published by this Metrics MBean comes from the Distributed Cache Microservice.
It monitors the data specified in the Attributes table.
The CPU usage data might not be available on all operating systems.
The default number of threads is between 8 and 256. You can change this value by modifying the microservice properties in its configuration file.
Because the microservice is used heavily, it is normal to see high numbers in transaction rate and count. It is important for the Elapsed Time to stay low to ensure system responsiveness.
The request and response sizes, transaction rate, and elapsed times are generally for information purposes only, but you can also use them to detect some abnormal behavior, such as unexpected changes in usage patterns. Baselines for these numbers should be created in production and measured against to detect deviations.

Advanced Property

Member of ClusterMetricsTask
You enable this bean by setting Distributed Cache Metrics MBean to true

The data published by the Distributed Cache Metrics MBean comes from the Distributed Cache Microservice. Publishing is disabled by default: you enable it by modifying settings in the configuration file and restarting the microservice. To enable publishing, modify the Distributed Cache Microservice configuration file as shown below, save the configuration file, and restart the microservice. Clustered applications can tolerate short connectivity disruptions with Distributed Cache Microservice: you can restart the microservice without having to restart the rest of the cluster.

Example (modified configuration values in bold):

#================================================================
# Counter information published to MQTT
#================================================================
[Counters]
# Collect counter information, see also ‘collectDebugCounters’
enabled = $S{Counters.enabled,true}
# Publish counter information to MQTT (enabled should be set to true)
publishEnabled = $S{Counters.publishEnabled,true}
# MQTT Broker to use for publishing counter information. Same value as used in clustered application’s configuration
broker = $E{MONITOR_MQTTBROKER,tcp://messagesight-host.com:1883}

Object Name

com.ibm.team.foundation.clustering:name=<<contextRoot>>,
 				type=distributedCacheHealthMetrics

Default Frequency of Publishing

60 Seconds

Attributes

HAProxy Statistics-Active Sessions

To be updated

Advanced Property

Member of ClusterMetricsTask
You enable this bean by setting HAProxy Metrics MBean to true
Also set Enable HAProxy counter collection task to true under HAProxyCounterCollectorTask.
Ensure the properties HAProxy statistics server host and HAProxy statistics server ports(9999) are set in the serviceability properties for HAProxyMetricsService.
The property HAProxy cluster backend is used to specify the HAProxy backend that describes cluster node servers. If left empty, the metrics service will attempt to determine the backend on its own.

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=HAProxy Statistics,
               facet=Active Sessions,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

HAProxy Statistics-Percentage of servers online

To be updated

Advanced Property

Member of ClusterMetricsTask
You enable this bean by setting HAProxy Metrics MBean to true
Also set Enable HAProxy counter collection task to true under HAProxyCounterCollectorTask.
Ensure the properties HAProxy statistics server host and HAProxy statistics server ports(9999) are set in the serviceability properties for HAProxyMetricsService.
The property HAProxy cluster backend is used to specify the HAProxy backend that describes cluster node servers. If left empty, the metrics service will attempt to determine the backend on its own.

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=HAProxy Statistics,
               facet=Percentage of servers online,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

MQTT Broker Resource Metrics

This bean provides memory information about the message broker server. This data is a shared metric: it represents resource use by the message broker itself, not by a separate node or cluster.

Advanced Property

Member of ClusterMetricsTask
You enable this bean by setting Enable MQTT Broker Metrics MBean to true

Object Name

com.ibm.team.foundation.clustering:name=ccm,
 				type=MQTTBrokerResourceMetrics

Default Frequency of Publishing

30 Seconds

Attributes

Cluster Member Information

This publishes the basic node information for each node in the cluster and also the node state.

Advanced Property

Member of CommonMetricsCollectorTask
You enable this bean by setting Enable Cluster Metrics MBean to true

Object Name

com.ibm.team.foundation.clustermembers:name=<<contextRoot>>,
 				type=clusterMemberDataMetrics,
 				nodeId=*

Default Frequency of Publishing

60 minutes

Attributes

Contributor Information

This publishes the number of active and archived users in the repository. This is useful to understand the active registered users.

Advanced Property

Member of CommonMetricsCollectorTask
You enable this bean by setting Enable Contributor Metrics MBean to true

Object Name

com.ibm.team.foundation.contributors:name=<<contextRoot>>,
 				type=contributorMetrics

Default Frequency of Publishing

60 minutes

Attributes

Project Area Summary Information

This publishes the total count project areas for the application and how many of them that are archived or not.

Advanced Property

Member of CommonMetricsCollectorTask
You enable this bean by setting Enable Projects Metrics MBean to true

Object Name

com.ibm.team.foundation.projectarea:name=<<contextRoot>>,
 				type=projectSummaryMetrics

Default Frequency of Publishing

60 minutes

Attributes

Diagnostics

This provides the results of the server diagnostics which by default runs every 70 minutes. This is useful to track the status of the periodic execution of server diagnostics.

Advanced Property

Member of DiagnosticsMetricsTask
You enable this bean by setting Enable Diagnostic Metrics Mbean to true

Object Name

com.ibm.team.foundation.diagnostic:name=<<contextRoot>>, 
               type=diagnosticMetrics,
               testId=*

Default Frequency of Publishing

70 Minutes

Attributes

Full Text Index Information

This provides the index size and index location information for the full text lucene index used by RTC and RQM. This is useful to track the size of the lucene index.

Advanced Property

Member of FullTextIndexDataCollectorTask
You enable this bean by setting Enable Full Text Index Data Metrics MBean to true.

Object Name

com.ibm.team.foundation.fulltextindexing:name=<<contextRoot>>,
  			type=richTextIndexDataMetrics

Default Frequency of Publishing

60 Minutes

Attributes

Distributed Cache Microservice online status-Downtime Counts

This bean monitors the number of times the Distributed Cache Microservice is unable to service a request. The microservice is a critical part of the clustered ecosystem and must be online.

Advanced Property

Member of HighFrequencyMetricsClusterScopedTask
You enable this bean by setting Distributed Cache Microservice online status MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Distributed Cache Microservice Status,
               facet=Downtime counts,
               counterName=Failed Connections

Default Frequency of Publishing

15 minutes

Attributes

Active Services

This is all the active services currently running in the server. Each service provides information like service name, requested user, start time and duration, and start time. This is useful to understand the standard patterns of low level service activity in a production system. Helps to understand the unique set of users currently working in the system.

Advanced Property

Member of HighFrequencyMetricsNodeScopedTask
You enable this bean by setting Enable Active Services MBean to true
To enable reporting of the stack trace associated with the active service set Enable Stack Trace to true
The property Threshold Execution Time is used to specify the threshold execution time in millisecs to be used to identify active services that exceed their execution time

Object Name

com.ibm.team.foundation.activeservices:name=<<contextRoot>>,
 				type=activeServicesMetrics,
 				serviceName=*

Default Frequency of Publishing

30 Seconds

Attributes

Active Services Summary

This is a summary of the total count of active services running in the system. This provides information like total count, CPU ratio and services that have exceeded duration thresholds. This is useful to understand the active services that are long running. Helps also to understand if the system specifications are adequate to meet the user load.

Advanced Property

Member of HighFrequencyMetricsNodeScopedTask
You enable this bean by setting Enable Active Services MBean to true

Object Name

com.ibm.team.foundation.activeservices:name=<<contextRoot>>, 
  			    type=activeServicesSummaryMetrics

Default Frequency of Publishing

30 Seconds

Attributes

MQTT Broker Subscription Metrics

This bean reports subscriptions where buffering occurs. The number of subscriptions to monitor is configurable. Multiple clustered applications can use a single MQTT broker, and the information contains enough details to identify which cluster (application instance) each subscription belongs to.
If no subscriptions are experiencing buffering, the subscriptions monitoring MBean does not report anything. A node only reports its own subscription, it does not report those created by other nodes. As a result, if a node goes offline without unsubscribing, for example, if the server process fails, or the machine is rebooted, the messages sent to that node are buffered but not reported by this bean. The bean only reports buffering for the node that is online but that experiences some sort of slowdown or trouble.
Buffering indicates that the application in this node is incapable of processing messages quickly. This issue might require tuning the system characteristics of the node or increasing the thread pools for message handling.

Advanced Property

Member of HighFrequencyMetricsNodeScopedTask
You enable this bean by setting Enable MQTT Broker Metrics MBean to true

Object Name

com.ibm.team.foundation.clustering:name=ccm,
 				type=MQTTBrokerSubscriptionMetrics

Default Frequency of Publishing

30 Seconds

Attributes

JFS Index Information

This provides the results of the server diagnostics which by default runs every 70 minutes. This is useful to track the status of the periodic execution of server This provides the index size and index queue information for the rdf and text index used by DNG and DM. Index information is provided for RDF Live, RDF History, Text Live and Text History indices. This is useful to track the size of the index and indirectly help with determining the optimal RAM and JVM Heap memory for the system.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Index Data Metrics MBean to true

Object Name

com.ibm.team.foundation.jfsindexing:name=<<contextRoot>>,
 				type=jfsIndexDataMetrics,
 				indexname=*

Default Frequency of Publishing

60 Minutes

Attributes

Local configuration management cache statistics-Cache hit ratio

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. Other facets are Entry added to cache, Entry removed from cache, Entry found in cache, Entry not found in cache, Entry replaced in cache and Entry garbage collected from cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Cache hit ratio as a percentage,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry added to cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95% . This facet highlights the entries added to the cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry added to cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry found in cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. This facet highlights the entries found in cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry found in cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry garbage collected from cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. This facet highlights the entries garbage collected from cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry garbage collected from cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry not found in cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. This facet highlights the entries not found in cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry not found in cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry removed from cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. This facet highlights the entries removed from cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry removed from cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Entry replaced in cache

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%. This facet highlights the entries replaced in cache.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Entry replaced in cache,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management cache statistics-Time for computing a value in ms

This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95% . This facet highlights the average time to compute a value in ms.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Cache Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt cache statistics,
               facet=Time for computing a value in ms,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Local configuration management service statistics-Elapsed time in milliseconds

This helps with monitoring the average execution time of the different local configuration management service API for DNG and DM. This includes but not limited to operations like creating a changeset, creating a stream, creating a baseline, committing a changeset etc.

Advanced Property

Member of IndexDataCollectorTask
You enable this bean by setting Enable Local Versioning Service Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=local config mgmt service,
               facet=Elapsed time (in ms),
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Item Count Details

This 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.

Advanced Property

Member of ItemCountMetricsCollectorTask
You enable this bean by setting Enable Item Count Metrics Mbean to true

Object Name

com.ibm.team.foundation.itemcounts:name=<<contextRoot>>, 
  				type=itemCountMetrics,
  				type Name=*

Default Frequency of Publishing

1 Week

Attributes

Jena Metrics-Purged Transactions

Jena uses a single writer/many reader model, and writes to the index are stored temporarily in a journal file if there are reads in progress.This counter tracks the number of times the memory associated with obsolete journal entries was set free.

Advanced Property

Member of JenaMetricsUpdateTask
You enable this bean by setting Enable Compatible Client Logins MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Jena Metrics,
               facet=Purged Transactions,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Jena Metrics-Replay in Progress

The counter indicates whether Jena is replaying the journal into the main database.Jena uses a single writer/many reader model, and writes to the index are stored temporarily in a journal file if there are reads in progress.This is how Jena maintains transactional integrity.The journal is written to the main database once all read activity completes.
In cases where there a long reads or there is high concurrency so that the reads are often overlapping, the journal can build up to a very large size and it can then cause the system to appear hung for many minutes while the journal replays.The metric indicates whether the Jena read/write bottleneck is happening, and how severe it is.

Advanced Property

Member of JenaMetricsUpdateTask
You enable this bean by setting Enable High Frequency Jena Metrics Collection to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Jena Metrics,
               facet=Replay In Progress,
               counterName=*

Default Frequency of Publishing

60 seconds

Attributes

Client compatibility with server statistics-Compatible client logins

This facet captures the number of login attempts from different versions of the client.

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable Compatible Client Logins MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Compatible client logins,
               facet=Number of logins,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Floating license consumption statistics-Concurrent use

This facet captures the floating license consumption from the servers

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable License Consumption Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Floating license concurrent use,
               facet=All servers,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Floating license consumption statistics-License Denials

This facet captures the floating license denials from the server.

NOTE: This Mbean does not appear until you have any license denials.

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable License Consumption Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Floating license denials,
               facet=All servers,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Floating license consumption statistics-License checkout time

This facet captures the floating license checkout time from the servers.

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable License Consumption Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Floating license checkout time,
               facet=All servers,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Token License consumption statistics-Concurrent use

This facet captures the token license consumption from the servers.

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable License Consumption Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=License token use,
               facet=All servers,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Token License consumption statistics-License Denials

This facet captures the token license denials from the providers.

NOTE: This Mbean does not appear until you have any license denials.

Advanced Property

Member of LicenseMetricsCollectorTask
You enable this bean by setting Enable License Consumption Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=License token provider denials,
               facet=All servers,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Asynchronous Tasks Elapsed Time

This is useful to track the average response time for background tasks and help with tuning the frequency of these and also monitor the degradation in their response time.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Async Task Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=asynchronoustasks,
               facet=elapsed time in seconds,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Asynchronous Tasks Queued Count

This is useful to track the backlog of the background tasks being queued up.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Async Task Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=asynchronoustasks,
               facet=queuedcount,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Expensive Scenario Details

This will publish details about the active and completed resource intensive scenarios in the system. This is useful to understand how the resource intensive scenarios are performing and understand what are the active scenarios at any given point in time. It also gives details about the user who requested the scenario.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Scenario Details MBean to true

Object Name

com.ibm.team.foundation.scenarios:name=<<contextRoot>>,
 				type=expensiveScenarioDetailsMetrics,
 				scenarioNameAndId=*

Default Frequency of Publishing

15 minutes

Attributes

JDBC Connection Pool Active Connections

This is useful to understand the sizing for the JDBC pools and if these pool sizes are correctly set for the current concurrency level of the system. If the size is small then higher concurrency will result in operations waiting and is the size is too big then system resources are consumed even though the load does not exist. The different facets are active connections, usage percentage, queue length and wait time.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=active connections,
               counterName=JDBC connection pool

Default Frequency of Publishing

15 minutes

Attributes

JDBC Connection Pool Queue Length

This is useful to understand the sizing for the JDBC pools and if these pool sizes are correctly set for the current concurrency level of the system. This facet highlights the size of the queue of pending connection requests.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=queue length,
               counterName=JDBC connection pool

Default Frequency of Publishing

15 minutes

Attributes

JDBC Connection Pool Usage Percentage

This is useful to understand the sizing for the JDBC pools and if these pool sizes are correctly set for the current concurrency level of the system. If the size is small then higher concurrency will result in operations waiting and is the size is too big then system resources are consumed even though the load does not exist. The different facets are active connections, usage percentage, queue length and wait time.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=usage percentage,
               counterName=JDBC connection pool

Default Frequency of Publishing

15 minutes

Attributes

JDBC Connection Pool Wait Time in milliseconds

This is useful to understand the sizing for the JDBC pools and if these pool sizes are correctly set for the current concurrency level of the system. This facet highlights the size of the queue of pending connection requests.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=wait time in ms,
               counterName=JDBC connection pool

Default Frequency of Publishing

15 minutes

Attributes

Log Events

This provides all the errors and warnings from the log files and for each log entry provides additional contextual information like userd id, active configuration, servlet request URL etc. This is useful to understand error log entries occurring in the system when other aspects of the system are misbehaving. This provides a maximum of 1000 entries during the collection interval.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Error Details Mbean to true

Object Name

com.ibm.team.foundation.logevents:name=<<contextRoot>>,
 				type=logEventDetailsMetrics,
 				errorNameAndId=*

Default Frequency of Publishing

15 minutes

Attributes

RDB Mediator Connection Pool Active Connections

This is useful to understand the sizing for the RDB mediator pools and if these pool sizes are correctly set for the current concurrency level of the system. If the size is small then higher concurrency will result in operations waiting and is the size is too big then system resources are consumed even though the load does not exist. The different facets are active connections, usage percentage, queue length and wait time.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=active connections,
               counterName=RDB mediator pool

Default Frequency of Publishing

15 minutes

Attributes

RDB Mediator Connection Pool Queue Length

This is useful to understand the sizing for the RDB mediator pools and if these pool sizes are correctly set for the current concurrency level of the system. This facet highlights the size of the queue of pending connection requests.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=queue length,
               counterName=RDB mediator pool

Default Frequency of Publishing

15 minutes

Attributes

RDB Mediator Pool Usage Percentage

This is useful to understand the sizing for the RDB mediator pools and if these pool sizes are correctly set for the current concurrency level of the system. If the size is small then higher concurrency will result in operations waiting and is the size is too big then system resources are consumed even though the load does not exist. The different facets are active connections, usage percentage, queue length and wait time.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=usage percentage,
               counterName=RDB mediator pool

Default Frequency of Publishing

15 minutes

Attributes

RDB Mediator Pool Wait Time in milliseconds

This is useful to understand the sizing for the RDB mediator pools and if these pool sizes are correctly set for the current concurrency level of the system. This facet highlights the size of the queue of pending connection requests.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Resource Usage MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=resource usage,
               facet=wait time in ms,
               counterName=RDB mediator pool

Default Frequency of Publishing

15 minutes

Attributes

Resource Intensive Scenarios-Elapsed time in milliseconds

This provides the counts and average response time for each of the resource intensive scenarios in the system. This is useful to understand how the resource intensive scenarios are performing and track any degradation in their response times.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Scenario Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=scenarios,
               facet=elapsed time in millisecs,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Resource Intensive Scenarios-Summary Elapsed time in milliseconds

This provides the counts and average response time for all the resource intensive scenarios in the system during the collection interval. This is useful to understand how the resource intensive scenarios are performing and track any degradation in their response times.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Scenario Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=scenariosSummary,
               facet=elapsed time in millisecs,
               counterName=summary

Default Frequency of Publishing

15 minutes

Attributes

Server Information

This publishes the server health information including memory usage, DB ping time and status on services and DB connections. This is useful to understand how the server is performing. Most important attribute is the dbPingTime. If the latency between server and DB gets worse it will impact the almost every use case in the product.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Server Metrics MBean to true

Object Name

com.ibm.team.foundation.server:name=<<contextRoot>>,
 				type=serverMetrics

Default Frequency of Publishing

15 minutes

Attributes

Transaction cache statistics-Number of entries added

This provides the transaction cache(s) operation metrics. This provides counts for the following operations on ITEM currents and ITEM state caches. This facet highlights the number of entries added to the cache.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Item Cache Summary Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Item Cache Summary,
               facet=added,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Transaction cache statistics-Number of entries auto updated

This provides the transaction cache(s) operation metrics. This provides counts for the following operations on ITEM currents and ITEM state caches. This facet highlights the number of entires that were updated in the cache.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Item Cache Summary Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Item Cache Summary,
               facet=autoUpdated,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Transaction cache statistics-Number of hits

This provides the transaction cache(s) operation metrics. This provides counts for the following operations on ITEM currents and ITEM state caches. The facets are added, misses, invalidated, hits and autoupdated. This is useful to understand how the caches are performing. In a production environment the hit ratio of the caches should be greater than 95%.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Item Cache Summary Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Item Cache Summary,
               facet=hits,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Transaction cache statistics-Number of invalidations

This provides the transaction cache(s) operation metrics. This provides counts for the following operations on ITEM currents and ITEM state caches. This facet highlights the number of invalidations from the cache.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Item Cache Summary Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Item Cache Summary,
               facet=invalidated,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Transaction cache statistics-Number of misses

This provides the transaction cache(s) operation metrics. This provides counts for the following operations on ITEM currents and ITEM state caches. This facet highlights the number of misses from the cache.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Item Cache Summary Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=Item Cache Summary,
               facet=misses,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Web Service Statistics-Bytes received from client

These are useful to track the average request pay load and response pay load for web services and watch for large payloads that may affect the network I/O.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Web Service Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=web service,
               facet=bytes received from client,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Web Service Statistics-Bytes sent to client

These are useful to track the average request pay load and response pay load for web services and watch for large payloads that may affect the network I/O.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Web Service Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=web service,
               facet=bytes sent to client,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Web Service Statistics-Elapsed time in seconds

This is useful to track the average response time for web services and watch for degradations.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Web Service Metrics MBean to true

Object Name

com.ibm.team.foundation.counters:name=<<contextRoot>>, 
               type=counterMetrics, 
               group=web service,
               facet=elapsed time in secs,
               counterName=*

Default Frequency of Publishing

15 minutes

Attributes

Web Services Statistics Summary Over Collection Intervals

This bean captures the summary information over collection intervals. The summary includes total count, average over interval, max over interval, transaction rate, the total value over interval etc. The summary bean is create by facet and within each facet you can get a summary by component.

Advanced Property

Member of MetricsCollectorTask
You enable this bean by setting Enable Web Service Metrics MBean to true

Object Name

com.ibm.team.foundation.webservices:name=<<contextRoot>>,
 				type=webServicesSummaryMetrics,
 				facet=*,
 				component=*

Default Frequency of Publishing

15 minutes

Attributes

MQTT service metrics

This bean provides specific information about the MQTT client that each node uses to communicate with IBM IoT MessageSight. This is not a comprehensive list of managed beans available from IBM IoT MessageSight, it is just the beans recommended for monitoring and alerting.
The MQTT service provides many different counters about its performance and states, but this information is summarized as just two values. The values provide the overall picture about sending and processing MQTT messages. In a well-tuned, well-functioning system, the success ratio should be 100%.
The number of threads should never grow uncontrollably. The default maximum is set to 200 threads, and should warn at 80% or 160 threads, and alert at 90% or 180 threads. If you continue to run out of threads, the administrator can increase the default maximum number.
The success indicator for the send rate can signal problems with the message broker or issues with network connectivity. While the MQTT service can reconnect and resend messages, it is important to understand why this metric shows a degradation.
The thread pool used by the MQTT service adjusts its size based on the volume of the incoming messages, and increases above the configured size, but only temporarily. When the thread pool size reaches the configured maximum, the service increases the thread pool to handle the increased traffic. As the volume of traffic drops, the thread pool resets its size to the default. Any thread pool value above the maximum indicates that the node is having difficulty processing or managing the volume of incoming messages. A value above the maximum indicates a problem or imbalance in the system.

Advanced Property

Member of NodeMetricsTask
You enable this bean by setting MQTT Service Metrics MBean to true

Object Name

com.ibm.team.foundation.clustering:name=<<contextRoot>>,
 				type=clusterHealthMetrics

Default Frequency of Publishing

60 Seconds

Attributes

Repotools Verify Information

This provides the results of the repository verifiers, which are used in the verify repotools infrastructure. This is useful to keep an eye on the data integrity of the production database. This is useful to track the status of the periodic execution of data verification rules against the repository.

Advanced Property

Member of OnlineVerifyMetricsTask
You enable this bean by setting Enable Online Verify Metrics MBean to true
The property Verification Level indicates the level of verification required; must be between 1 and 10. 1 indicates minimum verification and 10 indicates maximum verification.

Object Name

com.ibm.team.foundation.datavalidation:name=<<contextRoot>>, 
 				type=onlineVerifyMetrics, 
 				componentId=*

Default Frequency of Publishing

1 Week

Attributes

Project Area Information

This publishes the number of contributor, team, development lines, work items and attachments for each project area in the repository. Additionally it indicates if the project is archived or not. You can monitor these and also setup alerts if the usage patterns are not within normal parameters.It also provides if the project area has be opted in and provides configuration management metrics like number of component, streams, baselines etc.

Note Configuration management metrics are not applicable for GC and CCM application.

Advanced Property

Member of ProjectMetricsCollectorTask
You enable this bean by setting Enable Project Metrics MBean to true

Object Name

com.ibm.team.foundation.projectarea:name=<<contextRoot>>, 
 				type=projectMetrics, 
 				projectNameAndId=*

Default Frequency of Publishing

1 Week

Attributes

SQL Activity

This provides the SQL activity during the specified interval as a MBean. This is useful to understand the standard patterns of SQL activity in a production system. This is useful to track the counts and average response times for many SQL queries. Helps to understand the high runners and optimize them. Also helps to drive data partitioning decisions and preserve the query response time.

Advanced Property

Member of SQLActivityMetricsTask
You enable this bean by setting Enable SQL Activity Metrics MBean to true
The property Duration for capturing SQL activity indicates the duration for capturing SQL activity; must be between 1 and 5 minutes.
To enable ordering the SQL results by average execution time instead of the default which is total execution time set Enable ordering the SQL results by average execution time to true.
The property Maximum number of SQL statements to report on indicates the maximum number of SQL statements to report on. This maximum is applied separately for reads and writes. Must be between 1 and 100.

Object Name

com.ibm.team.foundation.sqlactivity:name=<<contextRoot>>, 
  				type=sqlActivityMetrics, 
  				id=*

Default Frequency of Publishing

60 Minutes

Attributes

SQL Activity Summary

This provides the summary SQL activity during the specified interval as a MBean. This is useful to understand the standard patterns of SQL activity in a production system. This is useful to track the counts and average response times for many SQL queries by type. Helps to understand the high runners and optimize them. Also helps to drive data partitioning decisions and preserve the query response time

Advanced Property

Member of SQLActivityMetricsTask
You enable this bean by setting Enable SQL Activity Metrics MBean to true

Object Name

com.ibm.team.foundation.sqlactivity:name=<<contextRoot>>, 
  				type=sqlActivitySummaryMetrics, 
  				sqlStmtType=*

Default Frequency of Publishing

60 Minutes

Attributes

Active Service Counter Metrics MBean

Captures the response time for service methods

Advanced Property

Member of ServerActivityMetricsTask
You enable this bean by setting Enable Active Service Counter Metrics MBean to true

Object Name

com.ibm.team.foundation.counter:name=<<contextRoot>>,
 				type=counterMetrics,
 				group=activeServices,
 				facet=<<facet>>,
 				counterName=<<counterName>>

Default Frequency of Publishing

10 minutes

Attributes

Active Services Counter Summary Metrics

Captures the response time for service methods and reports by component and across all components

Advanced Property

Member of ServerActivityMetricsTask
You enable this bean by setting Enable Active Service Counter Metrics MBean to true

Object Name

com.ibm.team.foundation.counter:name=<<contextRoot>>,
 				type=activeServicesCounterSummaryMetrics,
 				group=activeServices,
 				facet=<<facet>>,
 				component=<<scenario>>

Default Frequency of Publishing

10 minutes

Attributes

Server Activity Summary Metrics MBean

Publish the server activity (active users count, active services count, etc.) during the specified interval as a MBean. This is useful to understand the usage and load patterns in a production system.

Advanced Property

Member of ServerActivityMetricsTask
You enable this bean by setting Enable Server Activity Metrics MBean to true
The property Filter users from Server Activity Metrics MBean can be used to specify a comma-separated list of users to filter out of active user counts in the Server Activity Metrics MBean.

Object Name

com.ibm.team.foundation.serveractivity:name=<<contextRoot>>, 
 				type=serverActivitySummaryMetrics

Default Frequency of Publishing

10 minutes

Attributes