Class JvmMetrics.Builder

java.lang.Object

io.prometheus.metrics.instrumentation.jvm.JvmMetrics.Builder

Enclosing class:

JvmMetrics

public static class JvmMetrics.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final PrometheusProperties	config
private Labels	constLabels

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(PrometheusProperties config)

Method Summary

Modifier and Type	Method	Description
JvmMetrics.Builder	constLabels(Labels constLabels)	Set constant labels that will be applied to all JVM metrics registered by this builder.
void	register()	Register all JVM metrics with the default registry.
void	register(PrometheusRegistry registry)	Register all JVM metrics with the registry.

Methods inherited from class Object

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

Field Details

config

private final PrometheusProperties config

constLabels

private Labels constLabels

Constructor Details

Builder

private Builder(PrometheusProperties config)

Method Details

constLabels

public JvmMetrics.Builder constLabels(Labels constLabels)

Set constant labels that will be applied to all JVM metrics registered by this builder.

register

public void register()

Register all JVM metrics with the default registry.

It's safe to call this multiple times, only the first call will register the metrics, all subsequent calls will be ignored.

register

public void register(PrometheusRegistry registry)

Register all JVM metrics with the registry.

It's safe to call this multiple times, only the first call will register the metrics, all subsequent calls will be ignored.