Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class Summary

java.lang.Object

io.prometheus.metrics.core.metrics.Metric

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

io.prometheus.metrics.core.metrics.StatefulMetric<DistributionDataPoint,Summary.DataPoint>

io.prometheus.metrics.core.metrics.Summary

All Implemented Interfaces:

DataPoint, DistributionDataPoint, TimerApi, io.prometheus.metrics.model.registry.Collector

public class Summary
extends StatefulMetric<DistributionDataPoint,Summary.DataPoint>
implements DistributionDataPoint

Summary metric. Example:

 Summary summary = Summary.builder()
         .name("http_request_duration_seconds_hi")
         .help("HTTP request service time in seconds")
         .unit(SECONDS)
         .labelNames("method", "path", "status_code")
         .quantile(0.5, 0.01)
         .quantile(0.95, 0.001)
         .quantile(0.99, 0.001)
         .register();

 long start = System.nanoTime();
 // process a request, duration will be observed
 summary.labelValues("GET", "/", "200").observe(Unit.nanosToSeconds(System.nanoTime() - start));
 

See Summary.Builder for configuration options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.Builder
class	Summary.DataPoint

Field Summary

Fields inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

labelNames

Fields inherited from class io.prometheus.metrics.core.metrics.Metric

constLabels

Method Summary

Modifier and Type	Method	Description
static Summary.Builder	builder()
static Summary.Builder	builder(io.prometheus.metrics.config.PrometheusProperties config)
io.prometheus.metrics.model.snapshots.SummarySnapshot	collect()
protected io.prometheus.metrics.model.snapshots.SummarySnapshot	collect(List<io.prometheus.metrics.model.snapshots.Labels> labels, List<Summary.DataPoint> metricData)	labels and metricData have the same size. labels.get(i) are the labels for metricData.get(i).
long	getCount()	Get the count of observations.
double	getSum()	Get the sum of all observed values.
protected Summary.DataPoint	newDataPoint()
void	observe(double amount)	Observe value.
void	observeWithExemplar(double amount, io.prometheus.metrics.model.snapshots.Labels labels)	Observe value, and create a custom exemplar with the given labels.

Methods inherited from class io.prometheus.metrics.core.metrics.StatefulMetric

clear, getConfigProperty, getMetricProperties, getNoLabels, initLabelValues, labelValues, remove, removeIf

Methods inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

getMetadata, getPrometheusName

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.prometheus.metrics.model.registry.Collector

collect, collect, collect

Methods inherited from interface io.prometheus.metrics.core.datapoints.DistributionDataPoint

startTimer

Methods inherited from interface io.prometheus.metrics.core.datapoints.TimerApi

time, time, timeChecked

Method Details

getSum

public double getSum()

Description copied from interface: DistributionDataPoint

Get the sum of all observed values.

Specified by:

getSum in interface DistributionDataPoint

getCount

public long getCount()

Description copied from interface: DistributionDataPoint

Get the count of observations.

Specified by:

getCount in interface DistributionDataPoint

observe

public void observe(double amount)

Description copied from interface: DistributionDataPoint

Observe value.

Specified by:

observe in interface DistributionDataPoint

observeWithExemplar

public void observeWithExemplar(double amount,
 io.prometheus.metrics.model.snapshots.Labels labels)

Description copied from interface: DistributionDataPoint

Observe value, and create a custom exemplar with the given labels.

Specified by:

observeWithExemplar in interface DistributionDataPoint

collect

public io.prometheus.metrics.model.snapshots.SummarySnapshot collect()

Specified by:

collect in interface io.prometheus.metrics.model.registry.Collector

Overrides:

collect in class StatefulMetric<DistributionDataPoint,Summary.DataPoint>

collect

protected io.prometheus.metrics.model.snapshots.SummarySnapshot collect(List<io.prometheus.metrics.model.snapshots.Labels> labels,
 List<Summary.DataPoint> metricData)

Description copied from class: StatefulMetric

labels and metricData have the same size. labels.get(i) are the labels for metricData.get(i).

Specified by:

collect in class StatefulMetric<DistributionDataPoint,Summary.DataPoint>

newDataPoint

protected Summary.DataPoint newDataPoint()

Specified by:

newDataPoint in class StatefulMetric<DistributionDataPoint,Summary.DataPoint>

builder

public static Summary.Builder builder()

builder

public static Summary.Builder builder(io.prometheus.metrics.config.PrometheusProperties config)