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, 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

Modifier and Type	Field	Description
private final int	ageBuckets
private final ExemplarSamplerConfig	exemplarSamplerConfig
private final long	maxAgeSeconds
private final List<CKMSQuantiles.Quantile>	quantiles

Fields inherited from class MetricWithFixedMetadata

labelNames

Fields inherited from class Metric

constLabels

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Summary(Summary.Builder builder, PrometheusProperties prometheusProperties)

Method Summary

Modifier and Type	Method	Description
static Summary.Builder	builder()
static Summary.Builder	builder(PrometheusProperties config)
SummarySnapshot	collect()	Called when the Prometheus server scrapes metrics.
protected SummarySnapshot	collect(List<Labels> labels, List<Summary.DataPoint> metricData)	labels and metricData have the same size.
long	getCount()	Get the count of observations.
MetricType	getMetricType()	Returns the metric type for registration-time validation.
double	getSum()	Get the sum of all observed values.
private List<CKMSQuantiles.Quantile>	makeQuantiles(MetricsProperties[] properties)
protected Summary.DataPoint	newDataPoint()
void	observe(double amount)	Observe value.
void	observeWithExemplar(double amount, Labels labels)	Observe value, and create a custom exemplar with the given labels.

Methods inherited from class StatefulMetric

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

Methods inherited from class MetricWithFixedMetadata

getLabelNames, getMetadata, getPrometheusName

Methods inherited from class Object

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

Methods inherited from interface Collector

collect, collect, collect

Methods inherited from interface DistributionDataPoint

startTimer

Methods inherited from interface TimerApi

time, time, timeChecked

Field Details

quantiles

private final List<CKMSQuantiles.Quantile> quantiles

maxAgeSeconds

private final long maxAgeSeconds

ageBuckets

private final int ageBuckets

exemplarSamplerConfig

private final ExemplarSamplerConfig exemplarSamplerConfig

Constructor Details

Summary

private Summary(Summary.Builder builder,
 PrometheusProperties prometheusProperties)

Method Details

makeQuantiles

private List<CKMSQuantiles.Quantile> makeQuantiles(MetricsProperties[] properties)

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,
 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 SummarySnapshot collect()

Description copied from interface: Collector

Called when the Prometheus server scrapes metrics.

Specified by:

collect in interface Collector

Overrides:

collect in class StatefulMetric<DistributionDataPoint, Summary.DataPoint>

collect

protected SummarySnapshot collect(List<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>

getMetricType

public MetricType getMetricType()

Description copied from interface: Collector

Returns the metric type for registration-time validation.

This is used to prevent different metric types (e.g., Counter and Gauge) from sharing the same name. Returning null means type validation is skipped for this collector.

Validation is performed only at registration time. If this method returns null, no type validation is performed for this collector, and duplicate or conflicting metrics may result in invalid exposition output.

Specified by:

getMetricType in interface Collector

Returns:

the metric type, or null to skip validation

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(PrometheusProperties config)