com.hivemq.spi.services

Interface AsyncMetricService

public interface AsyncMetricService

This service allows plugins to get or add global HiveMQ metrics.

Author:

Lukas Brandl

Method Summary

Methods

Modifier and Type	Method and Description
<T extends com.codahale.metrics.Metric> com.google.common.util.concurrent.ListenableFuture<Map<String,T>>	getClusterMetric(HiveMQMetric<T> metric) Returns a map which contains an entry for every node in the cluster with the given HiveMQ metric.
<T extends com.codahale.metrics.Metric> com.google.common.util.concurrent.ListenableFuture<T>	getHiveMQMetric(HiveMQMetric<T> metric) Returns a specific HiveMQ metric.
com.codahale.metrics.MetricRegistry	getMetricRegistry() Returns the metric registry of HiveMQ.

Method Detail

getHiveMQMetric

<T extends com.codahale.metrics.Metric> com.google.common.util.concurrent.ListenableFuture<T> getHiveMQMetric(HiveMQMetric<T> metric)

Returns a specific HiveMQ metric. If the metric does not exist, this method will return null.

For a list of all available metrics, refer to the HiveMQMetrics constant class.

Type Parameters:

T - the metric type

Parameters:

metric - the metric

Returns:

a ListenableFuture with the metric (if available) or a null result.

getClusterMetric

<T extends com.codahale.metrics.Metric> com.google.common.util.concurrent.ListenableFuture<Map<String,T>> getClusterMetric(HiveMQMetric<T> metric)

Returns a map which contains an entry for every node in the cluster with the given HiveMQ metric. An entry represents the name of the node (key) and the associated metric for the node (value). If the metric does not exist, this method will return null.

For a list of all available metrics, refer to the HiveMQMetrics constant class.

Type Parameters:

T - the metric type

Parameters:

metric - the metric

Returns:

a ListenableFuture with a map that contains node names and their sought-after metrics or null.

getMetricRegistry

com.codahale.metrics.MetricRegistry getMetricRegistry()

Returns the metric registry of HiveMQ.

Returns:

the metric registry