net.sf.ehcache.statistics.sampled
Interface CacheStatisticsSampler

All Superinterfaces:

SampledCacheStatistics

All Known Implementing Classes:

SampledCacheStatisticsImpl, SampledCacheStatisticsWrapper

public interface CacheStatisticsSampler
extends SampledCacheStatistics

An interface for statistic samplers that expose the counters that track the actual sampled cache statistics.

Author:

byoukste

Field Summary

static int	DEFAULT_HISTORY_SIZE The default history size for SampledCounter objects.
static int	DEFAULT_INTERVAL_SECS The default interval for sampling events for SampledCounter objects.
static int	DEFAULT_SEARCH_INTERVAL_SEC The default interval in seconds for the SampledRateCounter for recording the average search rate counter

Method Summary

SampledRateCounter	getAverageGetTimeNanosSample() Get the SampledRateCounter for average time taken for get() operation in the cache
SampledRateCounter	getAverageGetTimeSample() Deprecated.
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.
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
SampledCounter	getCacheHitRatioSample() Get the SampledCounter for cache hit ratio
SampledCounter	getCacheHitSample() Get the SampledCounter for cache hit
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
SampledCounter	getCacheMissSample() Get the SampledCounter for cache miss
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
SampledCounter	getSearchesPerSecondSample() Get the SampledCounter for number of searches that have finished in the interval

Methods inherited from interface net.sf.ehcache.statistics.sampled.SampledCacheStatistics

clearStatistics, dispose, getAverageGetTimeMostRecentSample, getAverageGetTimeNanosMostRecentSample, getAverageSearchTime, getCacheElementEvictedMostRecentSample, getCacheElementExpiredMostRecentSample, getCacheElementPutMostRecentSample, getCacheElementRemovedMostRecentSample, getCacheElementUpdatedMostRecentSample, getCacheHitInMemoryMostRecentSample, getCacheHitMostRecentSample, getCacheHitOffHeapMostRecentSample, getCacheHitOnDiskMostRecentSample, getCacheHitRatioMostRecentSample, getCacheMissExpiredMostRecentSample, getCacheMissInMemoryMostRecentSample, getCacheMissMostRecentSample, getCacheMissNotFoundMostRecentSample, getCacheMissOffHeapMostRecentSample, getCacheMissOnDiskMostRecentSample, getCacheXaCommitsMostRecentSample, getCacheXaRollbacksMostRecentSample, getSearchesPerSecond, getStatisticsAccuracy, getStatisticsAccuracyDescription, isSampledStatisticsEnabled

Field Detail

DEFAULT_SEARCH_INTERVAL_SEC

static final int DEFAULT_SEARCH_INTERVAL_SEC

The default interval in seconds for the SampledRateCounter for recording the average search rate counter

See Also:

Constant Field Values

DEFAULT_HISTORY_SIZE

static final int DEFAULT_HISTORY_SIZE

The default history size for SampledCounter objects.

See Also:

Constant Field Values

DEFAULT_INTERVAL_SECS

static final int DEFAULT_INTERVAL_SECS

The default interval for sampling events for SampledCounter objects.

See Also:

Constant Field Values

Method Detail

getCacheHitSample

SampledCounter getCacheHitSample()

Get the SampledCounter for cache hit

Returns:

the SampledCounter for cache hit count

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

getCacheHitRatioSample

SampledCounter getCacheHitRatioSample()

Get the SampledCounter for cache hit ratio

Returns:

the SampledCounter for cache hit ratio

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

@Deprecated
SampledRateCounter getAverageGetTimeSample()

Deprecated.

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

getAverageGetTimeNanosSample

SampledRateCounter getAverageGetTimeNanosSample()

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