ehcache

net.sf.ehcache.management.sampled
Class CacheSamplerImpl

java.lang.Object
  extended by net.sf.ehcache.management.sampled.CacheSamplerImpl
All Implemented Interfaces:
CacheConfigurationListener, CacheSampler, LegacyCacheStatistics

public class CacheSamplerImpl
extends Object
implements CacheSampler, CacheConfigurationListener

An implementation of CacheSampler

Author:
Abhishek Sanoujam, byoukste There is stupid here -- *Sample() is the same as *Rate()

Constructor Summary
CacheSamplerImpl(Ehcache cache)
          Constructor accepting the backing Ehcache
 
Method Summary
 void deregistered(CacheConfiguration config)
          Indicates that this listener was removed from the given configuration
 void diskCapacityChanged(int oldCapacity, int newCapacity)
          Indicates a change in the configurations disk store capacity
 void dispose()
          Method used to dispose this statistics.
 void flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 long getAverageGetTime()
          Gets the average get time.
 long getAverageGetTimeNanos()
          Average time in nanoseconds taken to get an element from the cache.
 long getAverageGetTimeNanosMostRecentSample()
          Get most recent value for average time taken for get() operation in the cache.
 SampledRateCounter getAverageGetTimeSample()
          Get the SampledRateCounter for average time taken for get() operation in the cache.
 long getAverageSearchTime()
          Gets the average search time.
 long getAverageSearchTimeNanos()
          Get the average search execution time for searches finishing within the last sample period.
 SampledRateCounter getAverageSearchTimeSample()
          Get the SampledRateCounter for average search execution time for searches finishing within the last sample period.
 long getCacheClusterOfflineCount()
          Count of cluster offline events for this node.
 long getCacheClusterOfflineMostRecentSample()
          Gets the cache cluster offline most recent sample.
 SampledCounter getCacheClusterOfflineSample()
          Get the SampledCounter for offline cache cluster events.
 long getCacheClusterOnlineCount()
          Count of cluster online events for this node.
 long getCacheClusterOnlineMostRecentSample()
          Gets the cache cluster online most recent sample.
 SampledCounter getCacheClusterOnlineSample()
          Get the SampledCounter for online cache cluster events.
 long getCacheClusterRejoinCount()
          Count of cluster rejoin events for this node.
 long getCacheClusterRejoinMostRecentSample()
          Gets the cache cluster rejoin most recent sample.
 SampledCounter getCacheClusterRejoinSample()
          Get the SampledCounter for rejoin cache cluster events.
 long getCacheElementEvictedMostRecentSample()
          Get most recent value element evicted from cache.
 SampledCounter getCacheElementEvictedSample()
          Get the SampledCounter element evicted from cache.
 long getCacheElementExpiredMostRecentSample()
          Get most recent value element expired from cache.
 SampledCounter getCacheElementExpiredSample()
          Get the SampledCounter element expired from cache.
 long getCacheElementPutMostRecentSample()
          Get most recent value element puts in the cache.
 SampledCounter getCacheElementPutSample()
          Get the SampledCounter element puts in the cache.
 long getCacheElementRemovedMostRecentSample()
          Get most recent value element removed from cache.
 SampledCounter getCacheElementRemovedSample()
          Get the SampledCounter element removed from cache.
 long getCacheElementUpdatedMostRecentSample()
          Get most recent value element updates , i.e.
 SampledCounter getCacheElementUpdatedSample()
          Get the SampledCounter element updates , i.e.
 long getCacheEvictionRate()
          Gets the cache eviction rate.
 long getCacheExpirationRate()
          Gets the cache expiration rate.
 long getCacheHitCount()
          The number of times a requested item was found in the cache.
 long getCacheHitInMemoryMostRecentSample()
          Get most recent value for in-memory cache hit.
 SampledCounter getCacheHitInMemorySample()
          Get the SampledCounter for in-memory cache hit.
 long getCacheHitMostRecentSample()
          Get most recent value for cache hit.
 long getCacheHitOffHeapMostRecentSample()
          Get most recent value for off-heap cache hit.
 SampledCounter getCacheHitOffHeapSample()
          Get the SampledCounter for off-heap cache hit.
 long getCacheHitOnDiskMostRecentSample()
          Get most recent value for on-disk cache hit.
 SampledCounter getCacheHitOnDiskSample()
          Get the SampledCounter for on-disk cache hit.
 long getCacheHitRate()
          Gets the cache hit rate.
 int getCacheHitRatio()
          The ratio of hits to accesses (hits + misses).
 int getCacheHitRatioMostRecentSample()
          Get most recent value for cache hit ratio.
 SampledCounter getCacheHitRatioSample()
          Get the SampledCounter for cache hit ratio.
 SampledCounter getCacheHitSample()
          Get the SampledCounter for cache hit.
 long getCacheInMemoryHitRate()
          Gets the cache in memory hit rate.
 long getCacheInMemoryMissRate()
          Gets the cache in memory miss rate.
 long getCacheMissCount()
          Number of times a requested element was not found in the cache.
 long getCacheMissCountExpired()
          Gets the cache miss count expired.
 long getCacheMissExpiredMostRecentSample()
          Get most recent value for cache miss as result of the element getting expired.
 SampledCounter getCacheMissExpiredSample()
          Get the SampledCounter for cache miss as result of the element getting expired.
 long getCacheMissInMemoryMostRecentSample()
          Get most recent value for in-memory cache miss.
 SampledCounter getCacheMissInMemorySample()
          Get the SampledCounter for in-memory cache miss.
 long getCacheMissMostRecentSample()
          Get most recent value for cache miss.
 long getCacheMissNotFoundMostRecentSample()
          Get most recent value for cache miss as result of the element not found in cache.
 SampledCounter getCacheMissNotFoundSample()
          Get the SampledCounter for cache miss as result of the element not found in cache.
 long getCacheMissOffHeapMostRecentSample()
          Get most recent value for off-heap cache miss.
 SampledCounter getCacheMissOffHeapSample()
          Get the SampledCounter for off-heap cache miss.
 long getCacheMissOnDiskMostRecentSample()
          Get most recent value for on-disk cache miss.
 SampledCounter getCacheMissOnDiskSample()
          Get the SampledCounter for on-disk cache miss.
 long getCacheMissRate()
          Gets the cache miss rate.
 SampledCounter getCacheMissSample()
          Get the SampledCounter for cache miss.
 String getCacheName()
          Gets the cache name.
 long getCacheOffHeapHitRate()
          Gets the cache off heap hit rate.
 long getCacheOffHeapMissRate()
          Gets the cache off heap miss rate.
 long getCacheOnDiskHitRate()
          Gets the cache on disk hit rate.
 long getCacheOnDiskMissRate()
          Gets the cache on disk miss rate.
 long getCachePutRate()
          Gets the cache put rate.
 long getCacheRemoveRate()
          Gets the cache remove rate.
 long getCacheSearchRate()
          Gets the cache search rate.
 long getCacheUpdateRate()
          Gets the cache update rate.
 long getCacheXaCommitsMostRecentSample()
          Get most recent value of XA commits.
 SampledCounter getCacheXaCommitsSample()
          Get the SampledCounter for number of XA Transaction commits that have completed in the interval.
 long getCacheXaRollbacksMostRecentSample()
          Get most recent value of XA rollbacks.
 SampledCounter getCacheXaRollbacksSample()
          Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval.
 long getDiskExpiryThreadIntervalSeconds()
          Configuration property accessor
 long getEvictedCount()
          Number of elements evicted from the cache.
 long getExpiredCount()
          Number of elements expired since creation or last clear.
 boolean getHasWriteBehindWriter()
          Is there a registered Write-behind CacheWriter.
 long getInMemoryHitCount()
          Number of times a requested item was found in the Memory Store.
 long getInMemoryMissCount()
          Number of times a requested item was not found in the Memory Store.
 long getInMemorySize()
          Number of elements in the MemoryStore.
 long getLocalDiskSize()
          Number of entries in the DiskStore.
 long getLocalDiskSizeInBytes()
          Number of of bytes used by entries in the DiskStore.
 SampledCounter getLocalDiskSizeInBytesSample()
          Get the SampledCounter for local disk size in bytes.
 SampledCounter getLocalDiskSizeSample()
          Get the SampledCounter for local disk size.
 long getLocalHeapSize()
          Number of entries in the MemoryStore.
 long getLocalHeapSizeInBytes()
          Number of of bytes used by entries in the MemoryStore.
 SampledCounter getLocalHeapSizeInBytesSample()
          Get the SampledCounter for local heap size in bytes.
 SampledCounter getLocalHeapSizeSample()
          Get the SampledCounter for local heap size.
 long getLocalOffHeapSize()
          Number of entries in the off-heap store.
 long getLocalOffHeapSizeInBytes()
          Number of of bytes used by entries in the off-heap store.
 SampledCounter getLocalOffHeapSizeInBytesSample()
          Get the SampledCounter for local offheap size in bytes.
 SampledCounter getLocalOffHeapSizeSample()
          Get the SampledCounter for local offheap size.
 long getMaxBytesLocalDisk()
          Configuration property accessor.
 String getMaxBytesLocalDiskAsString()
          Configuration property accessor.
 long getMaxBytesLocalHeap()
          Configuration property accessor.
 String getMaxBytesLocalHeapAsString()
          Configuration property accessor.
 long getMaxBytesLocalOffHeap()
          Configuration property accessor.
 String getMaxBytesLocalOffHeapAsString()
          Configuration property accessor.
 int getMaxElementsOnDisk()
          Configuration property accessor.
 long getMaxEntriesInCache()
          Configuration property accessor.
 long getMaxEntriesLocalDisk()
          Configuration property accessor.
 long getMaxEntriesLocalHeap()
          Configuration property accessor.
 Long getMaxGetTimeNanos()
          Return maximum time taken for a get operation in the cache in nanoseconds.
 String getMemoryStoreEvictionPolicy()
          Configuration property accessor.
 Long getMinGetTimeNanos()
          Return minimum time taken for a get operation in the cache in nanoseconds.
 long getMostRecentRejoinTimeStampMillis()
          Get the timestamp in nanos of the last rejoin.
 SampledCounter getMostRecentRejoinTimestampMillisSample()
          Get the SampledCounter for last rejoin timestamp.
 long getNonStopFailureCount()
          Gets the non stop failure count.
 long getNonStopFailureMostRecentSample()
          Gets the non stop failure most recent sample.
 long getNonStopFailureRate()
          Gets the non stop failure most recent sample.
 SampledCounter getNonStopFailureSample()
          Gets the nonstop failure sample.
 long getNonStopRejoinTimeoutCount()
          Gets the non stop rejoin timeout count.
 long getNonStopRejoinTimeoutMostRecentSample()
          Gets the non stop rejoin most recent sample.
 long getNonStopRejoinTimeoutRate()
          Gets the non stop rejoin most recent sample.
 SampledCounter getNonStopRejoinTimeoutSample()
          Gets the nonstop rejoin sample.
 long getNonStopSuccessCount()
          Gets the non stop success count.
 long getNonStopSuccessMostRecentSample()
          Gets the non stop success most recent sample.
 long getNonStopSuccessRate()
          Gets the non stop success most recent sample.
 SampledCounter getNonStopSuccessSample()
          Gets the nonstop success sample.
 long getNonStopTimeoutCount()
          Gets the non stop timeout count.
 long getNonStopTimeoutMostRecentSample()
          Gets the non stop timeout most recent sample.
 long getNonStopTimeoutRate()
          Gets the non stop timeout most recent sample.
 int getNonstopTimeoutRatio()
          Get the ratio of nonstop timeouts+rejoin timeouts to operations
 SampledCounter getNonStopTimeoutSample()
          Gets the nonstop timeout sample.
 long getOffHeapHitCount()
          Number of times a requested item was found in the off-heap store.
 long getOffHeapMissCount()
          Number of times a requested item was not found in the off-heap store.
 long getOffHeapSize()
          Deprecated. use getLocalOffHeapSize()
 long getOnDiskHitCount()
          Number of times a requested item was found in the Disk Store.
 long getOnDiskMissCount()
          Number of times a requested item was not found in the Disk Store.
 long getOnDiskSize()
          Deprecated. use getLocalDiskSize()
 String getPersistenceStrategy()
          getPersistenceStrategy
 String getPinnedToStore()
          Configuration property accessor.
 long getPutCount()
          Number of puts that has happened in the cache.
 long getPutIfAbsentMissCount()
          Number of putIfAbsent operations that missed.
 long getPutIfAbsentMissRate()
          Rate of putIfAbsent operations that missed.
 SampledCounter getPutIfAbsentMissSample()
          Gets the putIfAbsent miss sample
 long getPutIfAbsentSuccessCount()
          Number of putIfAbsent operations that succeeded.
 long getPutIfAbsentSuccessRate()
          Rate of putIfAbsent operations that succeeded.
 SampledCounter getPutIfAbsentSuccessSample()
          Gets the putIfAbsent success sample
 SampledCounter getRemoteSizeSample()
          Get the SampledCounter for remote size.
 long getRemovedCount()
          Number of elements removed since creation or last clear.
 long getRemoveElementMissCount()
          Number of removeElement operations that missed.
 long getRemoveElementMissRate()
          Rate of removeElement operations that missed.
 SampledCounter getRemoveElementMissSample()
          Gets the removeElement miss sample
 long getRemoveElementSuccessCount()
          Number of removeElement operations that succeeded
 long getRemoveElementSuccessRate()
          Rate of removeElement operations that succeeded
 SampledCounter getRemoveElementSuccessSample()
          Gets the removeElement success sample
 long getReplaceOneArgMissCount()
          Number of one arg replace operations that missed.
 long getReplaceOneArgMissRate()
          Rate of one arg replace operations that missed.
 SampledCounter getReplaceOneArgMissSample()
          Gets the one arg replace miss sample
 long getReplaceOneArgSuccessCount()
          Number of one arg replace operations that succeeded.
 long getReplaceOneArgSuccessRate()
          Rate of one arg replace operations that succeeded.
 SampledCounter getReplaceOneArgSuccessSample()
          Gets the one arg replace success sample
 long getReplaceTwoArgMissCount()
          Number of two arg replace operations that missed.
 long getReplaceTwoArgMissRate()
          Rate of two arg replace operations that missed.
 SampledCounter getReplaceTwoArgMissSample()
          Gets the two arg replace miss sample
 long getReplaceTwoArgSuccessCount()
          Number of two arg replace operations that succeeded.
 long getReplaceTwoArgSuccessRate()
          Rate of two arg replace operations that succeeded.
 SampledCounter getReplaceTwoArgSuccessSample()
          Gets the two arg replace success sample
 boolean getSearchable()
          Is the cache configured for search.
 Map<String,String> getSearchAttributes()
          Get the declared search attributes and their type names.
 long getSearchesPerSecond()
          Get the number of searches that have finished execution in the last second.
 SampledCounter getSearchesPerSecondSample()
          Get the SampledCounter for number of searches that have finished in the interval.
 long getSize()
          Size of the cache based on current accuracy settings.
 SampledCounter getSizeSample()
          Get the SampledCounter for cache size.
 String getStatus()
          Gets the status attribute of the Cache.
 String getTerracottaConsistency()
          Returns a textual description of a Terracotta-clustered cache's consistency mode.
 long getTimeToIdleSeconds()
          Configuration property accessor.
 long getTimeToLiveSeconds()
          Configuration property accessor.
 boolean getTransactional()
          Is the cache a transactional one.
 long getTransactionCommitRate()
          Gets the transaction commit rate.
 long getTransactionRollbackRate()
          Gets the transaction rollback rate.
 long getUpdateCount()
          Number of updates that as happened in the cache.
 int getWriterConcurrency()
          Returns the number of configured write-behind queues/threads.
 int getWriterMaxQueueSize()
          Returns the maximum size of any write-behind queues.
 long getWriterQueueLength()
          Returns the total length of all write-behind queues for this cache.
 SampledCounter getWriterQueueLengthSample()
          Get the SampledCounter for writer queue length.
 long getXaCommitCount()
          Return the Cache's XAResource commit calls count.
 long getXaRecoveredCount()
          Return the Cache's XAResource recovered XIDs count.
 long getXaRollbackCount()
          Return the Cache's XAResource rollback calls count.
 boolean isClusterBulkLoadEnabled()
          Is the cache in bulk-load mode cluster-wide?.
 boolean isDiskPersistent()
          Configuration property accessor.
 boolean isEnabled()
          Is the cache enabled?.
 boolean isEternal()
          Configuration property accessor.
 boolean isLocalHeapCountBased()
          Check if the local heap is measured with ARC or in element count.
 boolean isLoggingEnabled()
          Configuration property accessor.
 boolean isNodeBulkLoadEnabled()
          Is the cache in bulk-load mode locally?.
 boolean isOverflowToDisk()
          Configuration property accessor.
 boolean isOverflowToOffHeap()
          isOverflowToOffHeap
 boolean isPinned()
          Configuration property accessor.
 boolean isTerracottaClustered()
          Is the cache configured with Terracotta clustering?.
 void loggingChanged(boolean oldValue, boolean newValue)
          Indicates a change in the configuration for enable/disable logging
 void maxBytesLocalDiskChanged(long oldValue, long newValue)
          Indicates a change in the configuration for maxBytesLocalDisk setting
 void maxBytesLocalHeapChanged(long oldValue, long newValue)
          Indicates a change in the configuration for maxBytesLocalHeap setting
 void maxEntriesInCacheChanged(long oldCapacity, long newCapacity)
          Indicates a change in the configuration for maxEntriesInCache setting
 void memoryCapacityChanged(int oldCapacity, int newCapacity)
          Indicates a change in the configurations memory store capacity
 void registered(CacheConfiguration config)
          Indicates that this listener was registered with the given configuration
 void removeAll()
          Removes all cached items.
 void setDiskExpiryThreadIntervalSeconds(long seconds)
          setDiskExpiryThreadIntervalSeconds.
 void setDiskPersistent(boolean diskPersistent)
          setDiskPersistent.
 void setEnabled(boolean enabled)
          Enabled/disable the cache.
 void setEternal(boolean eternal)
          setEternal.
 void setLoggingEnabled(boolean enabled)
          setLoggingEnabled.
 void setMaxBytesLocalDisk(long maxBytes)
          setMaxBytesLocalDisk.
 void setMaxBytesLocalDiskAsString(String maxBytes)
          setMaxBytesLocalDisk.
 void setMaxBytesLocalHeap(long maxBytes)
          setMaxBytesLocalHeap.
 void setMaxBytesLocalHeapAsString(String maxBytes)
          setMaxBytesLocalHeap.
 void setMaxElementsOnDisk(int maxElements)
          setMaxElementsOnDisk.
 void setMaxEntriesInCache(long maxEntries)
          setMaxEntriesInCache.
 void setMaxEntriesLocalDisk(long maxEntries)
          setMaxEntriesLocalDisk.
 void setMaxEntriesLocalHeap(long maxEntries)
          setMaxEntriesLocalHeap.
 void setMemoryStoreEvictionPolicy(String evictionPolicy)
          setMemoryStoreEvictionPolicy.
 void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
          Enabled/disable bulk-load mode for this node.
 void setOverflowToDisk(boolean overflowToDisk)
          setOverflowToDisk.
 void setTimeToIdleSeconds(long tti)
          setTimeToIdleSeconds.
 void setTimeToLiveSeconds(long ttl)
          setTimeToLiveSeconds.
 void timeToIdleChanged(long oldTimeToIdle, long newTimeToIdle)
          Indicates a change in the configurations time to idle
 void timeToLiveChanged(long oldTimeToLive, long newTimeToLive)
          Indicates a change in the configurations time to live
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CacheSamplerImpl

public CacheSamplerImpl(Ehcache cache)
Constructor accepting the backing Ehcache

Parameters:
cache - the cache object to use in initializing this sampled representation
Method Detail

isEnabled

public boolean isEnabled()
Is the cache enabled?.

Specified by:
isEnabled in interface CacheSampler
Returns:
true, if is enabled

setEnabled

public void setEnabled(boolean enabled)
Enabled/disable the cache.

Specified by:
setEnabled in interface CacheSampler
Parameters:
enabled - the new enabled

isClusterBulkLoadEnabled

public boolean isClusterBulkLoadEnabled()
Is the cache in bulk-load mode cluster-wide?.

Specified by:
isClusterBulkLoadEnabled in interface CacheSampler
Returns:
true, if is cluster bulk load enabled

isNodeBulkLoadEnabled

public boolean isNodeBulkLoadEnabled()
Is the cache in bulk-load mode locally?.

Specified by:
isNodeBulkLoadEnabled in interface CacheSampler
Returns:
true, if is node bulk load enabled

setNodeBulkLoadEnabled

public void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
Enabled/disable bulk-load mode for this node.

Specified by:
setNodeBulkLoadEnabled in interface CacheSampler
Parameters:
bulkLoadEnabled - the new node bulk load enabled

flush

public void flush()
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.

Specified by:
flush in interface CacheSampler

getCacheName

public String getCacheName()
Gets the cache name.

Specified by:
getCacheName in interface LegacyCacheStatistics
Returns:
the name of the Ehcache

getStatus

public String getStatus()
Gets the status attribute of the Cache.

Specified by:
getStatus in interface CacheSampler
Returns:
The status value from the Status enum class

removeAll

public void removeAll()
Removes all cached items.

Specified by:
removeAll in interface CacheSampler

getAverageGetTimeNanosMostRecentSample

public long getAverageGetTimeNanosMostRecentSample()
Get most recent value for average time taken for get() operation in the cache.

Specified by:
getAverageGetTimeNanosMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample of average get time taken for a get operation

getCacheEvictionRate

public long getCacheEvictionRate()
Gets the cache eviction rate.

Specified by:
getCacheEvictionRate in interface CacheSampler
Returns:
eviction rate

getCacheElementEvictedMostRecentSample

public long getCacheElementEvictedMostRecentSample()
Get most recent value element evicted from cache.

Specified by:
getCacheElementEvictedMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for element evicted count

getCacheExpirationRate

public long getCacheExpirationRate()
Gets the cache expiration rate.

Specified by:
getCacheExpirationRate in interface CacheSampler
Returns:
expiration rate

getCacheElementExpiredMostRecentSample

public long getCacheElementExpiredMostRecentSample()
Get most recent value element expired from cache.

Specified by:
getCacheElementExpiredMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent value for element expired count

getCachePutRate

public long getCachePutRate()
Gets the cache put rate.

Specified by:
getCachePutRate in interface CacheSampler
Returns:
put rate

getCacheElementPutMostRecentSample

public long getCacheElementPutMostRecentSample()
Get most recent value element puts in the cache.

Specified by:
getCacheElementPutMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for number of element puts

getCacheRemoveRate

public long getCacheRemoveRate()
Gets the cache remove rate.

Specified by:
getCacheRemoveRate in interface CacheSampler
Returns:
remove rate

getCacheElementRemovedMostRecentSample

public long getCacheElementRemovedMostRecentSample()
Get most recent value element removed from cache.

Specified by:
getCacheElementRemovedMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for element removed count

getCacheUpdateRate

public long getCacheUpdateRate()
Gets the cache update rate.

Specified by:
getCacheUpdateRate in interface CacheSampler
Returns:
update rate

getCacheElementUpdatedMostRecentSample

public long getCacheElementUpdatedMostRecentSample()
Get most recent value element updates , i.e. put() on elements with already existing keys in the cache

Specified by:
getCacheElementUpdatedMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sampled value for element update count

getCacheInMemoryHitRate

public long getCacheInMemoryHitRate()
Gets the cache in memory hit rate.

Specified by:
getCacheInMemoryHitRate in interface CacheSampler
Returns:
in-memory hit rate

getCacheHitInMemoryMostRecentSample

public long getCacheHitInMemoryMostRecentSample()
Get most recent value for in-memory cache hit.

Specified by:
getCacheHitInMemoryMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache hit count in memory

getCacheOffHeapHitRate

public long getCacheOffHeapHitRate()
Gets the cache off heap hit rate.

Specified by:
getCacheOffHeapHitRate in interface CacheSampler
Returns:
off-heap hit rate

getCacheHitOffHeapMostRecentSample

public long getCacheHitOffHeapMostRecentSample()
Get most recent value for off-heap cache hit.

Specified by:
getCacheHitOffHeapMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache hit count in off-heap

getCacheHitRate

public long getCacheHitRate()
Gets the cache hit rate.

Specified by:
getCacheHitRate in interface CacheSampler
Returns:
hit rate

getCacheHitMostRecentSample

public long getCacheHitMostRecentSample()
Get most recent value for cache hit.

Specified by:
getCacheHitMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache hit count

getCacheOnDiskHitRate

public long getCacheOnDiskHitRate()
Gets the cache on disk hit rate.

Specified by:
getCacheOnDiskHitRate in interface CacheSampler
Returns:
on-disk hit rate

getCacheHitOnDiskMostRecentSample

public long getCacheHitOnDiskMostRecentSample()
Get most recent value for on-disk cache hit.

Specified by:
getCacheHitOnDiskMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache hit count on disk

getCacheMissExpiredMostRecentSample

public long getCacheMissExpiredMostRecentSample()
Get most recent value for cache miss as result of the element getting expired.

Specified by:
getCacheMissExpiredMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss count and the reason for miss being the element got expired

getCacheMissRate

public long getCacheMissRate()
Gets the cache miss rate.

Specified by:
getCacheMissRate in interface CacheSampler
Returns:
miss rate

getCacheMissMostRecentSample

public long getCacheMissMostRecentSample()
Get most recent value for cache miss.

Specified by:
getCacheMissMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss count

getCacheInMemoryMissRate

public long getCacheInMemoryMissRate()
Gets the cache in memory miss rate.

Specified by:
getCacheInMemoryMissRate in interface CacheSampler
Returns:
in-memory miss rate

getCacheMissInMemoryMostRecentSample

public long getCacheMissInMemoryMostRecentSample()
Get most recent value for in-memory cache miss.

Specified by:
getCacheMissInMemoryMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss count in memory

getCacheOffHeapMissRate

public long getCacheOffHeapMissRate()
Gets the cache off heap miss rate.

Specified by:
getCacheOffHeapMissRate in interface CacheSampler
Returns:
off-heap miss rate

getCacheMissOffHeapMostRecentSample

public long getCacheMissOffHeapMostRecentSample()
Get most recent value for off-heap cache miss.

Specified by:
getCacheMissOffHeapMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss count in off-heap

getCacheOnDiskMissRate

public long getCacheOnDiskMissRate()
Gets the cache on disk miss rate.

Specified by:
getCacheOnDiskMissRate in interface CacheSampler
Returns:
on-disk miss rate

getCacheMissOnDiskMostRecentSample

public long getCacheMissOnDiskMostRecentSample()
Get most recent value for on-disk cache miss.

Specified by:
getCacheMissOnDiskMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss count on disk

getCacheMissNotFoundMostRecentSample

public long getCacheMissNotFoundMostRecentSample()
Get most recent value for cache miss as result of the element not found in cache.

Specified by:
getCacheMissNotFoundMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent sample for cache miss not found count

dispose

public void dispose()
Method used to dispose this statistics.

Specified by:
dispose in interface LegacyCacheStatistics

isTerracottaClustered

public boolean isTerracottaClustered()
Is the cache configured with Terracotta clustering?.

Specified by:
isTerracottaClustered in interface CacheSampler
Returns:
true if clustered with terracotta

getTerracottaConsistency

public String getTerracottaConsistency()
Returns a textual description of a Terracotta-clustered cache's consistency mode.

Specified by:
getTerracottaConsistency in interface CacheSampler
Returns:
"STRONG", "EVENTUAL", or "na" if the cache is not Terracotta-clustered

getAverageGetTime

public long getAverageGetTime()
Gets the average get time.

Specified by:
getAverageGetTime in interface CacheSampler
Returns:
average get time (nanos.)

getMaxGetTimeNanos

public Long getMaxGetTimeNanos()
Return maximum time taken for a get operation in the cache in nanoseconds.

Specified by:
getMaxGetTimeNanos in interface LegacyCacheStatistics
Returns:
maximum time taken for a get operation in the cache in nanoseconds

getMinGetTimeNanos

public Long getMinGetTimeNanos()
Return minimum time taken for a get operation in the cache in nanoseconds.

Specified by:
getMinGetTimeNanos in interface LegacyCacheStatistics
Returns:
minimum time taken for a get operation in the cache in nanoseconds

getXaCommitCount

public long getXaCommitCount()
Return the Cache's XAResource commit calls count.

Specified by:
getXaCommitCount in interface LegacyCacheStatistics
Returns:
the Cache's XAResource commit calls count

getXaRollbackCount

public long getXaRollbackCount()
Return the Cache's XAResource rollback calls count.

Specified by:
getXaRollbackCount in interface LegacyCacheStatistics
Returns:
the Cache's XAResource rollback calls count

getXaRecoveredCount

public long getXaRecoveredCount()
Return the Cache's XAResource recovered XIDs count.

Specified by:
getXaRecoveredCount in interface LegacyCacheStatistics
Returns:
the Cache's XAResource recovered XIDs count

getHasWriteBehindWriter

public boolean getHasWriteBehindWriter()
Is there a registered Write-behind CacheWriter.

Specified by:
getHasWriteBehindWriter in interface CacheSampler
Returns:
the checks for write behind writer

getWriterQueueLength

public long getWriterQueueLength()
Returns the total length of all write-behind queues for this cache.

Specified by:
getWriterQueueLength in interface CacheSampler
Specified by:
getWriterQueueLength in interface LegacyCacheStatistics
Returns:
writer-behind queue length

getWriterMaxQueueSize

public int getWriterMaxQueueSize()
Returns the maximum size of any write-behind queues.

Specified by:
getWriterMaxQueueSize in interface CacheSampler
Returns:
Maximum elements that can be queued for processing by the write-behind writer
See Also:
CacheWriterConfiguration.getWriteBehindMaxQueueSize()

getWriterConcurrency

public int getWriterConcurrency()
Returns the number of configured write-behind queues/threads.

Specified by:
getWriterConcurrency in interface CacheSampler
Returns:
Number of configured processing queues/threads for use by the write-behind writer
See Also:
CacheWriterConfiguration.getWriteBehindConcurrency()

getCacheHitCount

public long getCacheHitCount()
The number of times a requested item was found in the cache.

Specified by:
getCacheHitCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was found in the cache

getCacheMissCount

public long getCacheMissCount()
Number of times a requested element was not found in the cache.

Specified by:
getCacheMissCount in interface LegacyCacheStatistics
Returns:
the number of times a requested element was not found in the cache

getInMemoryMissCount

public long getInMemoryMissCount()
Number of times a requested item was not found in the Memory Store.

Specified by:
getInMemoryMissCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was not found in memory

getOffHeapMissCount

public long getOffHeapMissCount()
Number of times a requested item was not found in the off-heap store.

Specified by:
getOffHeapMissCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was not found in off-heap

getOnDiskMissCount

public long getOnDiskMissCount()
Number of times a requested item was not found in the Disk Store.

Specified by:
getOnDiskMissCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was not found on Disk, or 0 if there is no disk storage configured.

getCacheMissCountExpired

public long getCacheMissCountExpired()
Gets the cache miss count expired.

Specified by:
getCacheMissCountExpired in interface LegacyCacheStatistics
Returns:
the number of times a requested element was not found in the cache and the reason being the element already expired

getDiskExpiryThreadIntervalSeconds

public long getDiskExpiryThreadIntervalSeconds()
Configuration property accessor

Specified by:
getDiskExpiryThreadIntervalSeconds in interface CacheSampler
Returns:
Value for disk expiry thread interval in seconds specified in config

setDiskExpiryThreadIntervalSeconds

public void setDiskExpiryThreadIntervalSeconds(long seconds)
setDiskExpiryThreadIntervalSeconds.

Specified by:
setDiskExpiryThreadIntervalSeconds in interface CacheSampler
Parameters:
seconds - the new disk expiry thread interval seconds

getMaxEntriesLocalHeap

public long getMaxEntriesLocalHeap()
Configuration property accessor.

Specified by:
getMaxEntriesLocalHeap in interface CacheSampler
Returns:
Max entries local heap config setting value

setMaxEntriesLocalHeap

public void setMaxEntriesLocalHeap(long maxEntries)
setMaxEntriesLocalHeap.

Specified by:
setMaxEntriesLocalHeap in interface CacheSampler
Parameters:
maxEntries - the new max entries local heap

getMaxBytesLocalHeap

public long getMaxBytesLocalHeap()
Configuration property accessor.

Specified by:
getMaxBytesLocalHeap in interface CacheSampler
Returns:
Max bytes local heap config setting value

setMaxBytesLocalHeap

public void setMaxBytesLocalHeap(long maxBytes)
setMaxBytesLocalHeap.

Specified by:
setMaxBytesLocalHeap in interface CacheSampler
Parameters:
maxBytes - the new max bytes local heap

setMaxBytesLocalHeapAsString

public void setMaxBytesLocalHeapAsString(String maxBytes)
setMaxBytesLocalHeap.

Specified by:
setMaxBytesLocalHeapAsString in interface CacheSampler
Parameters:
maxBytes - the new max bytes local heap as string

getMaxBytesLocalHeapAsString

public String getMaxBytesLocalHeapAsString()
Configuration property accessor.

Specified by:
getMaxBytesLocalHeapAsString in interface CacheSampler
Returns:
Max bytes local heap config setting value as string

getMaxEntriesLocalDisk

public long getMaxEntriesLocalDisk()
Configuration property accessor.

Specified by:
getMaxEntriesLocalDisk in interface CacheSampler
Returns:
Max entries local disk config setting value

setMaxEntriesLocalDisk

public void setMaxEntriesLocalDisk(long maxEntries)
setMaxEntriesLocalDisk.

Specified by:
setMaxEntriesLocalDisk in interface CacheSampler
Parameters:
maxEntries - the new max entries local disk

setMaxBytesLocalDisk

public void setMaxBytesLocalDisk(long maxBytes)
setMaxBytesLocalDisk.

Specified by:
setMaxBytesLocalDisk in interface CacheSampler
Parameters:
maxBytes - the new max bytes local disk

setMaxBytesLocalDiskAsString

public void setMaxBytesLocalDiskAsString(String maxBytes)
setMaxBytesLocalDisk.

Specified by:
setMaxBytesLocalDiskAsString in interface CacheSampler
Parameters:
maxBytes - the new max bytes local disk as string

getMaxBytesLocalDiskAsString

public String getMaxBytesLocalDiskAsString()
Configuration property accessor.

Specified by:
getMaxBytesLocalDiskAsString in interface CacheSampler
Returns:
Max bytes local disk config setting value as string

getMaxElementsOnDisk

public int getMaxElementsOnDisk()
Configuration property accessor.

Specified by:
getMaxElementsOnDisk in interface CacheSampler
Returns:
Max elements on disk config setting value

getMaxEntriesInCache

public long getMaxEntriesInCache()
Configuration property accessor.

Specified by:
getMaxEntriesInCache in interface CacheSampler
Returns:
Max entries in cache config setting value

setMaxElementsOnDisk

public void setMaxElementsOnDisk(int maxElements)
setMaxElementsOnDisk.

Specified by:
setMaxElementsOnDisk in interface CacheSampler
Parameters:
maxElements - the new max elements on disk

setMaxEntriesInCache

public void setMaxEntriesInCache(long maxEntries)
setMaxEntriesInCache.

Specified by:
setMaxEntriesInCache in interface CacheSampler
Parameters:
maxEntries - the new max entries in cache

getMaxBytesLocalDisk

public long getMaxBytesLocalDisk()
Configuration property accessor.

Specified by:
getMaxBytesLocalDisk in interface CacheSampler
Returns:
Max bytes local disk config setting value

getMaxBytesLocalOffHeap

public long getMaxBytesLocalOffHeap()
Configuration property accessor.

Specified by:
getMaxBytesLocalOffHeap in interface CacheSampler
Returns:
Max bytes local offheap config setting value

getMaxBytesLocalOffHeapAsString

public String getMaxBytesLocalOffHeapAsString()
Configuration property accessor.

Specified by:
getMaxBytesLocalOffHeapAsString in interface CacheSampler
Returns:
Max bytes local offheap config setting value as string

getMemoryStoreEvictionPolicy

public String getMemoryStoreEvictionPolicy()
Configuration property accessor.

Specified by:
getMemoryStoreEvictionPolicy in interface CacheSampler
Returns:
a String representation of the policy

setMemoryStoreEvictionPolicy

public void setMemoryStoreEvictionPolicy(String evictionPolicy)
setMemoryStoreEvictionPolicy.

Specified by:
setMemoryStoreEvictionPolicy in interface CacheSampler
Parameters:
evictionPolicy - the new memory store eviction policy

getTimeToIdleSeconds

public long getTimeToIdleSeconds()
Configuration property accessor.

Specified by:
getTimeToIdleSeconds in interface CacheSampler
Returns:
TTI in config

setTimeToIdleSeconds

public void setTimeToIdleSeconds(long tti)
setTimeToIdleSeconds.

Specified by:
setTimeToIdleSeconds in interface CacheSampler
Parameters:
tti - the new time to idle seconds

getTimeToLiveSeconds

public long getTimeToLiveSeconds()
Configuration property accessor.

Specified by:
getTimeToLiveSeconds in interface CacheSampler
Returns:
TTL in config

setTimeToLiveSeconds

public void setTimeToLiveSeconds(long ttl)
setTimeToLiveSeconds.

Specified by:
setTimeToLiveSeconds in interface CacheSampler
Parameters:
ttl - the new time to live seconds

isDiskPersistent

public boolean isDiskPersistent()
Configuration property accessor.

Specified by:
isDiskPersistent in interface CacheSampler
Returns:
true if configured with disk persistence

getPersistenceStrategy

public String getPersistenceStrategy()
getPersistenceStrategy

Specified by:
getPersistenceStrategy in interface CacheSampler
Returns:
the strategy name
See Also:
PersistenceConfiguration

setDiskPersistent

public void setDiskPersistent(boolean diskPersistent)
setDiskPersistent.

Specified by:
setDiskPersistent in interface CacheSampler
Parameters:
diskPersistent - the new disk persistent

isOverflowToOffHeap

public boolean isOverflowToOffHeap()
isOverflowToOffHeap

Specified by:
isOverflowToOffHeap in interface CacheSampler
Returns:
true if configured for offheap

isEternal

public boolean isEternal()
Configuration property accessor.

Specified by:
isEternal in interface CacheSampler
Returns:
true if set to eternal in config

setEternal

public void setEternal(boolean eternal)
setEternal.

Specified by:
setEternal in interface CacheSampler
Parameters:
eternal - the new eternal

isOverflowToDisk

public boolean isOverflowToDisk()
Configuration property accessor.

Specified by:
isOverflowToDisk in interface CacheSampler
Returns:
true if overflow to disk specified in config

setOverflowToDisk

public void setOverflowToDisk(boolean overflowToDisk)
setOverflowToDisk.

Specified by:
setOverflowToDisk in interface CacheSampler
Parameters:
overflowToDisk - the new overflow to disk

isLoggingEnabled

public boolean isLoggingEnabled()
Configuration property accessor.

Specified by:
isLoggingEnabled in interface CacheSampler
Returns:
true if logging is enabled on the cache

setLoggingEnabled

public void setLoggingEnabled(boolean enabled)
setLoggingEnabled.

Specified by:
setLoggingEnabled in interface CacheSampler
Parameters:
enabled - the new logging enabled

isPinned

public boolean isPinned()
Configuration property accessor.

Specified by:
isPinned in interface CacheSampler
Returns:
true if the cache is pinned
See Also:
PinningConfiguration

getPinnedToStore

public String getPinnedToStore()
Configuration property accessor.

Specified by:
getPinnedToStore in interface CacheSampler
Returns:
the store to which this cache is pinned
See Also:
PinningConfiguration

getEvictedCount

public long getEvictedCount()
Number of elements evicted from the cache.

Specified by:
getEvictedCount in interface LegacyCacheStatistics
Returns:
Number of elements evicted from the cache

getExpiredCount

public long getExpiredCount()
Number of elements expired since creation or last clear.

Specified by:
getExpiredCount in interface LegacyCacheStatistics
Returns:
Number of expired elements

getInMemoryHitCount

public long getInMemoryHitCount()
Number of times a requested item was found in the Memory Store.

Specified by:
getInMemoryHitCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was found in memory

getOffHeapHitCount

public long getOffHeapHitCount()
Number of times a requested item was found in the off-heap store.

Specified by:
getOffHeapHitCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was found in off-heap

getOffHeapSize

@Deprecated
public long getOffHeapSize()
Deprecated. use getLocalOffHeapSize()

Number of elements in the off-heap store.

Specified by:
getOffHeapSize in interface LegacyCacheStatistics
Returns:
the number of elements in off-heap

getOnDiskHitCount

public long getOnDiskHitCount()
Number of times a requested item was found in the Disk Store.

Specified by:
getOnDiskHitCount in interface LegacyCacheStatistics
Returns:
the number of times a requested item was found on Disk, or 0 if there is no disk storage configured.

getOnDiskSize

@Deprecated
public long getOnDiskSize()
Deprecated. use getLocalDiskSize()

Number of elements in the DiskStore.

Specified by:
getOnDiskSize in interface LegacyCacheStatistics
Returns:
number of elements on disk

getLocalDiskSize

public long getLocalDiskSize()
Number of entries in the DiskStore.

Specified by:
getLocalDiskSize in interface LegacyCacheStatistics
Returns:
number of elements on disk

getLocalHeapSize

public long getLocalHeapSize()
Number of entries in the MemoryStore.

Specified by:
getLocalHeapSize in interface LegacyCacheStatistics
Returns:
the number of elements in memory

getLocalOffHeapSize

public long getLocalOffHeapSize()
Number of entries in the off-heap store.

Specified by:
getLocalOffHeapSize in interface LegacyCacheStatistics
Returns:
the number of elements in off-heap

getLocalDiskSizeInBytes

public long getLocalDiskSizeInBytes()
Number of of bytes used by entries in the DiskStore.

Specified by:
getLocalDiskSizeInBytes in interface LegacyCacheStatistics
Returns:
number of bytes used by elements on disk

getLocalHeapSizeInBytes

public long getLocalHeapSizeInBytes()
Number of of bytes used by entries in the MemoryStore.

Specified by:
getLocalHeapSizeInBytes in interface LegacyCacheStatistics
Returns:
the number of of bytes used by elements in memory

getLocalOffHeapSizeInBytes

public long getLocalOffHeapSizeInBytes()
Number of of bytes used by entries in the off-heap store.

Specified by:
getLocalOffHeapSizeInBytes in interface LegacyCacheStatistics
Returns:
the number of of bytes used by elements in off-heap

getPutCount

public long getPutCount()
Number of puts that has happened in the cache.

Specified by:
getPutCount in interface LegacyCacheStatistics
Returns:
Number of puts

getRemovedCount

public long getRemovedCount()
Number of elements removed since creation or last clear.

Specified by:
getRemovedCount in interface LegacyCacheStatistics
Returns:
Number of elements removed

getSize

public long getSize()
Size of the cache based on current accuracy settings.

Specified by:
getSize in interface LegacyCacheStatistics
Returns:
The size of the cache based on current accuracy setting

getInMemorySize

public long getInMemorySize()
Number of elements in the MemoryStore.

Specified by:
getInMemorySize in interface LegacyCacheStatistics
Returns:
the number of elements in memory

getUpdateCount

public long getUpdateCount()
Number of updates that as happened in the cache.

Specified by:
getUpdateCount in interface LegacyCacheStatistics
Returns:
Number of updates

getReplaceOneArgSuccessCount

public long getReplaceOneArgSuccessCount()
Description copied from interface: LegacyCacheStatistics
Number of one arg replace operations that succeeded.

Specified by:
getReplaceOneArgSuccessCount in interface LegacyCacheStatistics
Returns:
Number of replaces

getReplaceOneArgSuccessRate

public long getReplaceOneArgSuccessRate()
Description copied from interface: LegacyCacheStatistics
Rate of one arg replace operations that succeeded. Similar to most recent smaple

Specified by:
getReplaceOneArgSuccessRate in interface LegacyCacheStatistics
Returns:
Rate of replaces

getReplaceOneArgMissCount

public long getReplaceOneArgMissCount()
Description copied from interface: LegacyCacheStatistics
Number of one arg replace operations that missed.

Specified by:
getReplaceOneArgMissCount in interface LegacyCacheStatistics
Returns:
Number of replace misses

getReplaceOneArgMissRate

public long getReplaceOneArgMissRate()
Description copied from interface: LegacyCacheStatistics
Rate of one arg replace operations that missed.

Specified by:
getReplaceOneArgMissRate in interface LegacyCacheStatistics
Returns:
Rate of replace misses

getReplaceTwoArgSuccessCount

public long getReplaceTwoArgSuccessCount()
Description copied from interface: LegacyCacheStatistics
Number of two arg replace operations that succeeded.

Specified by:
getReplaceTwoArgSuccessCount in interface LegacyCacheStatistics
Returns:
Number of replaces

getReplaceTwoArgSuccessRate

public long getReplaceTwoArgSuccessRate()
Description copied from interface: LegacyCacheStatistics
Rate of two arg replace operations that succeeded.

Specified by:
getReplaceTwoArgSuccessRate in interface LegacyCacheStatistics
Returns:
Rate of replaces

getReplaceTwoArgMissCount

public long getReplaceTwoArgMissCount()
Description copied from interface: LegacyCacheStatistics
Number of two arg replace operations that missed.

Specified by:
getReplaceTwoArgMissCount in interface LegacyCacheStatistics
Returns:
Number of replace misses

getReplaceTwoArgMissRate

public long getReplaceTwoArgMissRate()
Description copied from interface: LegacyCacheStatistics
Rate of two arg replace operations that missed.

Specified by:
getReplaceTwoArgMissRate in interface LegacyCacheStatistics
Returns:
Rate of replace misses

getPutIfAbsentSuccessCount

public long getPutIfAbsentSuccessCount()
Description copied from interface: LegacyCacheStatistics
Number of putIfAbsent operations that succeeded.

Specified by:
getPutIfAbsentSuccessCount in interface LegacyCacheStatistics
Returns:
Number of putIfAbsents

getPutIfAbsentSuccessRate

public long getPutIfAbsentSuccessRate()
Description copied from interface: LegacyCacheStatistics
Rate of putIfAbsent operations that succeeded.

Specified by:
getPutIfAbsentSuccessRate in interface LegacyCacheStatistics
Returns:
Rate of putIfAbsents

getPutIfAbsentMissCount

public long getPutIfAbsentMissCount()
Description copied from interface: LegacyCacheStatistics
Number of putIfAbsent operations that missed.

Specified by:
getPutIfAbsentMissCount in interface LegacyCacheStatistics
Returns:
Number of putIfAbsent misses

getPutIfAbsentMissRate

public long getPutIfAbsentMissRate()
Description copied from interface: LegacyCacheStatistics
Rate of putIfAbsent operations that missed.

Specified by:
getPutIfAbsentMissRate in interface LegacyCacheStatistics
Returns:
Rate of putIfAbsent misses

getRemoveElementSuccessCount

public long getRemoveElementSuccessCount()
Description copied from interface: LegacyCacheStatistics
Number of removeElement operations that succeeded

Specified by:
getRemoveElementSuccessCount in interface LegacyCacheStatistics
Returns:
Number of removeElement operations

getRemoveElementSuccessRate

public long getRemoveElementSuccessRate()
Description copied from interface: LegacyCacheStatistics
Rate of removeElement operations that succeeded

Specified by:
getRemoveElementSuccessRate in interface LegacyCacheStatistics
Returns:
Rate of removeElement operations

getRemoveElementMissCount

public long getRemoveElementMissCount()
Description copied from interface: LegacyCacheStatistics
Number of removeElement operations that missed.

Specified by:
getRemoveElementMissCount in interface LegacyCacheStatistics
Returns:
Number of removeElement misses

getRemoveElementMissRate

public long getRemoveElementMissRate()
Description copied from interface: LegacyCacheStatistics
Rate of removeElement operations that missed.

Specified by:
getRemoveElementMissRate in interface LegacyCacheStatistics
Returns:
Rate of removeElement misses

deregistered

public void deregistered(CacheConfiguration config)
Indicates that this listener was removed from the given configuration

Specified by:
deregistered in interface CacheConfigurationListener

maxBytesLocalHeapChanged

public void maxBytesLocalHeapChanged(long oldValue,
                                     long newValue)
Indicates a change in the configuration for maxBytesLocalHeap setting

Specified by:
maxBytesLocalHeapChanged in interface CacheConfigurationListener
Parameters:
oldValue - old value in bytes
newValue - new value in bytes

maxBytesLocalDiskChanged

public void maxBytesLocalDiskChanged(long oldValue,
                                     long newValue)
Indicates a change in the configuration for maxBytesLocalDisk setting

Specified by:
maxBytesLocalDiskChanged in interface CacheConfigurationListener
Parameters:
oldValue - old value in bytes
newValue - new value in bytes

diskCapacityChanged

public void diskCapacityChanged(int oldCapacity,
                                int newCapacity)
Indicates a change in the configurations disk store capacity

Specified by:
diskCapacityChanged in interface CacheConfigurationListener
Parameters:
oldCapacity - previous capacity
newCapacity - new capacity

maxEntriesInCacheChanged

public void maxEntriesInCacheChanged(long oldCapacity,
                                     long newCapacity)
Indicates a change in the configuration for maxEntriesInCache setting

Specified by:
maxEntriesInCacheChanged in interface CacheConfigurationListener
Parameters:
oldCapacity - old value
newCapacity - new value

loggingChanged

public void loggingChanged(boolean oldValue,
                           boolean newValue)
Indicates a change in the configuration for enable/disable logging

Specified by:
loggingChanged in interface CacheConfigurationListener
Parameters:
oldValue - old value whether logging was enabled or not
newValue - new value whether logging was enabled or not

memoryCapacityChanged

public void memoryCapacityChanged(int oldCapacity,
                                  int newCapacity)
Indicates a change in the configurations memory store capacity

Specified by:
memoryCapacityChanged in interface CacheConfigurationListener
Parameters:
oldCapacity - previous capacity
newCapacity - new capacity

registered

public void registered(CacheConfiguration config)
Indicates that this listener was registered with the given configuration

Specified by:
registered in interface CacheConfigurationListener

timeToIdleChanged

public void timeToIdleChanged(long oldTimeToIdle,
                              long newTimeToIdle)
Indicates a change in the configurations time to idle

Specified by:
timeToIdleChanged in interface CacheConfigurationListener
Parameters:
oldTimeToIdle - previous time to idle value
newTimeToIdle - new time to idle value

timeToLiveChanged

public void timeToLiveChanged(long oldTimeToLive,
                              long newTimeToLive)
Indicates a change in the configurations time to live

Specified by:
timeToLiveChanged in interface CacheConfigurationListener
Parameters:
oldTimeToLive - previous time to live value
newTimeToLive - new time to live value

getAverageSearchTime

public long getAverageSearchTime()
Gets the average search time.

Specified by:
getAverageSearchTime in interface CacheSampler
Returns:
search time

getSearchesPerSecond

public long getSearchesPerSecond()
Get the number of searches that have finished execution in the last second.

Specified by:
getSearchesPerSecond in interface LegacyCacheStatistics
Returns:
the searches per second

getTransactional

public boolean getTransactional()
Is the cache a transactional one.

Specified by:
getTransactional in interface CacheSampler
Returns:
the transactional
See Also:
CacheConfiguration.TransactionalMode

getSearchable

public boolean getSearchable()
Is the cache configured for search.

Specified by:
getSearchable in interface CacheSampler
Returns:
the searchable
See Also:
Searchable

getSearchAttributes

public Map<String,String> getSearchAttributes()
Description copied from interface: CacheSampler
Get the declared search attributes and their type names. Note: doesn't deal with DynamicAttributeExctractor.

Specified by:
getSearchAttributes in interface CacheSampler
Returns:
map of search attribute name -> type name

getCacheSearchRate

public long getCacheSearchRate()
Gets the cache search rate.

Specified by:
getCacheSearchRate in interface CacheSampler
Returns:
search rate

getTransactionCommitRate

public long getTransactionCommitRate()
Gets the transaction commit rate.

Specified by:
getTransactionCommitRate in interface CacheSampler
Returns:
Xa commit rate

getCacheXaCommitsMostRecentSample

public long getCacheXaCommitsMostRecentSample()
Get most recent value of XA commits.

Specified by:
getCacheXaCommitsMostRecentSample in interface LegacyCacheStatistics
Returns:
the cache xa commits most recent sample

getTransactionRollbackRate

public long getTransactionRollbackRate()
Gets the transaction rollback rate.

Specified by:
getTransactionRollbackRate in interface CacheSampler
Returns:
Xa rollback rate

getCacheXaRollbacksMostRecentSample

public long getCacheXaRollbacksMostRecentSample()
Get most recent value of XA rollbacks.

Specified by:
getCacheXaRollbacksMostRecentSample in interface LegacyCacheStatistics
Returns:
the cache xa rollbacks most recent sample

isLocalHeapCountBased

public boolean isLocalHeapCountBased()
Check if the local heap is measured with ARC or in element count.

Specified by:
isLocalHeapCountBased in interface LegacyCacheStatistics
Returns:
true, if is local heap count based

getCacheHitRatio

public int getCacheHitRatio()
The ratio of hits to accesses (hits + misses).

Specified by:
getCacheHitRatio in interface LegacyCacheStatistics
Returns:
the ratio of hits to (hits + misses) (0 - 100)

getCacheHitRatioMostRecentSample

public int getCacheHitRatioMostRecentSample()
Get most recent value for cache hit ratio.

Specified by:
getCacheHitRatioMostRecentSample in interface LegacyCacheStatistics
Returns:
Most recent value for cache hit ratio

getCacheHitRatioSample

public SampledCounter getCacheHitRatioSample()
Get the SampledCounter for cache hit ratio.

Specified by:
getCacheHitRatioSample in interface CacheSampler
Returns:
the SampledCounter for cache hit ratio

getAverageGetTimeNanos

public long getAverageGetTimeNanos()
Description copied from interface: LegacyCacheStatistics
Average time in nanoseconds taken to get an element from the cache.

Specified by:
getAverageGetTimeNanos in interface LegacyCacheStatistics
Returns:
Average time taken for a get operation in nanoseconds

getCacheHitSample

public SampledCounter getCacheHitSample()
Get the SampledCounter for cache hit.

Specified by:
getCacheHitSample in interface CacheSampler
Returns:
the SampledCounter for cache hit count

getCacheHitInMemorySample

public SampledCounter getCacheHitInMemorySample()
Get the SampledCounter for in-memory cache hit.

Specified by:
getCacheHitInMemorySample in interface CacheSampler
Returns:
the SampledCounter for cache hit count in memory

getCacheHitOffHeapSample

public SampledCounter getCacheHitOffHeapSample()
Get the SampledCounter for off-heap cache hit.

Specified by:
getCacheHitOffHeapSample in interface CacheSampler
Returns:
the SampledCounter for cache hit count in off-heap

getCacheHitOnDiskSample

public SampledCounter getCacheHitOnDiskSample()
Get the SampledCounter for on-disk cache hit.

Specified by:
getCacheHitOnDiskSample in interface CacheSampler
Returns:
the SampledCounter for cache hit count on disk

getCacheMissSample

public SampledCounter getCacheMissSample()
Get the SampledCounter for cache miss.

Specified by:
getCacheMissSample in interface CacheSampler
Returns:
the SampledCounter for cache miss count

getCacheMissInMemorySample

public SampledCounter getCacheMissInMemorySample()
Get the SampledCounter for in-memory cache miss.

Specified by:
getCacheMissInMemorySample in interface CacheSampler
Returns:
the SampledCounter for cache miss count in memory

getCacheMissOffHeapSample

public SampledCounter getCacheMissOffHeapSample()
Get the SampledCounter for off-heap cache miss.

Specified by:
getCacheMissOffHeapSample in interface CacheSampler
Returns:
the SampledCounter for cache miss count in off-heap

getCacheMissOnDiskSample

public SampledCounter getCacheMissOnDiskSample()
Get the SampledCounter for on-disk cache miss.

Specified by:
getCacheMissOnDiskSample in interface CacheSampler
Returns:
the SampledCounter for cache miss count on disk

getCacheMissExpiredSample

public SampledCounter getCacheMissExpiredSample()
Get the SampledCounter for cache miss as result of the element getting expired.

Specified by:
getCacheMissExpiredSample in interface CacheSampler
Returns:
the SampledCounter for cache miss count and the reason for miss being the element got expired

getCacheMissNotFoundSample

public SampledCounter getCacheMissNotFoundSample()
Get the SampledCounter for cache miss as result of the element not found in cache.

Specified by:
getCacheMissNotFoundSample in interface CacheSampler
Returns:
the SampledCounter for cache miss not found count

getCacheElementEvictedSample

public SampledCounter getCacheElementEvictedSample()
Get the SampledCounter element evicted from cache.

Specified by:
getCacheElementEvictedSample in interface CacheSampler
Returns:
the SampledCounter for element evicted count

getCacheElementRemovedSample

public SampledCounter getCacheElementRemovedSample()
Get the SampledCounter element removed from cache.

Specified by:
getCacheElementRemovedSample in interface CacheSampler
Returns:
the SampledCounter for element removed count

getCacheElementExpiredSample

public SampledCounter getCacheElementExpiredSample()
Get the SampledCounter element expired from cache.

Specified by:
getCacheElementExpiredSample in interface CacheSampler
Returns:
Most recent value for element expired count

getCacheElementPutSample

public SampledCounter getCacheElementPutSample()
Get the SampledCounter element puts in the cache.

Specified by:
getCacheElementPutSample in interface CacheSampler
Returns:
the SampledCounter for number of element puts

getCacheElementUpdatedSample

public SampledCounter getCacheElementUpdatedSample()
Get the SampledCounter element updates , i.e. put() on elements with already existing keys in the cache

Specified by:
getCacheElementUpdatedSample in interface CacheSampler
Returns:
the SampledCounterd value for element update count

getAverageGetTimeSample

public SampledRateCounter getAverageGetTimeSample()
Get the SampledRateCounter for average time taken for get() operation in the cache.

Specified by:
getAverageGetTimeSample in interface CacheSampler
Returns:
the SampledRateCounter of average get time taken for a get operation

getAverageSearchTimeSample

public SampledRateCounter getAverageSearchTimeSample()
Get the SampledRateCounter for average search execution time for searches finishing within the last sample period.

Specified by:
getAverageSearchTimeSample in interface CacheSampler
Returns:
the SampledRateCounter of average search time taken

getSearchesPerSecondSample

public SampledCounter getSearchesPerSecondSample()
Get the SampledCounter for number of searches that have finished in the interval.

Specified by:
getSearchesPerSecondSample in interface CacheSampler
Returns:
the SampledCounter for number of searches

getCacheXaCommitsSample

public SampledCounter getCacheXaCommitsSample()
Get the SampledCounter for number of XA Transaction commits that have completed in the interval.

Specified by:
getCacheXaCommitsSample in interface CacheSampler
Returns:
the SampledCounter for number XA Transaction commits

getCacheXaRollbacksSample

public SampledCounter getCacheXaRollbacksSample()
Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval.

Specified by:
getCacheXaRollbacksSample in interface CacheSampler
Returns:
the SampledCounter for number XA Transaction rollbacks

getSizeSample

public SampledCounter getSizeSample()
Get the SampledCounter for cache size.

Specified by:
getSizeSample in interface CacheSampler
Returns:
the SampledCounter for cache size

getLocalHeapSizeSample

public SampledCounter getLocalHeapSizeSample()
Get the SampledCounter for local heap size.

Specified by:
getLocalHeapSizeSample in interface CacheSampler
Returns:
the SampledCounter for local heap size

getLocalHeapSizeInBytesSample

public SampledCounter getLocalHeapSizeInBytesSample()
Get the SampledCounter for local heap size in bytes.

Specified by:
getLocalHeapSizeInBytesSample in interface CacheSampler
Returns:
the SampledCounter for local heap size in bytes

getLocalOffHeapSizeSample

public SampledCounter getLocalOffHeapSizeSample()
Get the SampledCounter for local offheap size.

Specified by:
getLocalOffHeapSizeSample in interface CacheSampler
Returns:
the SampledCounter for local offheap size

getLocalOffHeapSizeInBytesSample

public SampledCounter getLocalOffHeapSizeInBytesSample()
Get the SampledCounter for local offheap size in bytes.

Specified by:
getLocalOffHeapSizeInBytesSample in interface CacheSampler
Returns:
the SampledCounter for local offheap size in bytes

getLocalDiskSizeSample

public SampledCounter getLocalDiskSizeSample()
Get the SampledCounter for local disk size.

Specified by:
getLocalDiskSizeSample in interface CacheSampler
Returns:
the SampledCounter for local disk size

getLocalDiskSizeInBytesSample

public SampledCounter getLocalDiskSizeInBytesSample()
Get the SampledCounter for local disk size in bytes.

Specified by:
getLocalDiskSizeInBytesSample in interface CacheSampler
Returns:
the SampledCounter for local disk size in bytes

getRemoteSizeSample

public SampledCounter getRemoteSizeSample()
Get the SampledCounter for remote size.

Specified by:
getRemoteSizeSample in interface CacheSampler
Returns:
the SampledCounter for remote size

getWriterQueueLengthSample

public SampledCounter getWriterQueueLengthSample()
Get the SampledCounter for writer queue length.

Specified by:
getWriterQueueLengthSample in interface CacheSampler
Returns:
the SampledCounter for writer queue length

getAverageSearchTimeNanos

public long getAverageSearchTimeNanos()
Description copied from interface: LegacyCacheStatistics
Get the average search execution time for searches finishing within the last sample period.

Specified by:
getAverageSearchTimeNanos in interface LegacyCacheStatistics
Returns:
the average search time nanos

getCacheClusterOfflineCount

public long getCacheClusterOfflineCount()
Description copied from interface: LegacyCacheStatistics
Count of cluster offline events for this node.

Specified by:
getCacheClusterOfflineCount in interface LegacyCacheStatistics
Returns:
count

getCacheClusterRejoinCount

public long getCacheClusterRejoinCount()
Description copied from interface: LegacyCacheStatistics
Count of cluster rejoin events for this node.

Specified by:
getCacheClusterRejoinCount in interface LegacyCacheStatistics
Returns:
count

getCacheClusterOnlineCount

public long getCacheClusterOnlineCount()
Description copied from interface: LegacyCacheStatistics
Count of cluster online events for this node.

Specified by:
getCacheClusterOnlineCount in interface LegacyCacheStatistics
Returns:
count

getCacheClusterOfflineMostRecentSample

public long getCacheClusterOfflineMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the cache cluster offline most recent sample.

Specified by:
getCacheClusterOfflineMostRecentSample in interface LegacyCacheStatistics
Returns:
the cache cluster offline most recent sample

getCacheClusterRejoinMostRecentSample

public long getCacheClusterRejoinMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the cache cluster rejoin most recent sample.

Specified by:
getCacheClusterRejoinMostRecentSample in interface LegacyCacheStatistics
Returns:
the cache cluster rejoin most recent sample

getCacheClusterOnlineMostRecentSample

public long getCacheClusterOnlineMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the cache cluster online most recent sample.

Specified by:
getCacheClusterOnlineMostRecentSample in interface LegacyCacheStatistics
Returns:
the cache cluster online most recent sample

getCacheClusterOfflineSample

public SampledCounter getCacheClusterOfflineSample()
Description copied from interface: CacheSampler
Get the SampledCounter for offline cache cluster events.

Specified by:
getCacheClusterOfflineSample in interface CacheSampler
Returns:
the SampledCounter for offline cache cluster events

getCacheClusterOnlineSample

public SampledCounter getCacheClusterOnlineSample()
Description copied from interface: CacheSampler
Get the SampledCounter for online cache cluster events.

Specified by:
getCacheClusterOnlineSample in interface CacheSampler
Returns:
the SampledCounter for online cache cluster events

getCacheClusterRejoinSample

public SampledCounter getCacheClusterRejoinSample()
Description copied from interface: CacheSampler
Get the SampledCounter for rejoin cache cluster events.

Specified by:
getCacheClusterRejoinSample in interface CacheSampler
Returns:
the SampledCounter for rejoin cache cluster events

getMostRecentRejoinTimeStampMillis

public long getMostRecentRejoinTimeStampMillis()
Description copied from interface: CacheSampler
Get the timestamp in nanos of the last rejoin.

Specified by:
getMostRecentRejoinTimeStampMillis in interface CacheSampler
Returns:
the most recent rejoin time stamp millis

getMostRecentRejoinTimestampMillisSample

public SampledCounter getMostRecentRejoinTimestampMillisSample()
Description copied from interface: CacheSampler
Get the SampledCounter for last rejoin timestamp.

Specified by:
getMostRecentRejoinTimestampMillisSample in interface CacheSampler
Returns:
the SampledCounter for last rejoin timestamp

getNonStopSuccessCount

public long getNonStopSuccessCount()
Description copied from interface: LegacyCacheStatistics
Gets the non stop success count.

Specified by:
getNonStopSuccessCount in interface LegacyCacheStatistics
Returns:
the non stop success count

getNonStopFailureCount

public long getNonStopFailureCount()
Description copied from interface: LegacyCacheStatistics
Gets the non stop failure count.

Specified by:
getNonStopFailureCount in interface LegacyCacheStatistics
Returns:
the non stop failure count

getNonStopRejoinTimeoutCount

public long getNonStopRejoinTimeoutCount()
Description copied from interface: LegacyCacheStatistics
Gets the non stop rejoin timeout count.

Specified by:
getNonStopRejoinTimeoutCount in interface LegacyCacheStatistics
Returns:
the non stop rejoin timeout count

getNonStopTimeoutCount

public long getNonStopTimeoutCount()
Description copied from interface: LegacyCacheStatistics
Gets the non stop timeout count.

Specified by:
getNonStopTimeoutCount in interface LegacyCacheStatistics
Returns:
the non stop timeout count

getNonStopSuccessMostRecentSample

public long getNonStopSuccessMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the non stop success most recent sample.

Specified by:
getNonStopSuccessMostRecentSample in interface LegacyCacheStatistics
Returns:
the non stop success most recent sample

getNonStopFailureMostRecentSample

public long getNonStopFailureMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the non stop failure most recent sample.

Specified by:
getNonStopFailureMostRecentSample in interface LegacyCacheStatistics
Returns:
the non stop failure most recent sample

getNonStopRejoinTimeoutMostRecentSample

public long getNonStopRejoinTimeoutMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the non stop rejoin most recent sample.

Specified by:
getNonStopRejoinTimeoutMostRecentSample in interface LegacyCacheStatistics
Returns:
the non stop rejoin most recent sample

getNonStopTimeoutMostRecentSample

public long getNonStopTimeoutMostRecentSample()
Description copied from interface: LegacyCacheStatistics
Gets the non stop timeout most recent sample.

Specified by:
getNonStopTimeoutMostRecentSample in interface LegacyCacheStatistics
Returns:
the non stop timeout most recent sample

getNonStopSuccessSample

public SampledCounter getNonStopSuccessSample()
Description copied from interface: CacheSampler
Gets the nonstop success sample.

Specified by:
getNonStopSuccessSample in interface CacheSampler
Returns:
the nonstop success sample

getNonStopFailureSample

public SampledCounter getNonStopFailureSample()
Description copied from interface: CacheSampler
Gets the nonstop failure sample.

Specified by:
getNonStopFailureSample in interface CacheSampler
Returns:
the nonstop failure sample

getNonStopRejoinTimeoutSample

public SampledCounter getNonStopRejoinTimeoutSample()
Description copied from interface: CacheSampler
Gets the nonstop rejoin sample.

Specified by:
getNonStopRejoinTimeoutSample in interface CacheSampler
Returns:
the nonstop rejoin sample

getNonStopTimeoutSample

public SampledCounter getNonStopTimeoutSample()
Description copied from interface: CacheSampler
Gets the nonstop timeout sample.

Specified by:
getNonStopTimeoutSample in interface CacheSampler
Returns:
the nonstop timeout sample

getNonStopSuccessRate

public long getNonStopSuccessRate()
Description copied from interface: CacheSampler
Gets the non stop success most recent sample.

Specified by:
getNonStopSuccessRate in interface CacheSampler
Returns:
the non stop success most recent sample

getNonStopFailureRate

public long getNonStopFailureRate()
Description copied from interface: CacheSampler
Gets the non stop failure most recent sample.

Specified by:
getNonStopFailureRate in interface CacheSampler
Returns:
the non stop failure most recent sample

getNonStopRejoinTimeoutRate

public long getNonStopRejoinTimeoutRate()
Description copied from interface: CacheSampler
Gets the non stop rejoin most recent sample.

Specified by:
getNonStopRejoinTimeoutRate in interface CacheSampler
Returns:
the non stop rejoin most recent sample

getNonStopTimeoutRate

public long getNonStopTimeoutRate()
Description copied from interface: CacheSampler
Gets the non stop timeout most recent sample.

Specified by:
getNonStopTimeoutRate in interface CacheSampler
Returns:
the non stop timeout most recent sample

getReplaceOneArgSuccessSample

public SampledCounter getReplaceOneArgSuccessSample()
Description copied from interface: CacheSampler
Gets the one arg replace success sample

Specified by:
getReplaceOneArgSuccessSample in interface CacheSampler
Returns:
one arg success sample

getReplaceOneArgMissSample

public SampledCounter getReplaceOneArgMissSample()
Description copied from interface: CacheSampler
Gets the one arg replace miss sample

Specified by:
getReplaceOneArgMissSample in interface CacheSampler
Returns:
one arg miss sample

getReplaceTwoArgSuccessSample

public SampledCounter getReplaceTwoArgSuccessSample()
Description copied from interface: CacheSampler
Gets the two arg replace success sample

Specified by:
getReplaceTwoArgSuccessSample in interface CacheSampler
Returns:
two arg success sample

getReplaceTwoArgMissSample

public SampledCounter getReplaceTwoArgMissSample()
Description copied from interface: CacheSampler
Gets the two arg replace miss sample

Specified by:
getReplaceTwoArgMissSample in interface CacheSampler
Returns:
two arg miss sample

getPutIfAbsentSuccessSample

public SampledCounter getPutIfAbsentSuccessSample()
Description copied from interface: CacheSampler
Gets the putIfAbsent success sample

Specified by:
getPutIfAbsentSuccessSample in interface CacheSampler
Returns:
putIfAbsent success sample

getPutIfAbsentMissSample

public SampledCounter getPutIfAbsentMissSample()
Description copied from interface: CacheSampler
Gets the putIfAbsent miss sample

Specified by:
getPutIfAbsentMissSample in interface CacheSampler
Returns:
putIfAbsent miss sample

getRemoveElementSuccessSample

public SampledCounter getRemoveElementSuccessSample()
Description copied from interface: CacheSampler
Gets the removeElement success sample

Specified by:
getRemoveElementSuccessSample in interface CacheSampler
Returns:
removeElement success sample

getRemoveElementMissSample

public SampledCounter getRemoveElementMissSample()
Description copied from interface: CacheSampler
Gets the removeElement miss sample

Specified by:
getRemoveElementMissSample in interface CacheSampler
Returns:
removeElement miss sample

getNonstopTimeoutRatio

public int getNonstopTimeoutRatio()
Description copied from interface: LegacyCacheStatistics
Get the ratio of nonstop timeouts+rejoin timeouts to operations

Specified by:
getNonstopTimeoutRatio in interface LegacyCacheStatistics
Returns:
the ratio of timeouts to operation (0 - 100)

ehcache

Copyright 2001-2014, Terracotta, Inc.