io.prometheus.client

Class SimpleCollector.Builder<B extends SimpleCollector.Builder<B>>

java.lang.Object

io.prometheus.client.SimpleCollector.Builder<B>

Direct Known Subclasses:

Counter.Builder, Gauge.Builder, Histogram.Builder, Summary.Builder

Enclosing class:

SimpleCollector<Child,T extends SimpleCollector>

public abstract static class SimpleCollector.Builder<B extends SimpleCollector.Builder<B>>
extends Object

Builders let you configure and then create collectors.

Constructor Summary

Constructors

Constructor and Description
SimpleCollector.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract <T extends SimpleCollector> T	create() Return the constructed collector.
B	help(String help) Set the help string of the metric.
B	labelNames(String... labelNames) Set the labelNames of the metric.
B	name(String name) Set the name of the metric.
B	namespace(String namespace) Set the namespace of the metric.
<T extends SimpleCollector> T	register() Create and register the Collector with the default registry.
<T extends SimpleCollector> T	register(CollectorRegistry registry) Create and register the Collector with the given registry.
B	subsystem(String subsystem) Set the subsystem of the metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCollector.Builder

public SimpleCollector.Builder()

Method Detail

name

public B name(String name)

Set the name of the metric. Required.

subsystem

public B subsystem(String subsystem)

Set the subsystem of the metric. Optional.

namespace

public B namespace(String namespace)

Set the namespace of the metric. Optional.

help

public B help(String help)

Set the help string of the metric. Required.

labelNames

public B labelNames(String... labelNames)

Set the labelNames of the metric. Optional, defaults to no labels.

create

public abstract <T extends SimpleCollector> T create()

Return the constructed collector.

Abstract due to generics limitations.

register

public <T extends SimpleCollector> T register()

Create and register the Collector with the default registry.

register

public <T extends SimpleCollector> T register(CollectorRegistry registry)

Create and register the Collector with the given registry.