net.sf.ehcache.management.sampled
Interface LegacyCacheStatistics

All Known Subinterfaces:

CacheSampler, SampledCacheMBean

All Known Implementing Classes:

CacheSamplerImpl, SampledCache

public interface LegacyCacheStatistics

Interface for sampled usage statistics of a Cache

Since:

1.7

Author:

Abhishek Sanoujam

Method Summary

void	dispose() Method used to dispose this statistics
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
long	getAverageSearchTimeNanos() Get the average search execution time for searches finishing within the last sample period
long	getCacheElementEvictedMostRecentSample() Get most recent value element evicted from cache
long	getCacheElementExpiredMostRecentSample() Get most recent value element expired from cache
long	getCacheElementPutMostRecentSample() Get most recent value element puts in the cache
long	getCacheElementRemovedMostRecentSample() Get most recent value element removed from cache
long	getCacheElementUpdatedMostRecentSample() Get most recent value element updates , i.e.
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
long	getCacheHitMostRecentSample() Get most recent value for cache hit
long	getCacheHitOffHeapMostRecentSample() Get most recent value for off-heap cache hit
long	getCacheHitOnDiskMostRecentSample() Get most recent value for on-disk cache hit
int	getCacheHitRatio() The ratio of hits to accesses (hits + misses).
int	getCacheHitRatioMostRecentSample() Get most recent value for cache hit ratio
long	getCacheMissCount() Number of times a requested element was not found in the cache.
long	getCacheMissCountExpired()
long	getCacheMissExpiredMostRecentSample() Get most recent value for cache miss as result of the element getting expired
long	getCacheMissInMemoryMostRecentSample() Get most recent value 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
long	getCacheMissOffHeapMostRecentSample() Get most recent value for off-heap cache miss
long	getCacheMissOnDiskMostRecentSample() Get most recent value for on-disk cache miss
String	getCacheName()
long	getCacheXaCommitsMostRecentSample() Get most recent value of XA commits
long	getCacheXaRollbacksMostRecentSample() Get most recent value of XA rollbacks
long	getEvictedCount() Number of elements evicted from the cache
long	getExpiredCount() Number of elements expired since creation or last clear
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() Deprecated. use getLocalHeapSize()
long	getLocalDiskSize() Number of entries in the DiskStore
long	getLocalDiskSizeInBytes() Number of of bytes used by entries in the DiskStore
long	getLocalHeapSize() Number of entries in the MemoryStore
long	getLocalHeapSizeInBytes() Number of of bytes used by entries in the MemoryStore
long	getLocalOffHeapSize() Number of entries in the off-heap store
long	getLocalOffHeapSizeInBytes() Number of of bytes used by entries in the off-heap store
long	getMaxGetTimeNanos() Return maximum time taken for a get operation in the cache in milliseconds
long	getMinGetTimeNanos() Return minimum time taken for a get operation in the cache in nanoseconds
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()
long	getPutCount() Number of puts that has happened in the cache
long	getRemovedCount() Number of elements removed since creation or last clear
long	getSearchesPerSecond() Get the number of searches that have finished execution in the last second
long	getSize() Size of the cache based on current accuracy settings.
long	getUpdateCount() Number of updates that as happened in the cache
long	getWriterQueueLength() Gets the size of the write-behind queue, if any.
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

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()

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)

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. use getLocalHeapSize()

Number of elements in the MemoryStore

Returns:

the number of elements in memory

getOffHeapSize

@Deprecated
long getOffHeapSize()

Deprecated. use getLocalOffHeapSize()

Number of elements in the off-heap store

Returns:

the number of elements in off-heap

getOnDiskSize

@Deprecated
long getOnDiskSize()

Deprecated. use getLocalDiskSize()

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

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

getCacheName

String getCacheName()

Returns:

the name of the Ehcache

getMaxGetTimeNanos

long getMaxGetTimeNanos()

Return maximum time taken for a get operation in the cache in milliseconds

Returns:

maximum time taken for a get operation in the cache in milliseconds

getMinGetTimeNanos

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

getSearchesPerSecond

long getSearchesPerSecond()

Get the number of searches that have finished execution in the last second

getCacheXaCommitsMostRecentSample

long getCacheXaCommitsMostRecentSample()

Get most recent value of XA commits

getCacheXaRollbacksMostRecentSample

long getCacheXaRollbacksMostRecentSample()

Get most recent value of XA rollbacks