io.prometheus.client

Class SimpleCollector.Builder<T extends SimpleCollector>

java.lang.Object

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

Direct Known Subclasses:

Counter.Builder, Gauge.Builder, Summary.Builder

Enclosing class:

SimpleCollector<Child,T extends SimpleCollector>

public abstract static class SimpleCollector.Builder<T extends SimpleCollector>
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	create() Return the constructed collector.
SimpleCollector.Builder<T>	help(String help) Set the help string of the metric.
SimpleCollector.Builder<T>	labelNames(String... labelNames) Set the labelNames of the metric.
SimpleCollector.Builder<T>	name(String name) Set the name of the metric.
SimpleCollector.Builder<T>	namespace(String namespace) Set the namespace of the metric.
T	register() Create and register the Collector with the default registry.
T	register(CollectorRegistry registry) Create and register the Collector with the given registry.
SimpleCollector.Builder<T>	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 SimpleCollector.Builder<T> name(String name)

Set the name of the metric. Required.

subsystem

public SimpleCollector.Builder<T> subsystem(String subsystem)

Set the subsystem of the metric. Optional.

namespace

public SimpleCollector.Builder<T> namespace(String namespace)

Set the namespace of the metric. Optional.

help

public SimpleCollector.Builder<T> help(String help)

Set the help string of the metric. Required.

labelNames

public SimpleCollector.Builder<T> labelNames(String... labelNames)

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

create

public abstract T create()

Return the constructed collector.

Abstract due to generics limitations.

register

public T register()

Create and register the Collector with the default registry.

register

public T register(CollectorRegistry registry)

Create and register the Collector with the given registry.