com.facebook.buck.util.cache

Class InstrumentingCacheStatsTracker

java.lang.Object

com.facebook.buck.util.cache.InstrumentingCacheStatsTracker

All Implemented Interfaces:

CacheStatsTracker

public final class InstrumentingCacheStatsTracker
extends Object
implements CacheStatsTracker

Class that tracks cache statistics, including timings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	InstrumentingCacheStatsTracker.TrackingCacheRequest Class that keeps record and timings of a single cache request

Nested classes/interfaces inherited from interface com.facebook.buck.util.cache.CacheStatsTracker

CacheStatsTracker.CacheRequest

Constructor Summary

Constructors

Constructor and Description
InstrumentingCacheStatsTracker()
InstrumentingCacheStatsTracker(Clock clock)

Method Summary

Modifier and Type	Method and Description
long	getAverageLoadTime()
long	getAverageMissTime()
long	getAverageRetrievalTime()
long	getTotalEvictionCount()
long	getTotalHitCount()
long	getTotalInvalidationCount()
long	getTotalLoadExceptionCount()
long	getTotalLoadSuccessCount()
long	getTotalLoadTime()
long	getTotalMissCount()
long	getTotalMissMatchCount()
long	getTotalMissTime()
long	getTotalRetrievalTime()
void	recordEviction() records a single eviction
void	recordEviction(long num)
void	recordInvalidation() records a single invalidation
void	recordInvalidation(long num)
CacheStatsTracker.CacheRequest	startRequest()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstrumentingCacheStatsTracker

public InstrumentingCacheStatsTracker()

InstrumentingCacheStatsTracker

public InstrumentingCacheStatsTracker(Clock clock)

Method Detail

startRequest

public CacheStatsTracker.CacheRequest startRequest()

Specified by:

startRequest in interface CacheStatsTracker

Returns:

a CacheRequest object that will keep record of stats and timing for this request on the cache

getTotalHitCount

public long getTotalHitCount()

Specified by:

getTotalHitCount in interface CacheStatsTracker

getTotalMissCount

public long getTotalMissCount()

Specified by:

getTotalMissCount in interface CacheStatsTracker

getTotalMissMatchCount

public long getTotalMissMatchCount()

Specified by:

getTotalMissMatchCount in interface CacheStatsTracker

getTotalEvictionCount

public long getTotalEvictionCount()

Specified by:

getTotalEvictionCount in interface CacheStatsTracker

getTotalInvalidationCount

public long getTotalInvalidationCount()

Specified by:

getTotalInvalidationCount in interface CacheStatsTracker

getTotalLoadSuccessCount

public long getTotalLoadSuccessCount()

Specified by:

getTotalLoadSuccessCount in interface CacheStatsTracker

getTotalLoadExceptionCount

public long getTotalLoadExceptionCount()

Specified by:

getTotalLoadExceptionCount in interface CacheStatsTracker

getTotalRetrievalTime

public long getTotalRetrievalTime()

Specified by:

getTotalRetrievalTime in interface CacheStatsTracker

getTotalLoadTime

public long getTotalLoadTime()

Specified by:

getTotalLoadTime in interface CacheStatsTracker

getTotalMissTime

public long getTotalMissTime()

Specified by:

getTotalMissTime in interface CacheStatsTracker

getAverageRetrievalTime

public long getAverageRetrievalTime()

Specified by:

getAverageRetrievalTime in interface CacheStatsTracker

Returns:

the average retrieval time as defined by total time / total requests, or 0 if no requests have been made

getAverageMissTime

public long getAverageMissTime()

Specified by:

getAverageMissTime in interface CacheStatsTracker

Returns:

the average miss time as defined by total time / total requests, or 0 if no requests have been made

getAverageLoadTime

public long getAverageLoadTime()

Specified by:

getAverageLoadTime in interface CacheStatsTracker

Returns:

the average load time as defined by total time / total requests, or 0 if no requests have been made

recordEviction

public void recordEviction()

records a single eviction

Specified by:

recordEviction in interface CacheStatsTracker

recordEviction

public void recordEviction(long num)

Specified by:

recordEviction in interface CacheStatsTracker

Parameters:

num - the number of evictions to record

recordInvalidation

public void recordInvalidation()

records a single invalidation

Specified by:

recordInvalidation in interface CacheStatsTracker

recordInvalidation

public void recordInvalidation(long num)

Specified by:

recordInvalidation in interface CacheStatsTracker

Parameters:

num - the number of invalidations to record