Package io.vertx.core.spi
Interface VertxMetricsFactory
-
- All Superinterfaces:
VertxServiceProvider
- All Known Implementing Classes:
DropwizardVertxMetricsFactory,MicrometerMetricsFactory
public interface VertxMetricsFactory extends VertxServiceProvider
A factory for the plugable metrics SPI.- Author:
- Nick Scavelli
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidinit(io.vertx.core.internal.VertxBootstrap bootstrap)Let the provider initialize the Vert.x builder.VertxMetricsmetrics(VertxOptions options)Create a newVertxMetricsobject.default MetricsOptionsnewOptions()Create an empty metrics options.default MetricsOptionsnewOptions(JsonObject jsonObject)Create metrics options from the providedjsonObject.default MetricsOptionsnewOptions(MetricsOptions options)Create metrics options from the providedoptions.
-
-
-
Method Detail
-
init
default void init(io.vertx.core.internal.VertxBootstrap bootstrap)
Description copied from interface:VertxServiceProviderLet the provider initialize the Vert.x builder.- Specified by:
initin interfaceVertxServiceProvider- Parameters:
bootstrap- the builder
-
metrics
VertxMetrics metrics(VertxOptions options)
Create a newVertxMetricsobject. No specific thread and context can be expected when this method is called.- Parameters:
options- the metrics configuration option- Returns:
- the metrics implementation
-
newOptions
default MetricsOptions newOptions()
Create an empty metrics options. Providers can override this method to provide a custom metrics options subclass that exposes custom configuration.- Returns:
- new metrics options
-
newOptions
default MetricsOptions newOptions(MetricsOptions options)
Create metrics options from the providedoptions.Providers can override this method to provide a custom metrics options subclass that exposes custom configuration.
It is used when a Vert.x instance is created with a
MetricsOptionsinstance.- Parameters:
options- new metrics options- Returns:
- new metrics options
-
newOptions
default MetricsOptions newOptions(JsonObject jsonObject)
Create metrics options from the providedjsonObject.Providers can override this method to provide a custom metrics options subclass that exposes custom configuration.
- Parameters:
jsonObject- json provided by the user- Returns:
- new metrics options
-
-