Package io.prometheus.metrics.core.metrics

Class CounterWithCallback.Builder

java.lang.Object

io.prometheus.metrics.core.metrics.Metric.Builder<B,M>

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder<B,M>

io.prometheus.metrics.core.metrics.CallbackMetric.Builder<CounterWithCallback.Builder,CounterWithCallback>

io.prometheus.metrics.core.metrics.CounterWithCallback.Builder

Enclosing class:

CounterWithCallback

public static class CounterWithCallback.Builder
extends CallbackMetric.Builder<CounterWithCallback.Builder,CounterWithCallback>

Field Summary

Fields

Modifier and Type	Field	Description
private Consumer<CounterWithCallback.Callback>	callback

Fields inherited from class io.prometheus.metrics.core.metrics.Metric.Builder

constLabels, illegalLabelNames, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(PrometheusProperties properties)

Method Summary

Modifier and Type	Method	Description
CounterWithCallback	build()
CounterWithCallback.Builder	callback(Consumer<CounterWithCallback.Callback> callback)
CounterWithCallback.Builder	name(String name)	The _total suffix will automatically be appended if it's missing.
protected CounterWithCallback.Builder	self()

Methods inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder

constLabels, help, labelNames, unit

Methods inherited from class io.prometheus.metrics.core.metrics.Metric.Builder

register, register

Methods inherited from class java.lang.Object

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

Field Details

callback

private Consumer<CounterWithCallback.Callback> callback

Constructor Details

Builder

private Builder(PrometheusProperties properties)

Method Details

callback

public CounterWithCallback.Builder callback(Consumer<CounterWithCallback.Callback> callback)

name

public CounterWithCallback.Builder name(String name)

The _total suffix will automatically be appended if it's missing.

 CounterWithCallback c1 = CounterWithCallback.builder()
     .name("events_total")
     .build();
 CounterWithCallback c2 = CounterWithCallback.builder()
     .name("events")
     .build();
 

In the example above both c1 and c2 would be named "events_total" in Prometheus.

Throws an IllegalArgumentException if MetricMetadata.isValidMetricName(name) is false.

Overrides:

name in class MetricWithFixedMetadata.Builder<CounterWithCallback.Builder,CounterWithCallback>

build

public CounterWithCallback build()

Specified by:

build in class MetricWithFixedMetadata.Builder<CounterWithCallback.Builder,CounterWithCallback>

self

protected CounterWithCallback.Builder self()

Specified by:

self in class MetricWithFixedMetadata.Builder<CounterWithCallback.Builder,CounterWithCallback>