Package io.prometheus.metrics.model.snapshots

Class SummarySnapshot.SummaryDataPointSnapshot

Object

DataPointSnapshot

DistributionDataPointSnapshot

SummaryDataPointSnapshot

Enclosing class:

SummarySnapshot

public static final class SummarySnapshot.SummaryDataPointSnapshot
extends DistributionDataPointSnapshot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummarySnapshot.SummaryDataPointSnapshot.Builder

Constructor Summary

Constructors

Constructor	Description
SummaryDataPointSnapshot(long count, double sum, Quantiles quantiles, Labels labels, Exemplars exemplars, long createdTimestampMillis)	To create a new SummarySnapshot.SummaryDataPointSnapshot, you can either call the constructor directly or use the Builder with builder().
SummaryDataPointSnapshot(long count, double sum, Quantiles quantiles, Labels labels, Exemplars exemplars, long createdTimestampMillis, long scrapeTimestampMillis)	Constructor with an additional scrape timestamp.

Method Summary

Modifier and Type	Method	Description
static SummarySnapshot.SummaryDataPointSnapshot.Builder	builder()
Quantiles	getQuantiles()

Methods inherited from class DistributionDataPointSnapshot

getCount, getExemplars, getSum, hasCount, hasSum

Methods inherited from class DataPointSnapshot

getCreatedTimestampMillis, getLabels, getScrapeTimestampMillis, hasCreatedTimestamp, hasScrapeTimestamp

Methods inherited from class Object

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

Constructor Details

SummaryDataPointSnapshot

public SummaryDataPointSnapshot(long count,
 double sum,
 Quantiles quantiles,
 Labels labels,
 Exemplars exemplars,
 long createdTimestampMillis)

To create a new SummarySnapshot.SummaryDataPointSnapshot, you can either call the constructor directly or use the Builder with builder().

Parameters:

count - total number of observations. Optional, pass -1 if not available.

sum - sum of all observed values. Optional, pass Double.NaN if not available.

quantiles - must not be null. Use Quantiles.EMPTY if there are no quantiles.

labels - must not be null. Use Labels.EMPTY if there are no labels.

exemplars - must not be null. Use Exemplars.EMPTY if there are no exemplars.

createdTimestampMillis - timestamp (as in System.currentTimeMillis()) when this summary data (this specific set of labels) was created. Note that this refers to the creation of the timeseries, not the creation of the snapshot. The created timestamp optional. Use 0L if there is no created timestamp.

SummaryDataPointSnapshot

public SummaryDataPointSnapshot(long count,
 double sum,
 Quantiles quantiles,
 Labels labels,
 Exemplars exemplars,
 long createdTimestampMillis,
 long scrapeTimestampMillis)

Constructor with an additional scrape timestamp. This is only useful in rare cases as the scrape timestamp is usually set by the Prometheus server during scraping. Exceptions include mirroring metrics with given timestamps from other metric sources.

Method Details

getQuantiles

public Quantiles getQuantiles()

builder

public static SummarySnapshot.SummaryDataPointSnapshot.Builder builder()