vertx / io.vertx.ext.dropwizard / MetricsService

MetricsService

interface MetricsService

The metrics service mainly allows to return a snapshot of measured objects.

Author
Nick Scavelli

Functions

create

open static fun create(vertx: Vertx): MetricsService

Creates a metric service for a given io.vertx.core.Vertx instance.

getBaseName

abstract fun getBaseName(measured: Measured): String

getMetricsSnapshot

abstract fun getMetricsSnapshot(measured: Measured): JsonObject

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.

abstract fun getMetricsSnapshot(baseName: String): JsonObject

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.

metricsNames

abstract fun metricsNames(): MutableSet<String>