org.springframework.metrics.instrument

Interface LongTaskTimer

All Superinterfaces:

Meter

All Known Implementing Classes:

PrometheusLongTaskTimer, SimpleLongTaskTimer, SpectatorLongTaskTimer

public interface LongTaskTimer
extends Meter

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.metrics.instrument.Meter

Meter.Type

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 an active task.
default Meter.Type	getType()
default void	record(java.util.function.Consumer<java.lang.Long> f) Executes the runnable `f` and records the time taken.
default void	record(java.lang.Runnable f) Executes the runnable `f` and records the time taken.
default <T> T	record(java.util.function.Supplier<T> f) Executes the callable `f` and records the time taken.
default <T> T	recordCallable(java.util.concurrent.Callable<T> f) Executes the callable `f` and records the time taken.
long	start() Start keeping time for a task.
long	stop(long task) Mark a given task as completed.

Methods inherited from interface org.springframework.metrics.instrument.Meter

getName, getTags, measure

Method Detail

recordCallable

default <T> T recordCallable(java.util.concurrent.Callable<T> f)
                      throws java.lang.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:

java.lang.Exception

record

default <T> T record(java.util.function.Supplier<T> f)
              throws java.lang.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:

java.lang.Exception

record

default void record(java.util.function.Consumer<java.lang.Long> f)

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

Parameters:

f - Function to execute and measure the execution time with a reference to the timer id useful for looking up current duration.

record

default void record(java.lang.Runnable f)

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

Parameters:

f - Function to execute and measure the execution time.

start

long start()

Start keeping time for a task.

Returns:

A task id that can be used to look up how long the task has been running.

stop

long stop(long task)

Mark a given task as 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 an 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.

getType

default Meter.Type getType()

Specified by:

getType in interface Meter