org.apache.giraph.metrics

Class GiraphTimer

java.lang.Object

com.yammer.metrics.core.Gauge<T>

org.apache.giraph.metrics.ValueGauge<Long>

org.apache.giraph.metrics.GiraphTimer

All Implemented Interfaces:

com.yammer.metrics.core.Metric

public class GiraphTimer
extends ValueGauge<Long>

A timer to record duration of an event in a given TimeUnit. GiraphTimer is actually just a single-value Yammer Gauge that has some methods to make timing things easier.

Constructor Summary

Constructors

Constructor and Description
GiraphTimer(GiraphMetricsRegistry registry, String name, TimeUnit timeUnit) Create new timer, add it to the registry.

Method Summary

Modifier and Type	Method and Description
TimeUnit	getTimeUnit() Get TimeUnit used.
String	getTimeUnitAbbrev() Get abbreviated string of TimeUnit.
GiraphTimer	set(long value, TimeUnit valueTimeUnit) Set value from a given TimeUnit, converting to our TimeUnit.
GiraphTimerContext	time() Begin timing an event.
String	valueAndUnit() Get string representation of value

Methods inherited from class org.apache.giraph.metrics.ValueGauge

getDouble, getLong, set, value

Methods inherited from class com.yammer.metrics.core.Gauge

processWith

Methods inherited from class java.lang.Object

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

Constructor Detail

GiraphTimer

public GiraphTimer(GiraphMetricsRegistry registry,
                   String name,
                   TimeUnit timeUnit)

Create new timer, add it to the registry.

Parameters:

registry - GiraphMetricsRegistry to add timer to

name - String name of timer

timeUnit - TimeUnit to measure in

Method Detail

getTimeUnit

public TimeUnit getTimeUnit()

Get TimeUnit used.

Returns:

TimeUnit being used.

time

public GiraphTimerContext time()

Begin timing an event.

Returns:

GiraphTimerContext. Use stop() to end timing the event.

set

public GiraphTimer set(long value,
                       TimeUnit valueTimeUnit)

Set value from a given TimeUnit, converting to our TimeUnit.

Parameters:

value - long measurement taken.

valueTimeUnit - TimeUnit measurement is in.

Returns:

this

getTimeUnitAbbrev

public String getTimeUnitAbbrev()

Get abbreviated string of TimeUnit.

Returns:

TimeUnit abbreviation.

valueAndUnit

public String valueAndUnit()

Get string representation of value

Returns:

String value and abbreviated time unit