Package io.prometheus.client.exemplars
Class ExemplarConfig
- java.lang.Object
-
- io.prometheus.client.exemplars.ExemplarConfig
-
public class ExemplarConfig extends Object
Static configuration for Exemplar behavior.
-
-
Constructor Summary
Constructors Constructor Description ExemplarConfig()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
disableExemplars()
Prevent metrics from loading exemplars from anExemplarSampler
by default.static void
enableExemplars()
Allow metrics to load exemplars from anExemplarSampler
by default.static CounterExemplarSampler
getCounterExemplarSampler()
static HistogramExemplarSampler
getHistogramExemplarSampler()
static boolean
isExemplarsEnabled()
static void
setCounterExemplarSampler(CounterExemplarSampler counterExemplarSampler)
Set the default exemplar sampler for Counters.static void
setHistogramExemplarSampler(HistogramExemplarSampler histogramExemplarSampler)
Set the default exemplar sampler for Histograms.
-
-
-
Constructor Detail
-
ExemplarConfig
public ExemplarConfig()
-
-
Method Detail
-
setCounterExemplarSampler
public static void setCounterExemplarSampler(CounterExemplarSampler counterExemplarSampler)
Set the default exemplar sampler for Counters.
-
setHistogramExemplarSampler
public static void setHistogramExemplarSampler(HistogramExemplarSampler histogramExemplarSampler)
Set the default exemplar sampler for Histograms.
-
disableExemplars
public static void disableExemplars()
Prevent metrics from loading exemplars from anExemplarSampler
by default.You can still enable individual metrics to load exemplars from an
ExemplarSampler
by calling the metric builder'swithExemplars()
method, and you can still provide single exemplars explicitly for individual observations with the...withExemplar()
methods.
-
enableExemplars
public static void enableExemplars()
Allow metrics to load exemplars from anExemplarSampler
by default.You can still disallow individual metrics to load exemplars from an
ExemplarSampler
by calling the metric builder'swithoutExemplars()
method.Exemplars are enabled by default. This method is here so that you can temporarily
disableExemplars()
and thenenableExemplars()
again.
-
getCounterExemplarSampler
public static CounterExemplarSampler getCounterExemplarSampler()
- Returns:
- the
CounterExemplarSampler
that is used by default inCounter
metrics.
-
getHistogramExemplarSampler
public static HistogramExemplarSampler getHistogramExemplarSampler()
- Returns:
- the
HistogramExemplarSampler
that is used by default inHistogram
metrics.
-
isExemplarsEnabled
public static boolean isExemplarsEnabled()
- Returns:
- true by default, false if
disableExemplars()
was called.
-
-