Class Timer

java.lang.Object

io.prometheus.metrics.core.datapoints.Timer

All Implemented Interfaces:

Closeable, AutoCloseable

public class Timer
extends Object
implements Closeable

Helper class for observing durations.

Field Summary

Fields

Modifier and Type	Field	Description
private final DoubleConsumer	observeFunction
private final long	startTimeNanos

Constructor Summary

Constructors

Constructor	Description
Timer(DoubleConsumer observeFunction)	Constructor is package private.

Method Summary

Modifier and Type	Method	Description
void	close()	Same as observeDuration().
double	observeDuration()	Records the observed duration in seconds since this Timer instance was created.

Methods inherited from class Object

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

Field Details

observeFunction

private final DoubleConsumer observeFunction

startTimeNanos

private final long startTimeNanos

Constructor Details

Timer

Timer(DoubleConsumer observeFunction)

Constructor is package private. Use the TimerApi provided by the implementation of the DataPoint.

Method Details

observeDuration

public double observeDuration()

Records the observed duration in seconds since this Timer instance was created.

Returns:

the observed duration in seconds.

close

public void close()

Same as observeDuration().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable