io.prometheus.client

Class Summary

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.SimpleCollector<Summary.Child,Summary>

io.prometheus.client.Summary

public class Summary
extends SimpleCollector<Summary.Child,Summary>

Summary metric, to track distributions and frequencies..

Example of uses for Summaries include:

• Response latency
• Request size

Note: Full distribution support is still a work in progress. Currently it reports only the count of observations and their sum, allowing for calculation of the rate of observations and the average observation size.

Example Summaries:

 class YourClass {
     static final Summary receivedBytes = Summary.build()
         .name("requests_size_bytes_total").help("Request size in bytes.").register();
     static final Summary requestLatency = Summary.build()
         .name("requests_latency_s_total").help("Request latency in seconds.").register();

     void processRequest(Request req) {  
        Summary.Timer requestTimer = requestLatency.startTimer()
        try {
          // Your code here.
        } finally {
          receivedBytes.observe(req.size());
          requestTimer.observeDuration();
        }
     }
   }
 
 

This would allow you to track request rate, average latency and average request size.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Summary.Builder
static class	Summary.Child The value of a single Summary.
static class	Summary.Timer Represents an event being timed.

Nested classes/interfaces inherited from class io.prometheus.client.Collector

Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields inherited from class io.prometheus.client.SimpleCollector

children, fullname, help, labelNames, noLabelsChild

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Method Summary

Methods

Modifier and Type	Method and Description
static Summary.Builder	build() Return a Builder to allow configuration of a new Summary.
List<Collector.MetricFamilySamples>	collect() Return all of the metrics of this Collector.
protected Summary.Child	newChild() Return a new child, workaround for Java generics limitations.
void	observe(double amt) Observe the given amount on the summary with no labels.
Summary.Timer	startTimer() Start a timer to track a duration on the summary with no labels.

Methods inherited from class io.prometheus.client.SimpleCollector

clear, labels, remove, setChild

Methods inherited from class io.prometheus.client.Collector

register, register

Methods inherited from class java.lang.Object

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

Method Detail

build

public static Summary.Builder build()

Return a Builder to allow configuration of a new Summary.

newChild

protected Summary.Child newChild()

Description copied from class: SimpleCollector

Return a new child, workaround for Java generics limitations.

Specified by:

newChild in class SimpleCollector<Summary.Child,Summary>

observe

public void observe(double amt)

Observe the given amount on the summary with no labels.

startTimer

public Summary.Timer startTimer()

Start a timer to track a duration on the summary with no labels.

Call Summary.Timer.observeDuration() at the end of what you want to measure the duration of.

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all of the metrics of this Collector.

Specified by:

collect in class Collector