org.ehcache.core.statistics

Interface CacheStatistics

public interface CacheStatistics

All statistics relative to a cache and its underlying tiers.

Method Summary

Modifier and Type	Method and Description
void	clear() Reset the values for this cache and its underlying tiers.
long	getCacheEvictions() How many evictions occurred on the cache since its creation or the latest clear()
long	getCacheExpirations() How many expirations occurred on the cache since its creation or the latest clear()
long	getCacheGets() How many gets occurred on the cache since its creation or the latest clear()
float	getCacheHitPercentage() The percentage of hits compared to all gets since the cache creation or the latest clear()
long	getCacheHits() How many hits occurred on the cache since its creation or the latest clear()
long	getCacheMisses() How many misses occurred on the cache since its creation or the latest clear()
float	getCacheMissPercentage() The percentage of misses compared to all gets since the cache creation or the latest clear()
long	getCachePuts() How many puts occurred on the cache since its creation or the latest clear()
long	getCacheRemovals() How many removals occurred on the cache since its creation or the latest clear()
java.util.Map<java.lang.String,TierStatistics>	getTierStatistics() Map of tier statistics on this cache.
<T extends java.lang.Enum<T>,S extends ChainedOperationObserver<? super T>> void	registerDerivedStatistic(java.lang.Class<T> outcomeClass, java.lang.String statName, S derivedStatistic) Register a derived statistic to one of the existing statistic.

Method Detail

getTierStatistics

java.util.Map<java.lang.String,TierStatistics> getTierStatistics()

Map of tier statistics on this cache. Per tier name

Returns:

tier statistics per tier name

registerDerivedStatistic

<T extends java.lang.Enum<T>,S extends ChainedOperationObserver<? super T>> void registerDerivedStatistic(java.lang.Class<T> outcomeClass,
                                                                                                          java.lang.String statName,
                                                                                                          S derivedStatistic)

Register a derived statistic to one of the existing statistic.

Type Parameters:

T - type of the outcome

S - type of the derived statistic

Parameters:

outcomeClass - the enum of the possible outcomes

statName - name of the statistic we are looking for

derivedStatistic - derived statistic to register

clear

void clear()

Reset the values for this cache and its underlying tiers.

Implementation note: Calling clear doesn't really clear the data. It freezes the actual values and compensate for them when returning a result.

getCacheHits

long getCacheHits()

How many hits occurred on the cache since its creation or the latest clear()

Returns:

hit count

getCacheHitPercentage

float getCacheHitPercentage()

The percentage of hits compared to all gets since the cache creation or the latest clear()

Returns:

hit percentage

getCacheMisses

long getCacheMisses()

How many misses occurred on the cache since its creation or the latest clear()

Returns:

miss count

getCacheMissPercentage

float getCacheMissPercentage()

The percentage of misses compared to all gets since the cache creation or the latest clear()

Returns:

miss count

getCacheGets

long getCacheGets()

How many gets occurred on the cache since its creation or the latest clear()

Returns:

get count

getCachePuts

long getCachePuts()

How many puts occurred on the cache since its creation or the latest clear()

Returns:

put count

getCacheRemovals

long getCacheRemovals()

How many removals occurred on the cache since its creation or the latest clear()

Returns:

removal count

getCacheEvictions

long getCacheEvictions()

How many evictions occurred on the cache since its creation or the latest clear()

Returns:

eviction count

getCacheExpirations

long getCacheExpirations()

How many expirations occurred on the cache since its creation or the latest clear()

Returns:

expiration count