Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricsService

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

Hierarchy

  • MetricsService

Index

Methods

Methods

getBaseName

  • getBaseName(measured: Measured): string

  • Parameters

    • measured: Measured

    Returns string

getMetricsSnapshot

  • getMetricsSnapshot(measured: Measured): {}
  • getMetricsSnapshot(baseName: string): {}

  • 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: Measured

    Returns {}

    • [key: string]: any

  • 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: string

    Returns {}

    • [key: string]: any

metricsNames

  • metricsNames(): string

  • Returns string

Static create

  • Creates a metric service for a given {@link Vertx} instance.

    Parameters

    • vertx: Vertx

    Returns MetricsService

Generated using TypeDoc