org.apache.samza.metrics

Class Timer

java.lang.Object

org.apache.samza.metrics.Timer

All Implemented Interfaces:

Metric

public class Timer
extends java.lang.Object
implements Metric

A timer metric that stores time duration and provides Snapshot of the durations.

Constructor Summary

Constructors

Constructor and Description
Timer(java.lang.String name) Default constructor.
Timer(java.lang.String name, long windowMs, Clock clock) Construct a Timer with given window size
Timer(java.lang.String name, Reservoir reservoir) Construct a Timer with given Reservoir

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of the timer
Snapshot	getSnapshot() Get the Snapshot
void	update(long duration) Add the time duration
void	visit(MetricsVisitor visitor)

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer(java.lang.String name)

Default constructor. It uses SlidingTimeWindowReservoir as the default reservoir.

Parameters:

name - name of this timer

Timer

public Timer(java.lang.String name,
             long windowMs,
             Clock clock)

Construct a Timer with given window size

Parameters:

name - name of this timer

windowMs - the window size. unit is millisecond

clock - the clock for the reservoir

Timer

public Timer(java.lang.String name,
             Reservoir reservoir)

Construct a Timer with given Reservoir

Parameters:

name - name of this timer

reservoir - the given reservoir

Method Detail

update

public void update(long duration)

Add the time duration

Parameters:

duration - time duration

getSnapshot

public Snapshot getSnapshot()

Get the Snapshot

Returns:

a statistical snapshot

visit

public void visit(MetricsVisitor visitor)

Specified by:

visit in interface Metric

getName

public java.lang.String getName()

Get the name of the timer

Returns:

name of the timer