Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class MetricSnapshots

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshots

All Implemented Interfaces:

Iterable<MetricSnapshot>

public class MetricSnapshots
extends Object
implements Iterable<MetricSnapshot>

Immutable list of metric snapshots.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricSnapshots.Builder

Constructor Summary

Constructors

Constructor	Description
MetricSnapshots(MetricSnapshot... snapshots)	See MetricSnapshots(Collection)
MetricSnapshots(Collection<MetricSnapshot> snapshots)	To create MetricSnapshots, you can either call the constructor directly or use builder().

Method Summary

Modifier and Type	Method	Description
static MetricSnapshots.Builder	builder()
MetricSnapshot	get(int i)
Iterator<MetricSnapshot>	iterator()
static MetricSnapshots	of(MetricSnapshot... snapshots)
int	size()
Stream<MetricSnapshot>	stream()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

MetricSnapshots

public MetricSnapshots(MetricSnapshot... snapshots)

See MetricSnapshots(Collection)

MetricSnapshots

public MetricSnapshots(Collection<MetricSnapshot> snapshots)

To create MetricSnapshots, you can either call the constructor directly or use builder().

Parameters:

snapshots - the constructor creates a sorted copy of snapshots.

Throws:

IllegalArgumentException - if snapshots contains duplicate metric names. To avoid duplicate metric names use builder() and check MetricSnapshots.Builder.containsMetricName(String) before calling MetricSnapshots.Builder.metricSnapshot(MetricSnapshot).

Method Details

of

public static MetricSnapshots of(MetricSnapshot... snapshots)

iterator

public Iterator<MetricSnapshot> iterator()

Specified by:

iterator in interface Iterable<MetricSnapshot>

size

public int size()

get

public MetricSnapshot get(int i)

stream

public Stream<MetricSnapshot> stream()

builder

public static MetricSnapshots.Builder builder()