com.github.rollingmetrics.hitratio

Class ResetPeriodicallyHitRatio

java.lang.Object

com.github.rollingmetrics.hitratio.ResetPeriodicallyHitRatio

All Implemented Interfaces:

HitRatio

public class ResetPeriodicallyHitRatio
extends Object
implements HitRatio

The hit-ratio which reset its state to zero each time when configured interval is elapsed.

Concurrency properties:

• Writing is lock-free.
• Ratio calculation is lock-free.

Usage recommendations:

• When you do not need in "rolling time window" semantic. Else use SmoothlyDecayingRollingHitRatio
• When you want to limit time which each increment takes affect to hit-ratio in order to avoid reporting of obsolete measurements.
• Only if you accept the fact that several increments can be never observed by reader(because rotation to zero can happen before reader seen the written values).

See Also:

SmoothlyDecayingRollingHitRatio, ResetPeriodicallyHitRatio, UniformHitRatio

Constructor Summary

Constructors

Constructor and Description
ResetPeriodicallyHitRatio(Duration resetInterval) Constructs the hit-ratio which reset its state to zero each time when resetInterval is elapsed.
ResetPeriodicallyHitRatio(Duration resetInterval, Ticker ticker)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.rollingmetrics.hitratio.HitRatio

incrementHitCount, incrementMissCount

Constructor Detail

ResetPeriodicallyHitRatio

public ResetPeriodicallyHitRatio(Duration resetInterval)

Constructs the hit-ratio which reset its state to zero each time when resetInterval is elapsed.

Parameters:

resetInterval - the interval between counter resetting

ResetPeriodicallyHitRatio

public ResetPeriodicallyHitRatio(Duration resetInterval,
                                 Ticker ticker)

Method Detail

update

public void update(int hitCount,
                   int totalCount)

Description copied from interface: HitRatio

Registers an result of bulk operations.

Example of usage:

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

Specified by:

update in interface HitRatio

getHitRatio

public double getHitRatio()

Description copied from interface: HitRatio

Returns the ratio between hits and misses

Specified by:

getHitRatio in interface HitRatio

Returns:

the ratio between hits and misses