Package io.prometheus.client

Class Histogram.Timer

java.lang.Object

io.prometheus.client.Histogram.Timer

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

Histogram

public static class Histogram.Timer
extends Object
implements Closeable

Represents an event being timed.

Field Summary

Fields

Modifier and Type	Field	Description
private final Histogram.Child	child
private final long	start

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Timer(Histogram.Child child, long start)

Method Summary

Modifier and Type	Method	Description
void	close()	Equivalent to calling observeDuration().
double	observeDuration()	Observe the amount of time in seconds since Histogram.Child.startTimer() was called.
double	observeDurationWithExemplar(String... exemplarLabels)
double	observeDurationWithExemplar(Map<String,String> exemplarLabels)

Methods inherited from class java.lang.Object

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

Field Details

child

private final Histogram.Child child

start

private final long start

Constructor Details

Timer

private Timer(Histogram.Child child,
 long start)

Method Details

observeDuration

public double observeDuration()

Observe the amount of time in seconds since Histogram.Child.startTimer() was called.

Returns:

Measured duration in seconds since Histogram.Child.startTimer() was called.

observeDurationWithExemplar

public double observeDurationWithExemplar(String... exemplarLabels)

observeDurationWithExemplar

public double observeDurationWithExemplar(Map<String,String> exemplarLabels)

close

public void close()

Equivalent to calling observeDuration().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable