Package io.vertx.rxjava3.ext.dropwizard

Class MetricsService

java.lang.Object
io.vertx.rxjava3.ext.dropwizard.MetricsService
All Implemented Interfaces:
RxDelegate
public class MetricsService extends Object implements RxDelegate
The metrics service mainly allows to return a snapshot of measured objects.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • MetricsService

      public MetricsService(MetricsService delegate)

    • MetricsService

      public MetricsService(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public MetricsService getDelegate()
      Specified by:
      getDelegate in interface RxDelegate

    • create

      public static MetricsService create(io.vertx.rxjava3.core.Vertx vertx)
      Creates a metric service for a given Vertx instance.
      Parameters:
      vertx - the vertx instance
      Returns:
      the metrics service

    • getBaseName

      public String getBaseName(Measured measured)
      Parameters:
      measured - the measure object
      Returns:
      the base name of the measured object

    • metricsNames

      public Set<String> metricsNames()
      Returns:
      the known metrics names by this service

    • getMetricsSnapshot

      public JsonObject getMetricsSnapshot(Measured measured)
      Will return the metrics that correspond with the measured object, null if no metrics is available.

      Note: in the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server.

      Parameters:
      measured -
      Returns:
      the map of metrics where the key is the name of the metric (excluding the base name unless for the Vert.x object) and the value is the json data representing that metric

    • getMetricsSnapshot

      public JsonObject getMetricsSnapshot(String baseName)
      Will return the metrics that begins with the baseName, null if no metrics is available.

      Note: in the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server.

      Parameters:
      baseName -
      Returns:
      the map of metrics where the key is the name of the metric and the value is the json data representing that metric

    • newInstance

      public static MetricsService newInstance(MetricsService arg)