com.netflix.spectator.api.patterns

Class LongTaskTimer

java.lang.Object

com.netflix.spectator.api.patterns.LongTaskTimer

All Implemented Interfaces:

LongTaskTimer, Meter

public final class LongTaskTimer
extends java.lang.Object
implements LongTaskTimer

Timer intended to track a small number of long running tasks. Example would be something like a batch hadoop job. Though "long running" is a bit subjective the assumption is that anything over a minute is long running.

Method Summary

Modifier and Type	Method and Description
int	activeTasks() Returns the current number of tasks being executed.
long	duration() Returns the cumulative duration of all current tasks in nanoseconds.
long	duration(long task) Returns the current duration for a given active task.
static LongTaskTimer	get(Registry registry, Id id) Creates a timer for tracking long running tasks.
boolean	hasExpired() Indicates whether the meter is expired.
Id	id() Identifier used to lookup this meter in the registry.
java.lang.Iterable<Measurement>	measure() Get the set of measurements for this meter.
long	start() Start keeping time for a task and return a task id that can be used to look up how long it has been running.
long	stop(long task) Indicates that a given task has completed.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static LongTaskTimer get(Registry registry,
                                Id id)

Creates a timer for tracking long running tasks.

Parameters:

registry - Registry to use.

id - Identifier for the metric being registered.

Returns:

Timer instance.

id

public Id id()

Description copied from interface: Meter

Identifier used to lookup this meter in the registry.

Specified by:

id 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

start

public long start()

Description copied from interface: LongTaskTimer

Start keeping time for a task and return a task id that can be used to look up how long it has been running.

Specified by:

start in interface LongTaskTimer

stop

public long stop(long task)

Description copied from interface: LongTaskTimer

Indicates that a given task has completed.

Specified by:

stop in interface LongTaskTimer

Parameters:

task - Id for the task to stop. This should be the value returned from LongTaskTimer.start().

Returns:

Duration for the task in nanoseconds. A -1 value will be returned for an unknown task.

duration

public long duration(long task)

Description copied from interface: LongTaskTimer

Returns the current duration for a given active task.

Specified by:

duration in interface LongTaskTimer

Parameters:

task - Id for the task to stop. This should be the value returned from LongTaskTimer.start().

Returns:

Duration for the task in nanoseconds. A -1 value will be returned for an unknown task.

duration

public long duration()

Description copied from interface: LongTaskTimer

Returns the cumulative duration of all current tasks in nanoseconds.

Specified by:

duration in interface LongTaskTimer

activeTasks

public int activeTasks()

Description copied from interface: LongTaskTimer

Returns the current number of tasks being executed.

Specified by:

activeTasks in interface LongTaskTimer

measure

public java.lang.Iterable<Measurement> measure()

Description copied from interface: Meter

Get the set of measurements for this meter.

Specified by:

measure in interface Meter