API Documentation
Back to top  

MetricsService

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

package

Default

Methods

__construct

__construct()

Creates a metric service for a given @see \io\vertx\jphp\core\Vertx instance.

create( $arg0) : \io\vertx\jphp\ext\dropwizard\MetricsService
static

Arguments

$arg0

Vertx

Response

\io\vertx\jphp\ext\dropwizard\MetricsService

the metrics service

getBaseName

getBaseName( $arg0) : string

Arguments

$arg0

Measured

Response

string

the base name of the measured object

Will return the metrics that correspond with the <code>measured</code> object, null if no metrics is available.<p/>

getMetricsSnapshot( $arg0) : array

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

param $measured [Measured] getMetricsSnapshot($measured)

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.

param $baseName [string] getMetricsSnapshot($baseName)

Arguments

$arg0

string | Measured

Response

array

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

metricsNames

metricsNames() : array

Response

array

the known metrics names by this service