MetricsOptions (Vert.x Stack - Docs 5.0.0.CR3 API)

java.lang.Object
- io.vertx.core.metrics.MetricsOptions

Direct Known Subclasses:

DropwizardMetricsOptions, MicrometerMetricsOptions
```
public class MetricsOptions
extends Object
```
Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific implementations.

Author:

Julien Viet

Field Summary

Fields
Modifier and Type Field Description

static boolean DEFAULT_METRICS_ENABLED
The default value of metrics enabled false

Constructor Summary

Constructors
Constructor	Description
`MetricsOptions()`	Default constructor
`MetricsOptions(JsonObject json)`	Create an instance from a `JsonObject`
`MetricsOptions(MetricsOptions other)`	Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isEnabled()`	Will metrics be enabled on the Vert.x instance?
`MetricsOptions`	`setEnabled(boolean enable)`	Set whether metrics will be enabled on the Vert.x instance.
`JsonObject`	`toJson()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_METRICS_ENABLED
```
public static final boolean DEFAULT_METRICS_ENABLED
```
    The default value of metrics enabled false
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetricsOptions
```
public MetricsOptions()
```
    Default constructor
  - MetricsOptions
```
public MetricsOptions(MetricsOptions other)
```
    Copy constructor
    
    Parameters:
    
    other - The other MetricsOptions to copy when creating this
  - MetricsOptions
```
public MetricsOptions(JsonObject json)
```
    Create an instance from a JsonObject
    
    Parameters:
    
    json - the JsonObject to create it from
- Method Detail
  - isEnabled
```
public boolean isEnabled()
```
    Will metrics be enabled on the Vert.x instance?
    
    Returns:
    
    true if enabled, false if not.
  - setEnabled
```
public MetricsOptions setEnabled(boolean enable)
```
    Set whether metrics will be enabled on the Vert.x instance.
    
    Parameters:
    
    enable - true if metrics enabled, or false if not.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - toJson
```
public JsonObject toJson()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object