io.prometheus.client

Class SimpleTimer

java.lang.Object

io.prometheus.client.SimpleTimer

public class SimpleTimer
extends Object

SimpleTimer, to measure elapsed duration in seconds as a double.

This is a helper class intended to measure latencies and encapsulate the conversion to seconds without losing precision.

Keep in mind that preferred approaches avoid using this mechanism if possible, since latency metrics broken out by outcome should be minimized; Summary.startTimer() and Histogram.startTimer() are preferred. Consider moving outcome labels to a separate metric like a counter.

Example usage:

 
   class YourClass {
     static final Summary requestLatency = Summary.build()
         .name("requests_latency_seconds")
         .help("Request latency in seconds.")
         .labelNames("aLabel")
         .register();

     void processRequest(Request req) {
        SimpleTimer requestTimer = new SimpleTimer();
        try {
          // Your code here.
        } finally {
          requestLatency.labels("aLabelValue").observe(requestTimer.elapsedSeconds());
        }
     }
   }
 
 

Constructor Summary

Constructors

Constructor and Description
SimpleTimer()

Method Summary

Modifier and Type	Method and Description
double	elapsedSeconds()
static double	elapsedSecondsFromNanos(long startNanos, long endNanos)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTimer

public SimpleTimer()

Method Detail

elapsedSeconds

public double elapsedSeconds()

Returns:

Measured duration in seconds since SimpleTimer was constructed.

elapsedSecondsFromNanos

public static double elapsedSecondsFromNanos(long startNanos,
                                             long endNanos)