org.apache.dubbo.metrics

Class MetricRegistry

java.lang.Object

org.apache.dubbo.metrics.MetricRegistry

All Implemented Interfaces:

Metric, MetricSet

public abstract class MetricRegistry
extends Object
implements MetricSet

A registry of metric instances.

Constructor Summary

Constructors

Constructor and Description
MetricRegistry()

Method Summary

Modifier and Type	Method and Description
abstract Compass	compass(MetricName name) Create a FastCompass with given name
abstract Counter	counter(MetricName name) Return the Counter registered under this name; or create and register a new Counter if none is registered.
abstract Counter	counter(String name) Creates a new Counter and registers it under the given name.
abstract Map<MetricName,Compass>	getCompasses() Returns a map of all the compasses in the registry and their names.
abstract Map<MetricName,Compass>	getCompasses(MetricFilter filter) Returns a map of all the compasses in the registry and their names which match the given filter.
abstract Map<MetricName,Counter>	getCounters() Returns a map of all the counters in the registry and their names.
abstract Map<MetricName,Counter>	getCounters(MetricFilter filter) Returns a map of all the counters in the registry and their names which match the given filter.
abstract Map<MetricName,Gauge>	getGauges() Returns a map of all the gauges in the registry and their names.
abstract Map<MetricName,Gauge>	getGauges(MetricFilter filter) Returns a map of all the gauges in the registry and their names which match the given filter.
abstract Map<MetricName,Metric>	getMetrics(MetricFilter filter) Returns a map of all the metrics in the registry and their names which match the given filter
abstract Set<MetricName>	getNames() Returns a set of the names of all the metrics in the registry.
abstract <T extends Metric> T	register(MetricName name, T metric) Given a Metric, registers it under the given name.
abstract <T extends Metric> T	register(String name, T metric) Given a Metric, registers it under the given name.
abstract void	registerAll(MetricSet metrics) Given a metric set, registers them.
abstract boolean	remove(MetricName name) Removes the metric with the given name.
abstract void	removeMatching(MetricFilter filter) Removes all metrics which match the given filter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.dubbo.metrics.MetricSet

getMetrics

Methods inherited from interface org.apache.dubbo.metrics.Metric

lastUpdateTime

Constructor Detail

MetricRegistry

public MetricRegistry()

Method Detail

register

public abstract <T extends Metric> T register(String name,
                                              T metric)
                                       throws IllegalArgumentException

Given a Metric, registers it under the given name.

Type Parameters:

T - the type of the metric

Parameters:

name - the name of the metric

metric - the metric

Returns:

metric

Throws:

IllegalArgumentException - if the name is already registered

register

public abstract <T extends Metric> T register(MetricName name,
                                              T metric)
                                       throws IllegalArgumentException

Given a Metric, registers it under the given name.

Type Parameters:

T - the type of the metric

Parameters:

name - the name of the metric

metric - the metric

Returns:

metric

Throws:

IllegalArgumentException - if the name is already registered

registerAll

public abstract void registerAll(MetricSet metrics)
                          throws IllegalArgumentException

Given a metric set, registers them.

Parameters:

metrics - a set of metrics

Throws:

IllegalArgumentException - if any of the names are already registered

counter

public abstract Counter counter(String name)

Creates a new Counter and registers it under the given name.

Parameters:

name - the name of the metric

Returns:

a new Counter

counter

public abstract Counter counter(MetricName name)

Return the Counter registered under this name; or create and register a new Counter if none is registered.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Counter

compass

public abstract Compass compass(MetricName name)

Create a FastCompass with given name

Parameters:

name - the name of the metric

Returns:

a FastCompass instance

remove

public abstract boolean remove(MetricName name)

Removes the metric with the given name.

Parameters:

name - the name of the metric

Returns:

whether or not the metric was removed

removeMatching

public abstract void removeMatching(MetricFilter filter)

Removes all metrics which match the given filter.

Parameters:

filter - a filter

getNames

public abstract Set<MetricName> getNames()

Returns a set of the names of all the metrics in the registry.

Returns:

the names of all the metrics

getGauges

public abstract Map<MetricName,Gauge> getGauges()

Returns a map of all the gauges in the registry and their names.

Returns:

all the gauges in the registry

getGauges

public abstract Map<MetricName,Gauge> getGauges(MetricFilter filter)

Returns a map of all the gauges in the registry and their names which match the given filter.

Parameters:

filter - the metric filter to match

Returns:

all the gauges in the registry

getCounters

public abstract Map<MetricName,Counter> getCounters()

Returns a map of all the counters in the registry and their names.

Returns:

all the counters in the registry

getCounters

public abstract Map<MetricName,Counter> getCounters(MetricFilter filter)

Returns a map of all the counters in the registry and their names which match the given filter.

Parameters:

filter - the metric filter to match

Returns:

all the counters in the registry

getCompasses

public abstract Map<MetricName,Compass> getCompasses()

Returns a map of all the compasses in the registry and their names.

Returns:

all the compasses in the registry

getCompasses

public abstract Map<MetricName,Compass> getCompasses(MetricFilter filter)

Returns a map of all the compasses in the registry and their names which match the given filter.

Parameters:

filter - the metric filter to match

Returns:

all the compasses in the registry

getMetrics

public abstract Map<MetricName,Metric> getMetrics(MetricFilter filter)

Returns a map of all the metrics in the registry and their names which match the given filter

Parameters:

filter - the metric filter to match

Returns:

all the metrics in the registry