Package io.prometheus.metrics.core.metrics

Class CounterWithCallback.Builder

Object

MetricWithFixedMetadata.Builder<B,M>

Builder

Enclosing class:

CounterWithCallback

public static class CounterWithCallback.Builder
extends MetricWithFixedMetadata.Builder<B,M>

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.

Methods inherited from class MetricWithFixedMetadata.Builder

constLabels, help, labelNames, unit

Methods inherited from class Object

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

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>