com.netflix.spectator.api

Interface LongTaskTimer

All Superinterfaces:

Meter

All Known Implementing Classes:

LongTaskTimer

public interface LongTaskTimer
extends Meter

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.
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 interface com.netflix.spectator.api.Meter

hasExpired, id, measure

Method Detail

start

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.

stop

long stop(long task)

Indicates that a given task has completed.

Parameters:

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

Returns:

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

duration

long duration(long task)

Returns the current duration for a given active task.

Parameters:

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

Returns:

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

duration

long duration()

Returns the cumulative duration of all current tasks in nanoseconds.

activeTasks

int activeTasks()

Returns the current number of tasks being executed.