Vert.x 4.5.13 · io.vertx.core.spi.VertxMetricsFactory

Method Summary

Modifier and Type	Method and Description
public default void	init(VertxBuilder the builder builder) Implements io.vertx.core.spi.VertxServiceProvider.init. Let the provider initialize the Vert.x builder.
public VertxMetrics	Returns: the metrics implementation metrics(VertxOptions the metrics configuration option options) Create a new `io.vertx.core.spi.metrics.VertxMetrics` object.
public default MetricsOptions	Returns: new metrics options newOptions() Create an empty metrics options.
public default MetricsOptions	Returns: new metrics options newOptions(MetricsOptions new metrics options options) Create metrics options from the provided `options`.
public default MetricsOptions	Returns: new metrics options newOptions(JsonObject json provided by the user jsonObject) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Create metrics options from the provided `jsonObject`.

Method Detail

init	back to summary
public default void init(VertxBuilder builder) Implements io.vertx.core.spi.VertxServiceProvider.init. Doc from io.vertx.core.spi.VertxServiceProvider.init. Let the provider initialize the Vert.x builder. Parameters builder:VertxBuilder the builder Annotations @Override

init

back to summary

public default void init(VertxBuilder builder)

Implements io.vertx.core.spi.VertxServiceProvider.init.

Doc from io.vertx.core.spi.VertxServiceProvider.init.

Let the provider initialize the Vert.x builder.

Parameters

builder:VertxBuilder: the builder

Annotations

@Override

metrics back to summary

metrics	back to summary
public VertxMetrics metrics(VertxOptions options) Create a new `io.vertx.core.spi.metrics.VertxMetrics` object. No specific thread and context can be expected when this method is called. Parameters options:VertxOptions the metrics configuration option Returns:VertxMetrics the metrics implementation

public VertxMetrics metrics(VertxOptions options)

Create a new io.vertx.core.spi.metrics.VertxMetrics object.

No specific thread and context can be expected when this method is called.

Parameters

options:VertxOptions: the metrics configuration option

Returns:VertxMetrics

the metrics implementation

newOptions back to summary

newOptions	back to summary
public default MetricsOptions newOptions() Create an empty metrics options. Providers can override this method to provide a custom metrics options subclass that exposes custom configuration. It is used by the `io.vertx.core.Launcher` class when creating new options when building a CLI Vert.x. Implementation Specification The default implementation returns `MetricsOptions#MetricsOptions()` Returns:MetricsOptions new metrics options

public default MetricsOptions newOptions()

Create an empty metrics options. Providers can override this method to provide a custom metrics options subclass that exposes custom configuration. It is used by the io.vertx.core.Launcher class when creating new options when building a CLI Vert.x.

Implementation Specification

The default implementation returns MetricsOptions#MetricsOptions()

Returns:MetricsOptions: new metrics options

newOptions back to summary

newOptions	back to summary
public default MetricsOptions newOptions(MetricsOptions options) Create metrics options from the provided `options`. 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 `MetricsOptions` instance. Implementation Specification The default implementation calls `newOptions(JsonObject)` with `MetricsOptions#toJson()` Parameters options:MetricsOptions new metrics options Returns:MetricsOptions new metrics options

public default MetricsOptions newOptions(MetricsOptions options)

Create metrics options from the provided options.

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 MetricsOptions instance.

Implementation Specification

The default implementation calls newOptions(JsonObject) with MetricsOptions#toJson()

Parameters

options:MetricsOptions: new metrics options

Returns:MetricsOptions

new metrics options

newOptions back to summary

newOptions	back to summary
public default MetricsOptions newOptions(JsonObject jsonObject) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Create metrics options from the provided `jsonObject`. Providers can override this method to provide a custom metrics options subclass that exposes custom configuration. It is used by the `io.vertx.core.Launcher` class when creating new options when building a CLI Vert.x. Implementation Specification The default implementation calls `MetricsOptions#MetricsOptions(JsonObject)` )} with `jsonObject` Parameters jsonObject:JsonObject json provided by the user Returns:MetricsOptions new metrics options

public default MetricsOptions newOptions(JsonObject jsonObject)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create metrics options from the provided jsonObject.

Providers can override this method to provide a custom metrics options subclass that exposes custom configuration.

It is used by the io.vertx.core.Launcher class when creating new options when building a CLI Vert.x.

Implementation Specification

The default implementation calls MetricsOptions#MetricsOptions(JsonObject) )} with jsonObject

Parameters

jsonObject:JsonObject: json provided by the user

Returns:MetricsOptions

new metrics options

public Interface VertxMetricsFactory

Method Summary

Method Detail