Class DataPointSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.DataPointSnapshot

Direct Known Subclasses:

CounterSnapshot.CounterDataPointSnapshot, DistributionDataPointSnapshot, GaugeSnapshot.GaugeDataPointSnapshot, InfoSnapshot.InfoDataPointSnapshot, StateSetSnapshot.StateSetDataPointSnapshot, UnknownSnapshot.UnknownDataPointSnapshot

public abstract class DataPointSnapshot
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataPointSnapshot.Builder<T extends DataPointSnapshot.Builder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
private final long	createdTimestampMillis
private final Labels	labels
private final long	scrapeTimestampMillis

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataPointSnapshot(Labels labels, long createdTimestampMillis, long scrapeTimestampMillis, boolean internal)

Method Summary

Modifier and Type	Method	Description
(package private) abstract DataPointSnapshot	escape(EscapingScheme escapingScheme)
long	getCreatedTimestampMillis()	This will only return a reasonable value if hasCreatedTimestamp() is true.
Labels	getLabels()
long	getScrapeTimestampMillis()	This will only return a reasonable value if hasScrapeTimestamp() is true.
boolean	hasCreatedTimestamp()
boolean	hasScrapeTimestamp()
private void	validate()

Methods inherited from class Object

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

Field Details

labels

private final Labels labels

createdTimestampMillis

private final long createdTimestampMillis

scrapeTimestampMillis

private final long scrapeTimestampMillis

Constructor Details

DataPointSnapshot

protected DataPointSnapshot(Labels labels,
 long createdTimestampMillis,
 long scrapeTimestampMillis,
 boolean internal)

Method Details

validate

private void validate()

getLabels

public Labels getLabels()

hasScrapeTimestamp

public boolean hasScrapeTimestamp()

getScrapeTimestampMillis

public long getScrapeTimestampMillis()

This will only return a reasonable value if hasScrapeTimestamp() is true.

hasCreatedTimestamp

public boolean hasCreatedTimestamp()

getCreatedTimestampMillis

public long getCreatedTimestampMillis()

This will only return a reasonable value if hasCreatedTimestamp() is true. Some metrics like Gauge don't have created timestamps. For these metrics hasCreatedTimestamp() is always false.

escape

abstract DataPointSnapshot escape(EscapingScheme escapingScheme)