Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class HistogramSnapshot

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshot

io.prometheus.metrics.model.snapshots.HistogramSnapshot

public final class HistogramSnapshot
extends MetricSnapshot

Immutable snapshot of a Histogram.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HistogramSnapshot.Builder
static final class	HistogramSnapshot.HistogramDataPointSnapshot

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLASSIC_HISTOGRAM

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

dataPoints

Constructor Summary

Constructors

Constructor	Description
HistogramSnapshot(boolean isGaugeHistogram, MetricMetadata metadata, Collection<HistogramSnapshot.HistogramDataPointSnapshot> data)	Use this with the first parameter true to create a snapshot of a Gauge Histogram.
HistogramSnapshot(MetricMetadata metadata, Collection<HistogramSnapshot.HistogramDataPointSnapshot> data)	To create a new HistogramSnapshot, you can either call the constructor directly or use the builder with builder().

Method Summary

Modifier and Type	Method	Description
static HistogramSnapshot.Builder	builder()
List<HistogramSnapshot.HistogramDataPointSnapshot>	getDataPoints()
boolean	isGaugeHistogram()

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

Field Details

CLASSIC_HISTOGRAM

public static final int CLASSIC_HISTOGRAM

See Also:

• Constant Field Values

Constructor Details

HistogramSnapshot

public HistogramSnapshot(MetricMetadata metadata,
 Collection<HistogramSnapshot.HistogramDataPointSnapshot> data)

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

Parameters:

metadata - see MetricMetadata for naming conventions.

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

HistogramSnapshot

public HistogramSnapshot(boolean isGaugeHistogram,
 MetricMetadata metadata,
 Collection<HistogramSnapshot.HistogramDataPointSnapshot> data)

Use this with the first parameter true to create a snapshot of a Gauge Histogram. The data model for Gauge Histograms is the same as for regular histograms, except that bucket values are semantically gauges and not counters. See openmetrics.io for more info on Gauge Histograms.

Method Details

isGaugeHistogram

public boolean isGaugeHistogram()

getDataPoints

public List<HistogramSnapshot.HistogramDataPointSnapshot> getDataPoints()

Specified by:

getDataPoints in class MetricSnapshot

builder

public static HistogramSnapshot.Builder builder()