com.github.rollingmetrics.hitratio

Interface HitRatio

All Known Implementing Classes:

ResetOnSnapshotHitRatio, ResetPeriodicallyHitRatio, SmoothlyDecayingRollingHitRatio, UniformHitRatio

public interface HitRatio

The metric for hit ratio measurement.

See Also:

SmoothlyDecayingRollingHitRatio, ResetOnSnapshotHitRatio, ResetPeriodicallyHitRatio, UniformHitRatio

Method Summary

Modifier and Type	Method and Description
double	getHitRatio() Returns the ratio between hits and misses
default void	incrementHitCount() Registers the fact of single hit.
default void	incrementMissCount() Registers the fact of single miss.
void	update(int hitCount, int totalCount) Registers an result of bulk operations.

Method Detail

incrementHitCount

default void incrementHitCount()

Registers the fact of single hit.

Example of usage:

         Something cached = cache.get(id);
         if (cached != null) {
             hitRatio.incrementHitCount();
         } else {
             hitRatio.incrementMissCount();
         }
     
 

incrementMissCount

default void incrementMissCount()

Registers the fact of single miss.

Example of usage:

         Something cached = cache.get(id);
         if (cached != null) {
             hitRatio.incrementHitCount();
         } else {
             hitRatio.incrementMissCount();
         }
     
 

update

void update(int hitCount,
            int totalCount)

Registers an result of bulk operations.

Example of usage:

 
 Set<Something> cachedValues = cache.get(keys);
 hitRatio.update(cachedValues.size(), keys.size());
 
 

Parameters:

hitCount -

totalCount -

Throws:

IllegalArgumentException - In case of:

• hitCount < 0
• totalCount < 1
• hitCount > totalCount

getHitRatio

double getHitRatio()

Returns the ratio between hits and misses

Returns:

the ratio between hits and misses