Package io.prometheus.metrics.model.snapshots

Class CounterSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshot

io.prometheus.metrics.model.snapshots.CounterSnapshot

public class CounterSnapshot
extends MetricSnapshot

Immutable snapshot of a Counter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CounterSnapshot.Builder
static class	CounterSnapshot.CounterDataPointSnapshot

Field Summary

Fields inherited from class io.prometheus.metrics.model.snapshots.MetricSnapshot

dataPoints

Constructor Summary

Constructors

Modifier	Constructor	Description
	CounterSnapshot(MetricMetadata metadata, Collection<CounterSnapshot.CounterDataPointSnapshot> dataPoints)	To create a new CounterSnapshot, you can either call the constructor directly or use the builder with builder().
private	CounterSnapshot(MetricMetadata metadata, Collection<CounterSnapshot.CounterDataPointSnapshot> dataPoints, boolean internal)

Method Summary

Modifier and Type	Method	Description
static CounterSnapshot.Builder	builder()
(package private) MetricSnapshot	escape(EscapingScheme escapingScheme, List<? extends DataPointSnapshot> dataPointSnapshots)
List<CounterSnapshot.CounterDataPointSnapshot>	getDataPoints()

Methods inherited from class io.prometheus.metrics.model.snapshots.MetricSnapshot

getMetadata

Methods inherited from class java.lang.Object

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

Constructor Details

CounterSnapshot

public CounterSnapshot(MetricMetadata metadata,
 Collection<CounterSnapshot.CounterDataPointSnapshot> dataPoints)

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

Parameters:

metadata - the metric name in metadata must not include the _total suffix. See MetricMetadata for more naming conventions.

dataPoints - the constructor will create a sorted copy of the collection.

CounterSnapshot

private CounterSnapshot(MetricMetadata metadata,
 Collection<CounterSnapshot.CounterDataPointSnapshot> dataPoints,
 boolean internal)

Method Details

getDataPoints

public List<CounterSnapshot.CounterDataPointSnapshot> getDataPoints()

Specified by:

getDataPoints in class MetricSnapshot

escape

MetricSnapshot escape(EscapingScheme escapingScheme,
 List<? extends DataPointSnapshot> dataPointSnapshots)

Specified by:

escape in class MetricSnapshot

builder

public static CounterSnapshot.Builder builder()