Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class InfoSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshot

io.prometheus.metrics.model.snapshots.InfoSnapshot

public final class InfoSnapshot
extends MetricSnapshot

Immutable snapshot of an Info metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InfoSnapshot.Builder
static class	InfoSnapshot.InfoDataPointSnapshot

Field Summary

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

dataPoints

Constructor Summary

Constructors

Constructor	Description
InfoSnapshot(MetricMetadata metadata, Collection<InfoSnapshot.InfoDataPointSnapshot> data)	To create a new InfoSnapshot, you can either call the constructor directly or use the builder with builder().

Method Summary

Modifier and Type	Method	Description
static InfoSnapshot.Builder	builder()
List<InfoSnapshot.InfoDataPointSnapshot>	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

InfoSnapshot

public InfoSnapshot(MetricMetadata metadata,
 Collection<InfoSnapshot.InfoDataPointSnapshot> data)

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

Parameters:

metadata - the metric name in metadata must not include the _info suffix. See MetricMetadata for more naming conventions. The metadata must not have a unit.

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

Method Details

getDataPoints

public List<InfoSnapshot.InfoDataPointSnapshot> getDataPoints()

Specified by:

getDataPoints in class MetricSnapshot

builder

public static InfoSnapshot.Builder builder()