Class Counter.Builder

java.lang.Object

io.prometheus.client.SimpleCollector.Builder<Counter.Builder, Counter>

io.prometheus.client.Counter.Builder

Enclosing class:

Counter

public static class Counter.Builder
extends SimpleCollector.Builder<Counter.Builder, Counter>

Field Summary

Fields

Modifier and Type	Field	Description
private CounterExemplarSampler	exemplarSampler
private Boolean	exemplarsEnabled

Fields inherited from class SimpleCollector.Builder

dontInitializeNoLabelsChild, fullname, help, labelNames, name, namespace, subsystem, unit

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Counter	create()	Return the constructed collector.
Counter.Builder	withExemplars()	Allow this counter to load exemplars from a CounterExemplarSampler.
Counter.Builder	withExemplarSampler(CounterExemplarSampler exemplarSampler)	Enable exemplars and provide a custom CounterExemplarSampler.
Counter.Builder	withoutExemplars()	Prevent this counter from loading exemplars from a CounterExemplarSampler.

Methods inherited from class SimpleCollector.Builder

help, labelNames, name, namespace, register, register, subsystem, unit

Methods inherited from class Object

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

Field Details

exemplarsEnabled

private Boolean exemplarsEnabled

exemplarSampler

private CounterExemplarSampler exemplarSampler

Constructor Details

Builder

public Builder()

Method Details

create

public Counter create()

Description copied from class: SimpleCollector.Builder

Return the constructed collector.

Abstract due to generics limitations.

Specified by:

create in class SimpleCollector.Builder<Counter.Builder, Counter>

withExemplarSampler

public Counter.Builder withExemplarSampler(CounterExemplarSampler exemplarSampler)

Enable exemplars and provide a custom CounterExemplarSampler.

withExemplars

public Counter.Builder withExemplars()

Allow this counter to load exemplars from a CounterExemplarSampler.

If a specific exemplar sampler is configured for this counter that exemplar sampler is used (see withExemplarSampler(CounterExemplarSampler)). Otherwise the default from ExemplarConfig is used.

withoutExemplars

public Counter.Builder withoutExemplars()

Prevent this counter from loading exemplars from a CounterExemplarSampler.

You can still provide exemplars for explicitly individual observations, e.g. using Counter.incWithExemplar(double, String...).