Class MetricsOptions

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 Details

    • DEFAULT_METRICS_ENABLED

      public static final boolean DEFAULT_METRICS_ENABLED
      The default value of metrics enabled false
      See Also:

  • Constructor Details

    • 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 Details

    • 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