Class DistributionDataPointSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.DataPointSnapshot

io.prometheus.metrics.model.snapshots.DistributionDataPointSnapshot

Direct Known Subclasses:

HistogramSnapshot.HistogramDataPointSnapshot, SummarySnapshot.SummaryDataPointSnapshot

public abstract class DistributionDataPointSnapshot
extends DataPointSnapshot

Common base class for histogram and summary data. Histograms and Summaries represent distributions, like a latency distribution or a distribution of request sizes in Bytes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DistributionDataPointSnapshot.Builder<T extends DistributionDataPointSnapshot.Builder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
private final long	count
private final Exemplars	exemplars
private final double	sum

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DistributionDataPointSnapshot(long count, double sum, Exemplars exemplars, Labels labels, long createdTimestampMillis, long scrapeTimestampMillis, boolean internal)	See JavaDoc of the child classes.

Method Summary

Modifier and Type	Method	Description
long	getCount()	This will return garbage if hasCount() is false.
Exemplars	getExemplars()	May be Exemplars.EMPTY, but will never be null.
double	getSum()	This will return garbage if hasSum() is false.
boolean	hasCount()
boolean	hasSum()
private void	validate()

Methods inherited from class DataPointSnapshot

escape, getCreatedTimestampMillis, getLabels, getScrapeTimestampMillis, hasCreatedTimestamp, hasScrapeTimestamp

Methods inherited from class Object

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

Field Details

count

private final long count

sum

private final double sum

exemplars

private final Exemplars exemplars

Constructor Details

DistributionDataPointSnapshot

protected DistributionDataPointSnapshot(long count,
 double sum,
 Exemplars exemplars,
 Labels labels,
 long createdTimestampMillis,
 long scrapeTimestampMillis,
 boolean internal)

See JavaDoc of the child classes.

Method Details

validate

private void validate()

hasCount

public boolean hasCount()

hasSum

public boolean hasSum()

getCount

public long getCount()

This will return garbage if hasCount() is false.

getSum

public double getSum()

This will return garbage if hasSum() is false.

getExemplars

public Exemplars getExemplars()

May be Exemplars.EMPTY, but will never be null.