com.netflix.spectator.api.histogram

Class BucketTimer

java.lang.Object

com.netflix.spectator.api.histogram.BucketTimer

All Implemented Interfaces:

Meter, Timer

public final class BucketTimer
extends Object
implements Timer

Timers that get updated based on the bucket for recorded values.

Nested Class Summary

Nested classes/interfaces inherited from interface com.netflix.spectator.api.Timer

Timer.BatchUpdater

Method Summary

Modifier and Type	Method and Description
Clock	clock() The clock used for timing events.
long	count() Not supported, will always return 0.
static BucketTimer	get(Registry registry, Id id, LongFunction<String> f) Creates a timer object that manages a set of timers based on the bucket function supplied.
boolean	hasExpired() Indicates whether the meter is expired.
Id	id() Identifier used to lookup this meter in the registry.
Iterable<Measurement>	measure() Get the set of measurements for this meter.
void	record(long amount, TimeUnit unit) Updates the statistics kept by the timer with the specified amount.
long	totalTime() Not supported, will always return 0.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.spectator.api.Timer

batchUpdater, record, record, record, record, record, recordBooleanSupplier, recordCallable, recordDoubleSupplier, recordIntSupplier, recordLongSupplier, recordRunnable, recordSupplier, wrapBiConsumer, wrapBiFunction, wrapBinaryOperator, wrapBiPredicate, wrapBooleanSupplier, wrapCallable, wrapConsumer, wrapDoubleBinaryOperator, wrapDoubleConsumer, wrapDoubleFunction, wrapDoublePredicate, wrapDoubleSupplier, wrapDoubleToIntFunction, wrapDoubleToLongFunction, wrapDoubleUnaryOperator, wrapFunction, wrapIntBinaryOperator, wrapIntConsumer, wrapIntFunction, wrapIntPredicate, wrapIntSupplier, wrapIntToDoubleFunction, wrapIntToLongFunction, wrapIntUnaryOperator, wrapLongBinaryOperator, wrapLongConsumer, wrapLongFunction, wrapLongPredicate, wrapLongSupplier, wrapLongToDoubleFunction, wrapLongToIntFunction, wrapLongUnaryOperator, wrapObjDoubleConsumer, wrapObjIntConsumer, wrapObjLongConsumer, wrapPredicate, wrapRunnable, wrapSupplier, wrapToDoubleBiFunction, wrapToDoubleFunction, wrapToIntBiFunction, wrapToIntFunction, wrapToLongBiFunction, wrapToLongFunction, wrapUnaryOperator

Method Detail

get

public static BucketTimer get(Registry registry,
                              Id id,
                              LongFunction<String> f)

Creates a timer object that manages a set of timers based on the bucket function supplied. Calling record will be mapped to the record on the appropriate timer.

Parameters:

registry - Registry to use.

id - Identifier for the metric being registered.

f - Function to map values to buckets. See BucketFunctions for more information.

Returns:

Timer that manages sub-timers based on the bucket function.

id

public Id id()

Description copied from interface: Meter

Identifier used to lookup this meter in the registry.

Specified by:

id in interface Meter

measure

public Iterable<Measurement> measure()

Description copied from interface: Meter

Get the set of measurements for this meter.

Specified by:

measure in interface Meter

hasExpired

public boolean hasExpired()

Description copied from interface: Meter

Indicates whether the meter is expired. For example, a counter might expire if there is no activity within a given time frame.

Specified by:

hasExpired in interface Meter

clock

public Clock clock()

Description copied from interface: Timer

The clock used for timing events.

Specified by:

clock in interface Timer

record

public void record(long amount,
                   TimeUnit unit)

Description copied from interface: Timer

Updates the statistics kept by the timer with the specified amount.

Specified by:

record in interface Timer

Parameters:

amount - Duration of a single event being measured by this timer. If the amount is less than 0 the value will be dropped.

unit - Time unit for the amount being recorded.

count

public long count()

Not supported, will always return 0.

Specified by:

count in interface Timer

totalTime

public long totalTime()

Not supported, will always return 0.

Specified by:

totalTime in interface Timer