Terracotta KPI Definitions
The KPIs in this section enable you to monitor a Terracotta Management Server and by extension, individual Terracotta servers.
| KPI Definition |
|---|
| com.softwareag.tc.connectiongroup |
| com.softwareag.tc.server |
| Terracotta Connection |
| Ehcache |
| TSA |
| TSA Server |
| CacheManager |
| Cache |
com.softwareag.tc.connectiongroup
This interface defines KPIs for Terracotta Server connection group components.
Discovery Mechanism
Automatically discovered via Terracotta server.
KPIs
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether a component is online or offline. |
| long ServerSize |
The number of servers using a connection. |
| int Client Size |
The total number of clients using a connection. |
| int InfoEventCount |
The total number of information level events. |
| int DebugEventCount |
The total number of debug level events. |
| int WarnEventCount |
The total number of warning level events. |
| int ErrorEventCount |
The total number of error level events. |
| int CriticalEventCount |
The total number of Critical level events. |
com.softwareag.tc.server
This interface defines KPIs for Terracotta Server connection group components.
Discovery Mechanism
Automatically discovered via Terracotta server.
KPIs
| Name | Description |
|---|---|
| boolean Object Status |
The total number of information level events. |
| int LiveObjectCount |
Shows the total number of live objects in the cluster, mirror group, server, or clients. If the trend for the total number of live objects goes up continuously, clients in the cluster will eventually run out of memory and applications might fail. Upward trends indicate a problem with application logic, garbage collection, or the tuning of one or more clients. |
| long WriteOperationRate |
Shows the number of completed writes (or mutations) in the TSA or selected server. Operations can include evictions and expirations. Large-scale eviction or expiration operations can cause spikes in the operations rate (see the corresponding evictions and expirations statistical graphs). This rate is low in read-mostly situations, indicating that there are few writes and little data to evict. If this number drops or deviates regularly from an established baseline, it might indicate issues with network connections or overloaded servers. When clients are selected, this statistic is reported as the Write Transaction Rate, tracking client-to-server write transactions. A measure of how many objects (per second) are being faulted in from the TSA in response to application requests. Faults from off-heap or disk occur when an object is not available in a server's on-heap cache. Flushes occur when the heap or off-heap cache must clear data due to memory constraints. Objects being requested for the first time, or objects that have been flushed from off-heap memory before a request arrives, must be faulted in from disk. High rates could indicate inadequate memory allocation at the server. |
| long ReadOperationRate |
Shows the number of completed read operations (or mutations) in the TSA or selected server. Operations can include evictions and expirations. Large-scale eviction or expiration operations can cause spikes in the operations rate (see the corresponding evictions and expirations statistical graphs). This rate is low in read-mostly situations, indicating that there are few writes and little data to evict. If this number drops or deviates regularly from an established baseline, it might indicate issues with network connections or overloaded servers. When clients are selected, this statistic is reported as the Read Transaction Rate, tracking client-to-server read transactions. A measure of how many objects (per second) are being faulted in from the TSA in response to application requests. Faults from off-heap or disk occur when an object is not available in a server's on-heap cache. Flushes occur when the heap or off-heap cache must clear data due to memory constraints. Objects being requested for the first time, or objects that have been flushed from off-heap memory before a request arrives, must be faulted in from disk. High rates could indicate inadequate memory allocation at the server. |
| long EvictionRate |
Shows the number of entries being evicted from the cluster, mirror group, or server. The number of elements being evicted per second from the cache. Evicted elements are expired or evicted according to a usage algorithm when size limits are exceeded. |
| long ExpirationRate |
Shows the number of expired entries found (and being evicted) on the TSA, mirror group, or server. The number of elements per second reaching expiration in the cache. Expired elements are not automatically evicted. |
| int DataUserdSize |
Shows the amount of the data storage that is currently in use. |
| int DataMaxSize |
Shows the total amount of data storage. This is the configured amount (dataStorage size in the tc-config.xml) that can be stored in BigMemory, both in off-heap DRAM and in any SSD flash drive, if BigMemory Hybrid is configured. |
| int OffheapUsedSize |
Shows the amount of off-heap memory currently in use (containing data). |
| int OffheapReservedSize |
Shows the amount of off-heap memory that is currently available. |
| int OffheapMaxSize |
Shows the configured maximum amount of off-heap memory (off-heap size in the tc-config.xml). |
Terracotta Connection
Connection to the Terracotta Management Server or Terracotta Server through which infradc_service script can discover the other Terracotta components.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether a component is online or offline. |
| int CurrentNoOfPollEventsSent | The count of events sent for an asset during each polling. |
| int PollTime | Polling time for an asset during each polling. |
| int PingTime | Time to ping an asset server. |
Ehcache
Ehcache is a standards-based cache for boosting performance, offloading your database, and simplifying scalability.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether a component is online or offline. |
| int Secured |
Indicates secured status. 1 equals yes, 0 equals no. |
| int SSLEnabled |
Indicates if SSL is enabled. 1 equals yes, 0 equals no. |
| int NeedClientAuth |
Indicates if client authentication is needed. 1 equals yes, 0 equals no. |
| int SampleHistorySize |
Historic information samples of cache size. |
| int SampleIntervalSeconds |
Historic frequency information in seconds. |
TSA
The Terracotta Server Array (TSA) provides the platform for Terracotta products and the backbone for Terracotta clusters.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether TSA is online or offline. |
| long ServerSize |
Server size in bytes. |
| long ActiveServerSize |
Active server size in bytes. |
| int ClientSize |
Client size in bytes. |
| int ErrorEventCount |
Count of all error events. |
| int CriticalEventCount |
Count of all critical events. |
| int InfoEventCount |
Count of all informational events. |
| int WarnEventCount |
Count of all warning events. |
| int DebugEventCount |
Count of all debug events. |
| int Secured |
Indicates secured status. 1 equals yes, 0 equals no. |
| int SSLEnabled |
Indicates if SSL is enabled. 1 equals yes, 0 equals no. |
| int NeedClientAuth |
Indicates if client authentication is needed. 1 equals yes, 0 equals no. |
| int SampleHistorySize |
Historic information samples of cache size. |
| int SampleIntervalSeconds |
Historic frequency information in seconds. |
TSA Server
Server instances which are part of a cluster TSA.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether the TSA server is online or offline. |
| long WriteOperationRate |
Rate at witch operations are written in seconds. |
| long ReadOperationRate |
Rate at witch operations are read in seconds. |
| long EvictionRate |
Rate of evictions in seconds. |
| long ExpirationRate |
Rate of expirations in seconds. |
| int LiveObjectCount |
Number of live objects count. |
| int DataUsedSize |
Size of data used in bytes. |
| int DataReservedSize |
Size of data reserved in bytes. |
| int DataMaxSize |
Size of data max allowed in bytes. |
| int OffheapUsedSize |
Size of off-heap space used. |
| int OffheapReservedSize |
Size of off-heap reserved space. |
| int OffheapMaxSize |
Size of off-heap max space allowed. |
CacheManager
A container for Ehcaches, which maintains all aspects of caches life cycle. The creation and removal of caches and the access to them is controlled by a named Cache Manager.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether the CacheManager is online or offline. |
| int CacheAverageGetTime |
Average time it takes to get the cache. |
| int CacheAverageSearchTime |
Average time it takes to search the cache. |
| long CacheSearchRate |
Rate at which the cache is searched. |
| long CacheHitRate |
Rate at which the cache objects are found. |
| long CacheOnDiskHitRate |
Rate at which the cache on disk objects are found. |
| long CacheOffHeapHitRate |
Rate at which the cache off-heap objects are found. |
| long CacheInMemoryHitRate |
Rate at which the cache in memory objects are found. |
| long CacheMissRate |
Rate at which the cache objects are not found. |
| long CacheOnDiskMissRate |
Rate at which the cache objects are not found. |
| long CacheOffHeapMissRate |
Rate at which the cache off-heap objects are not found. |
| long CacheInMemoryMissRate |
Rate at which the cache in memory objects are not found. |
| int CahePutRate |
Rate at which the objects are written to cache. |
| long CacheUpdateRate |
Rate at which the objects are updated in cache. |
| long CacheRemoveRate |
Rate at which the objects are removed from cache. |
| long CacheEvictionRate |
Rate at which the objects are evicted from cache. |
| long CacheExpirationRate |
Rate at which the objects expire in cache. |
| long TransactionCommitRate |
Rate at which the objects are committed to cache. |
| int TransactionCommittedCount |
Object count committed to cache. |
| long TransactionRollbackRate |
Rate at which transactions are rolled back from cache. |
| int TransactionRolledBackCount |
Object count of rolled back transactions. |
| int TransactionTimeOutCount |
Object count of time out transactions. |
| int WriteQueueLength |
Queue length written to cache. |
Cache
Terracotta Cache is Ehcache, which has elements and is managed by cache manager.
| Name | Description |
|---|---|
| boolean ObjectStatus |
Indicates whether the cache is online or offline. |
| int Size |
Size of cache in bytes. |
| int OnDiskSize |
Size of cache on disk in bytes. |
| int InMemorySize |
Size of cache in memory. |
| int OffHeapSize |
Size of off-heap space in bytes. |
| int LocalDiskSize |
Local disk size of cache in bytes. |
| int LocalOffHeapSize |
Size of Local off-heap space in bytes. |
| int LocalHeapSize |
Size of Local Heap space in bytes. |
| int AverageGetTime |
Average time it takes to process a get cache object request. |
| int AverageSearchTime |
Average time to process a search object request. |
| long CacheSearchRate |
Rate at which it takes to search the cache. |
| long CacheHitRate |
Rate at which objects are successfully found in cache. |
| long CacheOnDiskHitRate |
Rate at which objects are successfully found on disk cache. |
| long CacheInMemoryHitRate |
Rate at which objects are successfully found in memory cache. |
| long CacheOffHeapHitRate |
Rate at which objects are successfully found in off-heap cache. |
| int CacheHitRatio |
Ratio at which objects are successfully found in cache. |
| int CacheHitCount |
Count of objects that are successfully found in cache. |
| int OnDiskHitCount |
Count of objects that are successfully found on disk cache. |
| int OffHeapHitCount |
Count of objects that are successfully found in off-heap cache. |
| int InMemoryHitCount |
Count of objects that are successfully found in memory cache. |
| long CacheMissRate |
Rate at which objects are not found in memory cache. |
| long CacheOnDiskMissRate |
Rate at which objects are not found on disk cache. |
| long CacheInMemoryMissRate |
Rate at which objects are not found in memory cache. |
| long CacheOffHeapMissRate |
Rate at which objects are not found in off-heap cache. |
| long RemoveElementMissRate |
Rate at which elements are not removed from cache. |
| long PutIfAbsentMissRate |
Rate at which elements not found in cache are not written to cache. |
| long ReplaceOneArgMissRate |
Rate at which elements with one argument are not replaced. |
| long ReplaceTwoArgMissRate |
Rate at which elements with two arguments are not replaced. |
| int CacheMissCount |
Count of objects not found in cache. |
| int OnDiskMissCount |
Count of objects not found on disk. |
| int OffHeapMissCount |
Count of objects not found in off-heap cache. |
| int InMemoryMissCount |
Count of objects not found in memory cache. |
| int RemoveElementMissCount |
Count of objects not removed from cache. |
| int PutIfAbsentMissCount |
Count of objects not found in cache, not written to cache. |
| int ReplaceOneArgMissCount |
Count of objects with one argument not replaced. |
| int ReplaceTwoArgMissCount |
Count of objects with two arguments not replaced. |
| int CacheMissCountExpired |
Count of objects which should have expired from cache but didn't. |
| long CachePutRate |
Rate at which objects are written to cache. |
| long CacheRemoveRate |
Rate at which objects are removed from cache. |
| long CacheUpdateRate |
Rate at which objects in cache are updated |
| long CacheExpirationRate |
Rate at which objects in cache have expired. |
| long CacheEvictionRate |
Rate at which objects in cache have been evicted. |
| int PutCount |
Count of objects written to cache. |
| int UpdateCount |
Count of objects updated in cache. |
| int RemovedCount |
Count of objects removed from cache. |
| int ExpiredCount |
Count of objects expired in cache. |
| int EvictedCount |
Count of objects evicted from cache. |
| long RemoveElementSuccessRate |
Rate at which elements are successfully removed from cache. |
| int RemoveElementSuccessCount |
Count of elements successfully removed from cache. |
| long PutIfAbsentSuccessRate |
Rate at which objects not found in cache, are written to cache. |
| int PutIfAbsentSuccessCount |
Count of objects missing from cache are written to cache. |
| long ReplaceOneArgSuccessRate |
Rate at which objects with one argument are successfully replaced. |
| int ReplaceOneArgSuccessCount |
Count of objects with one argument successfully replaced. |
| long ReplaceTwoArgSuccessRate |
Rate at which objects with two arguments are successfully replaced. |
| int ReplaceTwoArgSuccessCount |
Count of objects with two arguments successfully replaced. |
| long NonStopSuccessRate |
Rate at which the cache continues to process certain operations when offline or disconnected. |
| int NonStopSuccessCount |
Count of operations the cache continues to process when offline or disconnected. |
| long NonStopFailureRate |
Rate at which the cache doesn't continue to process certain operations when offline or disconnected. |
| int NonStopFailureCount |
Count of operations the cache doesn't continue to process when offline or disconnected. |
| int NonstopTimeoutRatio |
Ratio at which operations have timed out when the cache continues to process when offline or disconnected. |
| long NonStopTimeoutRate |
Rate at which operations have timed out when the cache continues to process when offline or disconnected. |
| int NonStopTimeoutCount |
Count of operations which have timed out when the cache doesn't continue to process when offline or disconnected. |
| long NonStopRejoinTimeoutRate |
Rate at which operations have timed out and rejoined when the cache continues to process when offline or disconnected. |
| int NonStopRejoinTimeoutCount |
Count of operations which have timed out and rejoined when the cache doesn't continue to process when offline or disconnected. |
| long TransactionCommitRate |
Rate at which transactions are committed to cache. |
| int XaCommitCount |
Count of XA mode transactions written to cache. |
| long TransactionRollbackRate |
Rate at which transactions are rollback in cache. |
| int XaRollbackCount |
Count of XA mode transactions rolled back in cache. |
| int XaRecoveredCount |
Count of XA mode transactions recovered in cache. |
| int WriterQueueLength |
Maximum elements that can be queued for processing by the write-behind writer. |
| int WriterMaxQueueSize |
Maximum size of elements that can be queued for processing by the write-behind writer. |
| int WriterConcurrency |
Sets whether to notify listeners when an exception occurs on a writer operation. |
| int CacheClusterOnlineCount |
Count of all cache clusters which are online. |
| int CacheClusterOfflineCount |
Count of all cache clusters which are offline. |
| int CacheClusterRejoinCount |
Count of all cache clusters which where rejoined. |
| int LocalHeapCountBased |
Count of all local heaps. |
| int OverflowToDisk |
Overflowed cache data will be written to disk: indicator - on/off. |
| int OverflowToOffHeap |
Overflowed cache data will be written to off-heap: indicator - on/off. |
| int MaxElementsOnDisk |
Total maximum elements allowed on disk - value. |
| int MaxEntriesInCache |
Total maximum entries allowed in cache - value. |
| int MaxEntriesLocalDisk |
Total maximum entries allowed on local disk - value. |
| int MaxEntriesLocalHeap |
Total maximum entries allowed in local heap- value. |
| int MaxBytesLocalDisk |
Total maximum bytes allowed on local disk - value. |
| int MaxBytesLocalOffHeap |
Total maximum bytes allowed in off-heap - value. |
| int MaxBytesLocalHeap |
Total max bytes allowed in local heap - value. |