Interface LegacyCacheStatistics
-
- All Known Subinterfaces:
CacheSampler,SampledCacheMBean
- All Known Implementing Classes:
CacheSamplerImpl,SampledCache
public interface LegacyCacheStatisticsInterface for sampled usage statistics of a Cache.
- Since:
- 1.7
- Author:
- Abhishek Sanoujam
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voiddispose()Method used to dispose this statistics.longgetAverageGetTimeNanos()Average time in nanoseconds taken to get an element from the cache.longgetAverageGetTimeNanosMostRecentSample()Get most recent value for average time taken for get() operation in the cache.longgetAverageSearchTimeNanos()Get the average search execution time for searches finishing within the last sample period.longgetCacheClusterOfflineCount()Count of cluster offline events for this node.longgetCacheClusterOfflineMostRecentSample()Gets the cache cluster offline most recent sample.longgetCacheClusterOnlineCount()Count of cluster online events for this node.longgetCacheClusterOnlineMostRecentSample()Gets the cache cluster online most recent sample.longgetCacheClusterRejoinCount()Count of cluster rejoin events for this node.longgetCacheClusterRejoinMostRecentSample()Gets the cache cluster rejoin most recent sample.longgetCacheElementEvictedMostRecentSample()Get most recent value element evicted from cache.longgetCacheElementExpiredMostRecentSample()Get most recent value element expired from cache.longgetCacheElementPutMostRecentSample()Get most recent value element puts in the cache.longgetCacheElementRemovedMostRecentSample()Get most recent value element removed from cache.longgetCacheElementUpdatedMostRecentSample()Get most recent value element updates , i.e.longgetCacheHitCount()The number of times a requested item was found in the cache.longgetCacheHitInMemoryMostRecentSample()Get most recent value for in-memory cache hit.longgetCacheHitMostRecentSample()Get most recent value for cache hit.longgetCacheHitOffHeapMostRecentSample()Get most recent value for off-heap cache hit.longgetCacheHitOnDiskMostRecentSample()Get most recent value for on-disk cache hit.intgetCacheHitRatio()The ratio of hits to accesses (hits + misses).intgetCacheHitRatioMostRecentSample()Get most recent value for cache hit ratio.longgetCacheMissCount()Number of times a requested element was not found in the cache.longgetCacheMissCountExpired()Gets the cache miss count expired.longgetCacheMissExpiredMostRecentSample()Get most recent value for cache miss as result of the element getting expired.longgetCacheMissInMemoryMostRecentSample()Get most recent value for in-memory cache miss.longgetCacheMissMostRecentSample()Get most recent value for cache miss.longgetCacheMissNotFoundMostRecentSample()Get most recent value for cache miss as result of the element not found in cache.longgetCacheMissOffHeapMostRecentSample()Get most recent value for off-heap cache miss.longgetCacheMissOnDiskMostRecentSample()Get most recent value for on-disk cache miss.java.lang.StringgetCacheName()Gets the cache name.longgetCacheXaCommitsMostRecentSample()Get most recent value of XA commits.longgetCacheXaRollbacksMostRecentSample()Get most recent value of XA rollbacks.longgetEvictedCount()Number of elements evicted from the cache.longgetExpiredCount()Number of elements expired since creation or last clear.longgetInMemoryHitCount()Number of times a requested item was found in the Memory Store.longgetInMemoryMissCount()Number of times a requested item was not found in the Memory Store.longgetInMemorySize()Deprecated.longgetLocalDiskSize()Number of entries in the DiskStore.longgetLocalDiskSizeInBytes()Number of of bytes used by entries in the DiskStore.longgetLocalHeapSize()Number of entries in the MemoryStore.longgetLocalHeapSizeInBytes()Number of of bytes used by entries in the MemoryStore.longgetLocalOffHeapSize()Number of entries in the off-heap store.longgetLocalOffHeapSizeInBytes()Number of of bytes used by entries in the off-heap store.java.lang.LonggetMaxGetTimeNanos()Return maximum time taken for a get operation in the cache in nanoseconds.java.lang.LonggetMinGetTimeNanos()Return minimum time taken for a get operation in the cache in nanoseconds.longgetNonStopFailureCount()Gets the non stop failure count.longgetNonStopFailureMostRecentSample()Gets the non stop failure most recent sample.longgetNonStopRejoinTimeoutCount()Gets the non stop rejoin timeout count.longgetNonStopRejoinTimeoutMostRecentSample()Gets the non stop rejoin most recent sample.longgetNonStopSuccessCount()Gets the non stop success count.longgetNonStopSuccessMostRecentSample()Gets the non stop success most recent sample.longgetNonStopTimeoutCount()Gets the non stop timeout count.longgetNonStopTimeoutMostRecentSample()Gets the non stop timeout most recent sample.intgetNonstopTimeoutRatio()Get the ratio of nonstop timeouts+rejoin timeouts to operationslonggetOffHeapHitCount()Number of times a requested item was found in the off-heap store.longgetOffHeapMissCount()Number of times a requested item was not found in the off-heap store.longgetOffHeapSize()Deprecated.longgetOnDiskHitCount()Number of times a requested item was found in the Disk Store.longgetOnDiskMissCount()Number of times a requested item was not found in the Disk Store.longgetOnDiskSize()Deprecated.longgetPutCount()Number of puts that has happened in the cache.longgetPutIfAbsentMissCount()Number of putIfAbsent operations that missed.longgetPutIfAbsentMissRate()Rate of putIfAbsent operations that missed.longgetPutIfAbsentSuccessCount()Number of putIfAbsent operations that succeeded.longgetPutIfAbsentSuccessRate()Rate of putIfAbsent operations that succeeded.longgetRemovedCount()Number of elements removed since creation or last clear.longgetRemoveElementMissCount()Number of removeElement operations that missed.longgetRemoveElementMissRate()Rate of removeElement operations that missed.longgetRemoveElementSuccessCount()Number of removeElement operations that succeededlonggetRemoveElementSuccessRate()Rate of removeElement operations that succeededlonggetReplaceOneArgMissCount()Number of one arg replace operations that missed.longgetReplaceOneArgMissRate()Rate of one arg replace operations that missed.longgetReplaceOneArgSuccessCount()Number of one arg replace operations that succeeded.longgetReplaceOneArgSuccessRate()Rate of one arg replace operations that succeeded.longgetReplaceTwoArgMissCount()Number of two arg replace operations that missed.longgetReplaceTwoArgMissRate()Rate of two arg replace operations that missed.longgetReplaceTwoArgSuccessCount()Number of two arg replace operations that succeeded.longgetReplaceTwoArgSuccessRate()Rate of two arg replace operations that succeeded.longgetSearchesPerSecond()Get the number of searches that have finished execution in the last second.longgetSize()Size of the cache based on current accuracy settings.longgetUpdateCount()Number of updates that as happened in the cache.longgetWriterQueueLength()Gets the size of the write-behind queue, if any.longgetXaCommitCount()Return the Cache's XAResource commit calls count.longgetXaRecoveredCount()Return the Cache's XAResource recovered XIDs count.longgetXaRollbackCount()Return the Cache's XAResource rollback calls count.booleanisLocalHeapCountBased()Check if the local heap is measured with ARC or in element count.
-
-
-
Method Detail
-
getCacheHitCount
long getCacheHitCount()
The number of times a requested item was found in the cache.- Returns:
- the number of times a requested item was found in the cache
-
getInMemoryHitCount
long getInMemoryHitCount()
Number of times a requested item was found in the Memory Store.- Returns:
- the number of times a requested item was found in memory
-
getOffHeapHitCount
long getOffHeapHitCount()
Number of times a requested item was found in the off-heap store.- Returns:
- the number of times a requested item was found in off-heap
-
getOnDiskHitCount
long getOnDiskHitCount()
Number of times a requested item was found in the Disk Store.- Returns:
- the number of times a requested item was found on Disk, or 0 if there is no disk storage configured.
-
getCacheMissCount
long getCacheMissCount()
Number of times a requested element was not found in the cache.- Returns:
- the number of times a requested element was not found in the cache
-
getInMemoryMissCount
long getInMemoryMissCount()
Number of times a requested item was not found in the Memory Store.- Returns:
- the number of times a requested item was not found in memory
-
getOffHeapMissCount
long getOffHeapMissCount()
Number of times a requested item was not found in the off-heap store.- Returns:
- the number of times a requested item was not found in off-heap
-
getOnDiskMissCount
long getOnDiskMissCount()
Number of times a requested item was not found in the Disk Store.- Returns:
- the number of times a requested item was not found on Disk, or 0 if there is no disk storage configured.
-
getCacheMissCountExpired
long getCacheMissCountExpired()
Gets the cache miss count expired.- Returns:
- the number of times a requested element was not found in the cache and the reason being the element already expired
-
getCacheHitRatio
int getCacheHitRatio()
The ratio of hits to accesses (hits + misses).- Returns:
- the ratio of hits to (hits + misses) (0 - 100)
-
getNonstopTimeoutRatio
int getNonstopTimeoutRatio()
Get the ratio of nonstop timeouts+rejoin timeouts to operations- Returns:
- the ratio of timeouts to operation (0 - 100)
-
getSize
long getSize()
Size of the cache based on current accuracy settings.- Returns:
- The size of the cache based on current accuracy setting
-
getInMemorySize
@Deprecated long getInMemorySize()
Deprecated.Number of elements in the MemoryStore.- Returns:
- the number of elements in memory
-
getOffHeapSize
@Deprecated long getOffHeapSize()
Deprecated.Number of elements in the off-heap store.- Returns:
- the number of elements in off-heap
-
getOnDiskSize
@Deprecated long getOnDiskSize()
Deprecated.Number of elements in the DiskStore.- Returns:
- number of elements on disk
-
getLocalHeapSize
long getLocalHeapSize()
Number of entries in the MemoryStore.- Returns:
- the number of elements in memory
-
getLocalOffHeapSize
long getLocalOffHeapSize()
Number of entries in the off-heap store.- Returns:
- the number of elements in off-heap
-
getLocalDiskSize
long getLocalDiskSize()
Number of entries in the DiskStore.- Returns:
- number of elements on disk
-
getLocalHeapSizeInBytes
long getLocalHeapSizeInBytes()
Number of of bytes used by entries in the MemoryStore.- Returns:
- the number of of bytes used by elements in memory
-
getLocalOffHeapSizeInBytes
long getLocalOffHeapSizeInBytes()
Number of of bytes used by entries in the off-heap store.- Returns:
- the number of of bytes used by elements in off-heap
-
getLocalDiskSizeInBytes
long getLocalDiskSizeInBytes()
Number of of bytes used by entries in the DiskStore.- Returns:
- number of bytes used by elements on disk
-
getAverageGetTimeNanos
long getAverageGetTimeNanos()
Average time in nanoseconds taken to get an element from the cache.- Returns:
- Average time taken for a get operation in nanoseconds
-
getEvictedCount
long getEvictedCount()
Number of elements evicted from the cache.- Returns:
- Number of elements evicted from the cache
-
getPutCount
long getPutCount()
Number of puts that has happened in the cache.- Returns:
- Number of puts
-
getUpdateCount
long getUpdateCount()
Number of updates that as happened in the cache.- Returns:
- Number of updates
-
getReplaceOneArgSuccessCount
long getReplaceOneArgSuccessCount()
Number of one arg replace operations that succeeded.- Returns:
- Number of replaces
-
getReplaceOneArgSuccessRate
long getReplaceOneArgSuccessRate()
Rate of one arg replace operations that succeeded. Similar to most recent smaple- Returns:
- Rate of replaces
-
getReplaceOneArgMissCount
long getReplaceOneArgMissCount()
Number of one arg replace operations that missed.- Returns:
- Number of replace misses
-
getReplaceOneArgMissRate
long getReplaceOneArgMissRate()
Rate of one arg replace operations that missed.- Returns:
- Rate of replace misses
-
getReplaceTwoArgSuccessCount
long getReplaceTwoArgSuccessCount()
Number of two arg replace operations that succeeded.- Returns:
- Number of replaces
-
getReplaceTwoArgSuccessRate
long getReplaceTwoArgSuccessRate()
Rate of two arg replace operations that succeeded.- Returns:
- Rate of replaces
-
getReplaceTwoArgMissCount
long getReplaceTwoArgMissCount()
Number of two arg replace operations that missed.- Returns:
- Number of replace misses
-
getReplaceTwoArgMissRate
long getReplaceTwoArgMissRate()
Rate of two arg replace operations that missed.- Returns:
- Rate of replace misses
-
getPutIfAbsentSuccessCount
long getPutIfAbsentSuccessCount()
Number of putIfAbsent operations that succeeded.- Returns:
- Number of putIfAbsents
-
getPutIfAbsentSuccessRate
long getPutIfAbsentSuccessRate()
Rate of putIfAbsent operations that succeeded.- Returns:
- Rate of putIfAbsents
-
getPutIfAbsentMissCount
long getPutIfAbsentMissCount()
Number of putIfAbsent operations that missed.- Returns:
- Number of putIfAbsent misses
-
getPutIfAbsentMissRate
long getPutIfAbsentMissRate()
Rate of putIfAbsent operations that missed.- Returns:
- Rate of putIfAbsent misses
-
getRemoveElementSuccessCount
long getRemoveElementSuccessCount()
Number of removeElement operations that succeeded- Returns:
- Number of removeElement operations
-
getRemoveElementSuccessRate
long getRemoveElementSuccessRate()
Rate of removeElement operations that succeeded- Returns:
- Rate of removeElement operations
-
getRemoveElementMissCount
long getRemoveElementMissCount()
Number of removeElement operations that missed.- Returns:
- Number of removeElement misses
-
getRemoveElementMissRate
long getRemoveElementMissRate()
Rate of removeElement operations that missed.- Returns:
- Rate of removeElement misses
-
getExpiredCount
long getExpiredCount()
Number of elements expired since creation or last clear.- Returns:
- Number of expired elements
-
getRemovedCount
long getRemovedCount()
Number of elements removed since creation or last clear.- Returns:
- Number of elements removed
-
getCacheClusterOfflineCount
long getCacheClusterOfflineCount()
Count of cluster offline events for this node.- Returns:
- count
-
getCacheClusterRejoinCount
long getCacheClusterRejoinCount()
Count of cluster rejoin events for this node.- Returns:
- count
-
getCacheClusterOnlineCount
long getCacheClusterOnlineCount()
Count of cluster online events for this node.- Returns:
- count
-
getCacheName
java.lang.String getCacheName()
Gets the cache name.- Returns:
- the name of the Ehcache
-
getMaxGetTimeNanos
java.lang.Long getMaxGetTimeNanos()
Return maximum time taken for a get operation in the cache in nanoseconds.- Returns:
- maximum time taken for a get operation in the cache in nanoseconds
-
getMinGetTimeNanos
java.lang.Long getMinGetTimeNanos()
Return minimum time taken for a get operation in the cache in nanoseconds.- Returns:
- minimum time taken for a get operation in the cache in nanoseconds
-
getWriterQueueLength
long getWriterQueueLength()
Gets the size of the write-behind queue, if any. The value is for all local buckets- Returns:
- Elements waiting to be processed by the write-behind writer.
-
getXaCommitCount
long getXaCommitCount()
Return the Cache's XAResource commit calls count.- Returns:
- the Cache's XAResource commit calls count
-
getXaRollbackCount
long getXaRollbackCount()
Return the Cache's XAResource rollback calls count.- Returns:
- the Cache's XAResource rollback calls count
-
getXaRecoveredCount
long getXaRecoveredCount()
Return the Cache's XAResource recovered XIDs count.- Returns:
- the Cache's XAResource recovered XIDs count
-
getCacheHitMostRecentSample
long getCacheHitMostRecentSample()
Get most recent value for cache hit.- Returns:
- Most recent sample for cache hit count
-
getCacheHitInMemoryMostRecentSample
long getCacheHitInMemoryMostRecentSample()
Get most recent value for in-memory cache hit.- Returns:
- Most recent sample for cache hit count in memory
-
getCacheHitOffHeapMostRecentSample
long getCacheHitOffHeapMostRecentSample()
Get most recent value for off-heap cache hit.- Returns:
- Most recent sample for cache hit count in off-heap
-
getCacheHitOnDiskMostRecentSample
long getCacheHitOnDiskMostRecentSample()
Get most recent value for on-disk cache hit.- Returns:
- Most recent sample for cache hit count on disk
-
getCacheMissMostRecentSample
long getCacheMissMostRecentSample()
Get most recent value for cache miss.- Returns:
- Most recent sample for cache miss count
-
getCacheMissInMemoryMostRecentSample
long getCacheMissInMemoryMostRecentSample()
Get most recent value for in-memory cache miss.- Returns:
- Most recent sample for cache miss count in memory
-
getCacheMissOffHeapMostRecentSample
long getCacheMissOffHeapMostRecentSample()
Get most recent value for off-heap cache miss.- Returns:
- Most recent sample for cache miss count in off-heap
-
getCacheMissOnDiskMostRecentSample
long getCacheMissOnDiskMostRecentSample()
Get most recent value for on-disk cache miss.- Returns:
- Most recent sample for cache miss count on disk
-
getCacheMissExpiredMostRecentSample
long getCacheMissExpiredMostRecentSample()
Get most recent value for cache miss as result of the element getting expired.- Returns:
- Most recent sample for cache miss count and the reason for miss being the element got expired
-
getCacheMissNotFoundMostRecentSample
long getCacheMissNotFoundMostRecentSample()
Get most recent value for cache miss as result of the element not found in cache.- Returns:
- Most recent sample for cache miss not found count
-
getCacheHitRatioMostRecentSample
int getCacheHitRatioMostRecentSample()
Get most recent value for cache hit ratio.- Returns:
- Most recent value for cache hit ratio
-
getCacheElementEvictedMostRecentSample
long getCacheElementEvictedMostRecentSample()
Get most recent value element evicted from cache.- Returns:
- Most recent sample for element evicted count
-
getCacheElementRemovedMostRecentSample
long getCacheElementRemovedMostRecentSample()
Get most recent value element removed from cache.- Returns:
- Most recent sample for element removed count
-
getCacheElementExpiredMostRecentSample
long getCacheElementExpiredMostRecentSample()
Get most recent value element expired from cache.- Returns:
- Most recent value for element expired count
-
getCacheElementPutMostRecentSample
long getCacheElementPutMostRecentSample()
Get most recent value element puts in the cache.- Returns:
- Most recent sample for number of element puts
-
getCacheElementUpdatedMostRecentSample
long getCacheElementUpdatedMostRecentSample()
Get most recent value element updates , i.e. put() on elements with already existing keys in the cache- Returns:
- Most recent sampled value for element update count
-
getAverageGetTimeNanosMostRecentSample
long getAverageGetTimeNanosMostRecentSample()
Get most recent value for average time taken for get() operation in the cache.- Returns:
- Most recent sample of average get time taken for a get operation
-
dispose
void dispose()
Method used to dispose this statistics.
-
getAverageSearchTimeNanos
long getAverageSearchTimeNanos()
Get the average search execution time for searches finishing within the last sample period.- Returns:
- the average search time nanos
-
getSearchesPerSecond
long getSearchesPerSecond()
Get the number of searches that have finished execution in the last second.- Returns:
- the searches per second
-
getCacheXaCommitsMostRecentSample
long getCacheXaCommitsMostRecentSample()
Get most recent value of XA commits.- Returns:
- the cache xa commits most recent sample
-
getCacheXaRollbacksMostRecentSample
long getCacheXaRollbacksMostRecentSample()
Get most recent value of XA rollbacks.- Returns:
- the cache xa rollbacks most recent sample
-
isLocalHeapCountBased
boolean isLocalHeapCountBased()
Check if the local heap is measured with ARC or in element count.- Returns:
- true, if is local heap count based
-
getCacheClusterOfflineMostRecentSample
long getCacheClusterOfflineMostRecentSample()
Gets the cache cluster offline most recent sample.- Returns:
- the cache cluster offline most recent sample
-
getCacheClusterRejoinMostRecentSample
long getCacheClusterRejoinMostRecentSample()
Gets the cache cluster rejoin most recent sample.- Returns:
- the cache cluster rejoin most recent sample
-
getCacheClusterOnlineMostRecentSample
long getCacheClusterOnlineMostRecentSample()
Gets the cache cluster online most recent sample.- Returns:
- the cache cluster online most recent sample
-
getNonStopSuccessCount
long getNonStopSuccessCount()
Gets the non stop success count.- Returns:
- the non stop success count
-
getNonStopFailureCount
long getNonStopFailureCount()
Gets the non stop failure count.- Returns:
- the non stop failure count
-
getNonStopRejoinTimeoutCount
long getNonStopRejoinTimeoutCount()
Gets the non stop rejoin timeout count.- Returns:
- the non stop rejoin timeout count
-
getNonStopTimeoutCount
long getNonStopTimeoutCount()
Gets the non stop timeout count.- Returns:
- the non stop timeout count
-
getNonStopSuccessMostRecentSample
long getNonStopSuccessMostRecentSample()
Gets the non stop success most recent sample.- Returns:
- the non stop success most recent sample
-
getNonStopFailureMostRecentSample
long getNonStopFailureMostRecentSample()
Gets the non stop failure most recent sample.- Returns:
- the non stop failure most recent sample
-
getNonStopRejoinTimeoutMostRecentSample
long getNonStopRejoinTimeoutMostRecentSample()
Gets the non stop rejoin most recent sample.- Returns:
- the non stop rejoin most recent sample
-
getNonStopTimeoutMostRecentSample
long getNonStopTimeoutMostRecentSample()
Gets the non stop timeout most recent sample.- Returns:
- the non stop timeout most recent sample
-
-