com.expedia.www.haystack.client.metrics

Interface Timer

All Known Implementing Classes:

NoopMetricsRegistry.NoopTimer

public interface Timer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Timer.Builder
static interface	Timer.Sample Maintains state on the clock's start position for a latency sample.

Method Summary

Modifier and Type	Method and Description
static Timer.Builder	builder(String name)
long	count()
default void	record(long duration) Updates the statistics kept by the counter with the specified amount in nanoseconds.
void	record(long duration, TimeUnit unit) Updates the statistics kept by the counter with the specified amount.
Timer.Sample	start() Returns a new Timer.Sample.
double	totalTime(TimeUnit unit)

Method Detail

builder

static Timer.Builder builder(String name)

record

default void record(long duration)

Updates the statistics kept by the counter with the specified amount in nanoseconds.

Parameters:

duration - Duration of a single event being measured by this timer.

record

void record(long duration,
            TimeUnit unit)

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

Parameters:

duration - Duration of a single event being measured by this timer.

unit - Time unit for the amount being recorded.

totalTime

double totalTime(TimeUnit unit)

Parameters:

unit - The base unit of time to scale the total to.

Returns:

The total time of recorded events.

count

long count()

Returns:

The number of events that have been called on this timer.

start

Timer.Sample start()

Returns a new Timer.Sample.

Returns:

a new Timer.Sample

See Also:

Timer.Sample