com.netflix.spectator.api

Interface Timer

All Superinterfaces:

Meter

All Known Implementing Classes:

AbstractTimer, BucketTimer, PercentileTimer

public interface Timer
extends Meter

Timer intended to track a large number of short running events. Example would be something like an http request. Though "short running" is a bit subjective the assumption is that it should be under a minute. The precise set of information maintained by the timer depends on the implementation. Most should try to provide a consistent implementation of count() and totalTime(), but some implementations may not. In particular, the implementation from NoopRegistry will always return 0.

Method Summary

Modifier and Type	Method and Description
long	count() The number of times that record has been called since this timer was last reset.
<T> T	record(Callable<T> f) Executes the callable `f` and records the time taken.
default void	record(Duration amount) Updates the statistics kept by the counter with the specified amount.
void	record(long amount, TimeUnit unit) Updates the statistics kept by the counter with the specified amount.
void	record(Runnable f) Executes the runnable `f` and records the time taken.
long	totalTime() The total time in nanoseconds of all recorded events since this timer was last reset.

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

hasExpired, id, measure

Method Detail

record

void record(long amount,
            TimeUnit unit)

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

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.

record

default void record(Duration amount)

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

Parameters:

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

record

<T> T record(Callable<T> f)
      throws Exception

Executes the callable `f` and records the time taken.

Parameters:

f - Function to execute and measure the execution time.

Returns:

The return value of `f`.

Throws:

Exception

record

void record(Runnable f)

Executes the runnable `f` and records the time taken.

Parameters:

f - Function to execute and measure the execution time.

count

long count()

The number of times that record has been called since this timer was last reset. How often a timer is reset depends on the underlying registry implementation.

totalTime

long totalTime()

The total time in nanoseconds of all recorded events since this timer was last reset. How often a timer is reset depends on the underlying registry implementation.