Vert.x 4.5.13 · io.vertx.core.metrics.MetricsOptions

Modifier and Type	Field and Description
public static final boolean	DEFAULT_METRICS_ENABLED The default value of metrics enabled false
private boolean	enabled
private VertxMetricsFactory	factory
private JsonObject	json References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.

Constructor Summary

Access	Constructor and Description
public	MetricsOptions() Default constructor
public	MetricsOptions(MetricsOptions The other `MetricsOptions` to copy when creating this other) Copy constructor
public	MetricsOptions(JsonObject the JsonObject to create it from json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Create an instance from a `io.vertx.core.json.JsonObject`

Method Summary

Modifier and Type	Method and Description
public VertxMetricsFactory	Returns: the metrics factory getFactory() Get the metrics factory to be used when metrics are enabled.
public boolean	Returns: true if enabled, false if not. isEnabled() Will metrics be enabled on the Vert.x instance?
public MetricsOptions	Returns: a reference to this, so the API can be used fluently setEnabled(boolean true if metrics enabled, or false if not. enable) Set whether metrics will be enabled on the Vert.x instance.
public MetricsOptions	Returns: a reference to this, so the API can be used fluently setFactory(VertxMetricsFactory the metrics factory factory) Deprecated instead use `io.vertx.core.VertxBuilder#withMetrics(VertxMetricsFactory)` Programmatically set the metrics factory to be used when metrics are enabled.
public JsonObject	toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

DEFAULT_METRICS_ENABLED	back to summary
public static final boolean DEFAULT_METRICS_ENABLED The default value of metrics enabled false

enabled	back to summary
private boolean enabled

factory	back to summary
private VertxMetricsFactory factory

json	back to summary
private JsonObject json References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

Constructor Detail

MetricsOptions	back to summary
public MetricsOptions() Default constructor

MetricsOptions back to summary

MetricsOptions	back to summary
public MetricsOptions(MetricsOptions other) Copy constructor Parameters other:MetricsOptions The other `MetricsOptions` to copy when creating this

public MetricsOptions(MetricsOptions other)

Copy constructor

Parameters

other:MetricsOptions: The other MetricsOptions to copy when creating this

MetricsOptions back to summary

MetricsOptions	back to summary
public MetricsOptions(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Create an instance from a `io.vertx.core.json.JsonObject` Parameters json:JsonObject the JsonObject to create it from

public MetricsOptions(JsonObject json)

References Deprecated

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

See corresponding docs for further information.

Create an instance from a io.vertx.core.json.JsonObject

Parameters

json:JsonObject: the JsonObject to create it from

Method Detail

getFactory back to summary

getFactory	back to summary
public VertxMetricsFactory getFactory() Get the metrics factory to be used when metrics are enabled. If the metrics factory has been programmatically set here, then that will be used when metrics are enabled for creating the `io.vertx.core.spi.metrics.VertxMetrics` instance. Otherwise Vert.x attempts to locate a metrics factory implementation on the classpath. Returns:VertxMetricsFactory the metrics factory

public VertxMetricsFactory getFactory()

Get the metrics factory to be used when metrics are enabled.

If the metrics factory has been programmatically set here, then that will be used when metrics are enabled for creating the io.vertx.core.spi.metrics.VertxMetrics instance.

Otherwise Vert.x attempts to locate a metrics factory implementation on the classpath.

Returns:VertxMetricsFactory: the metrics factory

isEnabled	back to summary
public boolean isEnabled() Will metrics be enabled on the Vert.x instance? Returns:boolean true if enabled, false if not.

isEnabled

back to summary

public boolean isEnabled()

Will metrics be enabled on the Vert.x instance?

Returns:boolean: true if enabled, false if not.

setEnabled	back to summary
public MetricsOptions setEnabled(boolean enable) Set whether metrics will be enabled on the Vert.x instance. Parameters enable:boolean true if metrics enabled, or false if not. Returns:MetricsOptions a reference to this, so the API can be used fluently

setEnabled

back to summary

public MetricsOptions setEnabled(boolean enable)

Set whether metrics will be enabled on the Vert.x instance.

Parameters

enable:boolean: true if metrics enabled, or false if not.

Returns:MetricsOptions

a reference to this, so the API can be used fluently

setFactory back to summary

setFactory	back to summary
public MetricsOptions setFactory(VertxMetricsFactory factory) Deprecated instead use `io.vertx.core.VertxBuilder#withMetrics(VertxMetricsFactory)` Programmatically set the metrics factory to be used when metrics are enabled. Only valid if `MetricsOptions#isEnabled` = true. Normally Vert.x will look on the classpath for a metrics factory implementation, but if you want to set one programmatically you can use this method. Parameters factory:VertxMetricsFactory the metrics factory Returns:MetricsOptions a reference to this, so the API can be used fluently Annotations @Deprecated

public MetricsOptions setFactory(VertxMetricsFactory factory)

Deprecated

instead use io.vertx.core.VertxBuilder#withMetrics(VertxMetricsFactory)

Programmatically set the metrics factory to be used when metrics are enabled.

Only valid if MetricsOptions#isEnabled = true.

Normally Vert.x will look on the classpath for a metrics factory implementation, but if you want to set one programmatically you can use this method.

Parameters

factory:VertxMetricsFactory: the metrics factory

Returns:MetricsOptions

a reference to this, so the API can be used fluently

Annotations

@Deprecated

toJson	back to summary
public JsonObject toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class MetricsOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail