Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class HistogramSnapshot.Builder

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricSnapshot.Builder<HistogramSnapshot.Builder>

io.prometheus.metrics.model.snapshots.HistogramSnapshot.Builder

Enclosing class:

HistogramSnapshot

public static class HistogramSnapshot.Builder
extends MetricSnapshot.Builder<HistogramSnapshot.Builder>

Method Summary

Modifier and Type	Method	Description
HistogramSnapshot	build()
HistogramSnapshot.Builder	dataPoint(HistogramSnapshot.HistogramDataPointSnapshot dataPoint)	Add a data point.
HistogramSnapshot.Builder	gaugeHistogram(boolean isGaugeHistogram)	true indicates that this histogram is a gauge histogram.
protected HistogramSnapshot.Builder	self()

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

buildMetadata, help, name, unit

Methods inherited from class java.lang.Object

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

Method Details

dataPoint

public HistogramSnapshot.Builder dataPoint(HistogramSnapshot.HistogramDataPointSnapshot dataPoint)

Add a data point. Call multiple times to add multiple data points.

gaugeHistogram

public HistogramSnapshot.Builder gaugeHistogram(boolean isGaugeHistogram)

true indicates that this histogram is 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.

build

public HistogramSnapshot build()

Specified by:

build in class MetricSnapshot.Builder<HistogramSnapshot.Builder>

self

protected HistogramSnapshot.Builder self()

Specified by:

self in class MetricSnapshot.Builder<HistogramSnapshot.Builder>