Package io.prometheus.client.exemplars
Interface HistogramExemplarSampler
-
- All Known Subinterfaces:
ExemplarSampler
- All Known Implementing Classes:
DefaultExemplarSampler
public interface HistogramExemplarSampler
Exemplar sampler for histogram metrics.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Exemplar
sample(double value, double bucketFrom, double bucketTo, Exemplar previous)
-
-
-
Method Detail
-
sample
Exemplar sample(double value, double bucketFrom, double bucketTo, Exemplar previous)
- Parameters:
value
- the value to be observed.bucketFrom
- upper boundary of the previous bucket in the histogram. Will beDouble.NEGATIVE_INFINITY
if there is no previous bucket.bucketTo
- upper boundary of this histogram bucket. Will beDouble.POSITIVE_INFINITY
if this is the last bucket.previous
- the previously sampled exemplar, ornull
if there is none.- Returns:
- an Exemplar to be sampled, or
null
if the previous exemplar does not need to be updated. Returningnull
and returningprevious
is equivalent.
-
-