io.vertx.micrometer

Class MicrometerMetricsFactory

java.lang.Object

io.vertx.micrometer.MicrometerMetricsFactory

All Implemented Interfaces:

VertxMetricsFactory, VertxServiceProvider

public class MicrometerMetricsFactory
extends Object
implements VertxMetricsFactory

The micrometer metrics registry.

Author:

Joel Takvorian

Constructor Summary

Constructors

Constructor and Description
MicrometerMetricsFactory()
MicrometerMetricsFactory(io.micrometer.core.instrument.MeterRegistry micrometerRegistry) Build a factory passing the Micrometer MeterRegistry to be used by Vert.x.

Method Summary

Modifier and Type	Method and Description
VertxMetrics	metrics(VertxOptions vertxOptions)
MetricsOptions	newOptions()
MetricsOptions	newOptions(JsonObject jsonObject)
MetricsOptions	newOptions(MetricsOptions options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.core.spi.VertxMetricsFactory

init

Constructor Detail

MicrometerMetricsFactory

public MicrometerMetricsFactory()

MicrometerMetricsFactory

public MicrometerMetricsFactory(io.micrometer.core.instrument.MeterRegistry micrometerRegistry)

Build a factory passing the Micrometer MeterRegistry to be used by Vert.x. This is useful in several scenarios, such as:

• if there is already a MeterRegistry used in the application that should be used by Vert.x as well.
• to define some backend configuration that is not covered in this module (example: reporting to non-covered backends such as New Relic)
• to use Micrometer's CompositeRegistry

This setter is mutually exclusive with setInfluxDbOptions/setPrometheusOptions/setJmxMetricsOptions and takes precedence over them.

Parameters:

micrometerRegistry - the registry to use

Method Detail

metrics

public VertxMetrics metrics(VertxOptions vertxOptions)

Specified by:

metrics in interface VertxMetricsFactory

newOptions

public MetricsOptions newOptions(MetricsOptions options)

Specified by:

newOptions in interface VertxMetricsFactory

newOptions

public MetricsOptions newOptions()

Specified by:

newOptions in interface VertxMetricsFactory

newOptions

public MetricsOptions newOptions(JsonObject jsonObject)

Specified by:

newOptions in interface VertxMetricsFactory