net.sf.ehcache.management.sampled
Interface CacheSampler

All Superinterfaces:

LegacyCacheStatistics

All Known Subinterfaces:

SampledCacheMBean

All Known Implementing Classes:

CacheSamplerImpl, SampledCache

public interface CacheSampler
extends LegacyCacheStatistics

An interface for exposing cache statistics. Extends from both LiveCacheStatistics and LegacyCacheStatistics

Author:

Abhishek Sanoujam, byoukste

Method Summary

void	flush() Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
long	getAverageGetTime()
SampledRateCounter	getAverageGetTimeSample() Get the SampledRateCounter for average time taken for get() operation in the cache
long	getAverageSearchTime()
SampledRateCounter	getAverageSearchTimeSample() Get the SampledRateCounter for average search execution time for searches finishing within the last sample period
SampledCounter	getCacheElementEvictedSample() Get the SampledCounter element evicted from cache
SampledCounter	getCacheElementExpiredSample() Get the SampledCounter element expired from cache
SampledCounter	getCacheElementPutSample() Get the SampledCounter element puts in the cache
SampledCounter	getCacheElementRemovedSample() Get the SampledCounter element removed from cache
SampledCounter	getCacheElementUpdatedSample() Get the SampledCounter element updates , i.e.
long	getCacheEvictionRate()
long	getCacheExpirationRate()
SampledCounter	getCacheHitInMemorySample() Get the SampledCounter for in-memory cache hit
SampledCounter	getCacheHitOffHeapSample() Get the SampledCounter for off-heap cache hit
SampledCounter	getCacheHitOnDiskSample() Get the SampledCounter for on-disk cache hit
long	getCacheHitRate()
SampledCounter	getCacheHitRatioSample() Get the SampledCounter for cache hit ratio
SampledCounter	getCacheHitSample() Get the SampledCounter for cache hit
long	getCacheInMemoryHitRate()
long	getCacheInMemoryMissRate()
SampledCounter	getCacheMissExpiredSample() Get the SampledCounter for cache miss as result of the element getting expired
SampledCounter	getCacheMissInMemorySample() Get the SampledCounter for in-memory cache miss
SampledCounter	getCacheMissNotFoundSample() Get the SampledCounter for cache miss as result of the element not found in cache
SampledCounter	getCacheMissOffHeapSample() Get the SampledCounter for off-heap cache miss
SampledCounter	getCacheMissOnDiskSample() Get the SampledCounter for on-disk cache miss
long	getCacheMissRate()
SampledCounter	getCacheMissSample() Get the SampledCounter for cache miss
long	getCacheOffHeapHitRate()
long	getCacheOffHeapMissRate()
long	getCacheOnDiskHitRate()
long	getCacheOnDiskMissRate()
long	getCachePutRate()
long	getCacheRemoveRate()
long	getCacheSearchRate()
long	getCacheUpdateRate()
SampledCounter	getCacheXaCommitsSample() Get the SampledCounter for number of XA Transaction commits that have completed in the interval
SampledCounter	getCacheXaRollbacksSample() Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval
long	getDiskExpiryThreadIntervalSeconds() Configuration property accessor
boolean	getHasWriteBehindWriter() Is there a registered Write-behind CacheWriter
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
int	getMaxEntriesInCache() Configuration property accessor
long	getMaxEntriesLocalDisk() Configuration property accessor
long	getMaxEntriesLocalHeap() Configuration property accessor
String	getMemoryStoreEvictionPolicy() Configuration property accessor
String	getPinnedToStore() Configuration property accessor
boolean	getSearchable() Is the cache configured for search
SampledCounter	getSearchesPerSecondSample() Get the SampledCounter for number of searches that have finished in the interval
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()
long	getTransactionRollbackRate()
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
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	isLoggingEnabled() Configuration property accessor
boolean	isNodeBulkLoadEnabled() Is the cache in bulk-load mode locally?
boolean	isOverflowToDisk() Configuration property accessor
boolean	isPinned() Configuration property accessor
boolean	isTerracottaClustered() Is the cache configured with Terracotta clustering?
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(int 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

Methods inherited from interface net.sf.ehcache.management.sampled.LegacyCacheStatistics

dispose, getAverageGetTimeNanos, getAverageGetTimeNanosMostRecentSample, getAverageSearchTimeNanos, getCacheElementEvictedMostRecentSample, getCacheElementExpiredMostRecentSample, getCacheElementPutMostRecentSample, getCacheElementRemovedMostRecentSample, getCacheElementUpdatedMostRecentSample, getCacheHitCount, getCacheHitInMemoryMostRecentSample, getCacheHitMostRecentSample, getCacheHitOffHeapMostRecentSample, getCacheHitOnDiskMostRecentSample, getCacheHitRatio, getCacheHitRatioMostRecentSample, getCacheMissCount, getCacheMissCountExpired, getCacheMissExpiredMostRecentSample, getCacheMissInMemoryMostRecentSample, getCacheMissMostRecentSample, getCacheMissNotFoundMostRecentSample, getCacheMissOffHeapMostRecentSample, getCacheMissOnDiskMostRecentSample, getCacheName, getCacheXaCommitsMostRecentSample, getCacheXaRollbacksMostRecentSample, getEvictedCount, getExpiredCount, getInMemoryHitCount, getInMemoryMissCount, getInMemorySize, getLocalDiskSize, getLocalDiskSizeInBytes, getLocalHeapSize, getLocalHeapSizeInBytes, getLocalOffHeapSize, getLocalOffHeapSizeInBytes, getMaxGetTimeNanos, getMinGetTimeNanos, getOffHeapHitCount, getOffHeapMissCount, getOffHeapSize, getOnDiskHitCount, getOnDiskMissCount, getOnDiskSize, getPutCount, getRemovedCount, getSearchesPerSecond, getSize, getUpdateCount, getXaCommitCount, getXaRecoveredCount, getXaRollbackCount

Method Detail

isEnabled

boolean isEnabled()

Is the cache enabled?

setNodeBulkLoadEnabled

void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)

Enabled/disable bulk-load mode for this node.

isClusterBulkLoadEnabled

boolean isClusterBulkLoadEnabled()

Is the cache in bulk-load mode cluster-wide?

isNodeBulkLoadEnabled

boolean isNodeBulkLoadEnabled()

Is the cache in bulk-load mode locally?

setEnabled

void setEnabled(boolean enabled)

Enabled/disable the cache.

removeAll

void removeAll()

Removes all cached items.

flush

void flush()

Flushes all cache items from memory to the disk store, and from the DiskStore to disk.

getStatus

String getStatus()

Gets the status attribute of the Cache.

Returns:

The status value from the Status enum class

isTerracottaClustered

boolean isTerracottaClustered()

Is the cache configured with Terracotta clustering?

Returns:

true if clustered with terracotta

getTerracottaConsistency

String getTerracottaConsistency()

Returns a textual description of a Terracotta-clustered cache's consistency mode.

Returns:

"STRONG", "EVENTUAL", or "na" if the cache is not Terracotta-clustered

getMaxEntriesLocalHeap

long getMaxEntriesLocalHeap()

Configuration property accessor

Returns:

Max entries local heap config setting value

setMaxEntriesLocalHeap

void setMaxEntriesLocalHeap(long maxEntries)

setMaxEntriesLocalHeap

Parameters:

maxEntries -

getMaxBytesLocalHeap

long getMaxBytesLocalHeap()

Configuration property accessor

Returns:

Max bytes local heap config setting value

setMaxBytesLocalHeap

void setMaxBytesLocalHeap(long maxBytes)

setMaxBytesLocalHeap

Parameters:

maxBytes -

setMaxBytesLocalHeapAsString

void setMaxBytesLocalHeapAsString(String maxBytes)

setMaxBytesLocalHeap

Parameters:

maxBytes -

getMaxBytesLocalHeapAsString

String getMaxBytesLocalHeapAsString()

Configuration property accessor

Returns:

Max bytes local heap config setting value as string

getMaxBytesLocalOffHeap

long getMaxBytesLocalOffHeap()

Configuration property accessor

Returns:

Max bytes local offheap config setting value

getMaxBytesLocalOffHeapAsString

String getMaxBytesLocalOffHeapAsString()

Configuration property accessor

Returns:

Max bytes local offheap config setting value as string

getMaxEntriesLocalDisk

long getMaxEntriesLocalDisk()

Configuration property accessor

Returns:

Max entries local disk config setting value

setMaxEntriesLocalDisk

void setMaxEntriesLocalDisk(long maxEntries)

setMaxEntriesLocalDisk

Parameters:

maxEntries -

getMaxElementsOnDisk

int getMaxElementsOnDisk()

Configuration property accessor

Returns:

Max elements on disk config setting value

getMaxEntriesInCache

int getMaxEntriesInCache()

Configuration property accessor

Returns:

Max entries in cache config setting value

setMaxElementsOnDisk

void setMaxElementsOnDisk(int maxElements)

setMaxElementsOnDisk

Parameters:

maxElements -

setMaxEntriesInCache

void setMaxEntriesInCache(int maxEntries)

setMaxEntriesInCache

Parameters:

maxEntriesInCache -

getMaxBytesLocalDisk

long getMaxBytesLocalDisk()

Configuration property accessor

Returns:

Max bytes local disk config setting value

setMaxBytesLocalDisk

void setMaxBytesLocalDisk(long maxBytes)

setMaxBytesLocalDisk

Parameters:

maxBytes -

setMaxBytesLocalDiskAsString

void setMaxBytesLocalDiskAsString(String maxBytes)

setMaxBytesLocalDisk

Parameters:

maxBytes -

getMaxBytesLocalDiskAsString

String getMaxBytesLocalDiskAsString()

Configuration property accessor

Returns:

Max bytes local disk config setting value as string

getMemoryStoreEvictionPolicy

String getMemoryStoreEvictionPolicy()

Configuration property accessor

Returns:

a String representation of the policy

setMemoryStoreEvictionPolicy

void setMemoryStoreEvictionPolicy(String evictionPolicy)

setMemoryStoreEvictionPolicy

Parameters:

evictionPolicy -

isEternal

boolean isEternal()

Configuration property accessor

Returns:

true if set to eternal in config

setEternal

void setEternal(boolean eternal)

setEternal

Parameters:

eternal -

getTimeToIdleSeconds

long getTimeToIdleSeconds()

Configuration property accessor

Returns:

TTI in config

setTimeToIdleSeconds

void setTimeToIdleSeconds(long tti)

setTimeToIdleSeconds

Parameters:

tti -

getTimeToLiveSeconds

long getTimeToLiveSeconds()

Configuration property accessor

Returns:

TTL in config

setTimeToLiveSeconds

void setTimeToLiveSeconds(long ttl)

setTimeToLiveSeconds

Parameters:

ttl -

isOverflowToDisk

boolean isOverflowToDisk()

Configuration property accessor

Returns:

true if overflow to disk specified in config

setOverflowToDisk

void setOverflowToDisk(boolean overflowToDisk)

setOverflowToDisk

Parameters:

overflowToDisk -

isDiskPersistent

boolean isDiskPersistent()

Configuration property accessor

Returns:

true if configured with disk persistence

setDiskPersistent

void setDiskPersistent(boolean diskPersistent)

setDiskPersistent

Parameters:

diskPersistent -

getDiskExpiryThreadIntervalSeconds

long getDiskExpiryThreadIntervalSeconds()

Configuration property accessor

Returns:

Value for disk expiry thread interval in seconds specified in config

setDiskExpiryThreadIntervalSeconds

void setDiskExpiryThreadIntervalSeconds(long seconds)

setDiskExpiryThreadIntervalSeconds

Parameters:

seconds -

isLoggingEnabled

boolean isLoggingEnabled()

Configuration property accessor

Returns:

true if logging is enabled on the cache

setLoggingEnabled

void setLoggingEnabled(boolean enabled)

setLoggingEnabled

Parameters:

enabled -

isPinned

boolean isPinned()

Configuration property accessor

Returns:

true if the cache is pinned

See Also:

PinningConfiguration

getPinnedToStore

String getPinnedToStore()

Configuration property accessor

Returns:

the store to which this cache is pinned

See Also:

PinningConfiguration

getHasWriteBehindWriter

boolean getHasWriteBehindWriter()

Is there a registered Write-behind CacheWriter

getWriterQueueLength

long getWriterQueueLength()

Returns the total length of all write-behind queues for this cache

Specified by:

getWriterQueueLength in interface LegacyCacheStatistics

Returns:

writer-behind queue length

getWriterMaxQueueSize

int getWriterMaxQueueSize()

Returns the maximum size of any write-behind queues.

Returns:

Maximum elements that can be queued for processing by the write-behind writer

See Also:

CacheWriterConfiguration.getWriteBehindMaxQueueSize()

getWriterConcurrency

int getWriterConcurrency()

Returns the number of configured write-behind queues/threads.

Returns:

Number of configured processing queues/threads for use by the write-behind writer

See Also:

CacheWriterConfiguration.getWriteBehindConcurrency()

getTransactional

boolean getTransactional()

Is the cache a transactional one

See Also:

CacheConfiguration.TransactionalMode

getTransactionCommitRate

long getTransactionCommitRate()

Returns:

Xa commit rate

getTransactionRollbackRate

long getTransactionRollbackRate()

Returns:

Xa rollback rate

getSearchable

boolean getSearchable()

Is the cache configured for search

See Also:

Searchable

getCacheSearchRate

long getCacheSearchRate()

Returns:

search rate

getAverageSearchTime

long getAverageSearchTime()

Returns:

search time

getCacheHitRate

long getCacheHitRate()

Returns:

hit rate

getCacheInMemoryHitRate

long getCacheInMemoryHitRate()

Returns:

in-memory hit rate

getCacheOffHeapHitRate

long getCacheOffHeapHitRate()

Returns:

off-heap hit rate

getCacheOnDiskHitRate

long getCacheOnDiskHitRate()

Returns:

on-disk hit rate

getCacheMissRate

long getCacheMissRate()

Returns:

miss rate

getCacheInMemoryMissRate

long getCacheInMemoryMissRate()

Returns:

in-memory miss rate

getCacheOffHeapMissRate

long getCacheOffHeapMissRate()

Returns:

off-heap miss rate

getCacheOnDiskMissRate

long getCacheOnDiskMissRate()

Returns:

on-disk miss rate

getCachePutRate

long getCachePutRate()

Returns:

put rate

getCacheUpdateRate

long getCacheUpdateRate()

Returns:

update rate

getCacheRemoveRate

long getCacheRemoveRate()

Returns:

remove rate

getCacheEvictionRate

long getCacheEvictionRate()

Returns:

eviction rate

getCacheExpirationRate

long getCacheExpirationRate()

Returns:

expiration rate

getAverageGetTime

long getAverageGetTime()

Returns:

average get time (nanos.)

getCacheHitSample

SampledCounter getCacheHitSample()

Get the SampledCounter for cache hit

Returns:

the SampledCounter for cache hit count

getCacheHitRatioSample

SampledCounter getCacheHitRatioSample()

Get the SampledCounter for cache hit ratio

Returns:

the SampledCounter for cache hit ratio

getCacheHitInMemorySample

SampledCounter getCacheHitInMemorySample()

Get the SampledCounter for in-memory cache hit

Returns:

the SampledCounter for cache hit count in memory

getCacheHitOffHeapSample

SampledCounter getCacheHitOffHeapSample()

Get the SampledCounter for off-heap cache hit

Returns:

the SampledCounter for cache hit count in off-heap

getCacheHitOnDiskSample

SampledCounter getCacheHitOnDiskSample()

Get the SampledCounter for on-disk cache hit

Returns:

the SampledCounter for cache hit count on disk

getCacheMissSample

SampledCounter getCacheMissSample()

Get the SampledCounter for cache miss

Returns:

the SampledCounter for cache miss count

getCacheMissInMemorySample

SampledCounter getCacheMissInMemorySample()

Get the SampledCounter for in-memory cache miss

Returns:

the SampledCounter for cache miss count in memory

getCacheMissOffHeapSample

SampledCounter getCacheMissOffHeapSample()

Get the SampledCounter for off-heap cache miss

Returns:

the SampledCounter for cache miss count in off-heap

getCacheMissOnDiskSample

SampledCounter getCacheMissOnDiskSample()

Get the SampledCounter for on-disk cache miss

Returns:

the SampledCounter for cache miss count on disk

getCacheMissExpiredSample

SampledCounter getCacheMissExpiredSample()

Get the SampledCounter for cache miss as result of the element getting expired

Returns:

the SampledCounter for cache miss count and the reason for miss being the element got expired

getCacheMissNotFoundSample

SampledCounter getCacheMissNotFoundSample()

Get the SampledCounter for cache miss as result of the element not found in cache

Returns:

the SampledCounter for cache miss not found count

getCacheElementEvictedSample

SampledCounter getCacheElementEvictedSample()

Get the SampledCounter element evicted from cache

Returns:

the SampledCounter for element evicted count

getCacheElementRemovedSample

SampledCounter getCacheElementRemovedSample()

Get the SampledCounter element removed from cache

Returns:

the SampledCounter for element removed count

getCacheElementExpiredSample

SampledCounter getCacheElementExpiredSample()

Get the SampledCounter element expired from cache

Returns:

Most recent value for element expired count

getCacheElementPutSample

SampledCounter getCacheElementPutSample()

Get the SampledCounter element puts in the cache

Returns:

the SampledCounter for number of element puts

getCacheElementUpdatedSample

SampledCounter getCacheElementUpdatedSample()

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

Returns:

the SampledCounterd value for element update count

getAverageGetTimeSample

SampledRateCounter getAverageGetTimeSample()

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

Returns:

the SampledRateCounter of average get time taken for a get operation

getAverageSearchTimeSample

SampledRateCounter getAverageSearchTimeSample()

Get the SampledRateCounter for average search execution time for searches finishing within the last sample period

Returns:

the SampledRateCounter of average search time taken

getSearchesPerSecondSample

SampledCounter getSearchesPerSecondSample()

Get the SampledCounter for number of searches that have finished in the interval

Returns:

the SampledCounter for number of searches

getCacheXaCommitsSample

SampledCounter getCacheXaCommitsSample()

Get the SampledCounter for number of XA Transaction commits that have completed in the interval

Returns:

the SampledCounter for number XA Transaction commits

getCacheXaRollbacksSample

SampledCounter getCacheXaRollbacksSample()

Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval

Returns:

the SampledCounter for number XA Transaction rollbacks