io.dropwizard.metrics

Class MetricRegistry

java.lang.Object

io.dropwizard.metrics.MetricRegistry

All Implemented Interfaces:

Metric, MetricSet

public class MetricRegistry
extends Object
implements MetricSet

A registry of metric instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricRegistry.MetricBuilder<T extends Metric> A quick and easy way of capturing the notion of default metrics.

Constructor Summary

Constructors

Modifier	Constructor and Description
	MetricRegistry() Creates a new MetricRegistry.
protected	MetricRegistry(ConcurrentMap<MetricName,Metric> metricsMap) Creates a MetricRegistry with a custom ConcurrentMap implementation for use inside the registry.

Method Summary

Modifier and Type	Method and Description
void	addListener(MetricRegistryListener listener) Adds a MetricRegistryListener to a collection of listeners that will be notified on metric creation.
Counter	counter(MetricName name) Return the Counter registered under this name; or create and register a new Counter if none is registered.
Counter	counter(String name)
SortedMap<MetricName,Counter>	getCounters() Returns a map of all the counters in the registry and their names.
SortedMap<MetricName,Counter>	getCounters(MetricFilter filter) Returns a map of all the counters in the registry and their names which match the given filter.
SortedMap<MetricName,Gauge>	getGauges() Returns a map of all the gauges in the registry and their names.
SortedMap<MetricName,Gauge>	getGauges(MetricFilter filter) Returns a map of all the gauges in the registry and their names which match the given filter.
SortedMap<MetricName,Histogram>	getHistograms() Returns a map of all the histograms in the registry and their names.
SortedMap<MetricName,Histogram>	getHistograms(MetricFilter filter) Returns a map of all the histograms in the registry and their names which match the given filter.
SortedMap<MetricName,Meter>	getMeters() Returns a map of all the meters in the registry and their names.
SortedMap<MetricName,Meter>	getMeters(MetricFilter filter) Returns a map of all the meters in the registry and their names which match the given filter.
Map<MetricName,Metric>	getMetrics() A map of metric names to metrics.
SortedSet<MetricName>	getNames() Returns a set of the names of all the metrics in the registry.
<T extends Metric> T	getOrAdd(MetricName name, MetricRegistry.MetricBuilder<T> builder)
SortedMap<MetricName,Timer>	getTimers() Returns a map of all the timers in the registry and their names.
SortedMap<MetricName,Timer>	getTimers(MetricFilter filter) Returns a map of all the timers in the registry and their names which match the given filter.
Histogram	histogram(MetricName name) Return the Histogram registered under this name; or create and register a new Histogram if none is registered.
Histogram	histogram(String name)
Meter	meter(MetricName name) Return the Meter registered under this name; or create and register a new Meter if none is registered.
Meter	meter(String name)
static MetricName	name(Class<?> klass, String... names)
static MetricName	name(String name, String... names) Shorthand method for backwards compatibility in creating metric names.
<T extends Metric> T	register(MetricName name, T metric) Given a Metric, registers it under the given name.
<T extends Metric> T	register(String name, T metric)
void	registerAll(MetricSet metrics) Given a metric set, registers them.
boolean	remove(MetricName name) Removes the metric with the given name.
void	removeAll() Removes all the metrics in registry.
void	removeListener(MetricRegistryListener listener) Removes a MetricRegistryListener from this registry's collection of listeners.
void	removeMatching(MetricFilter filter) Removes all metrics which match the given filter.
Timer	timer(MetricName name) Return the Timer registered under this name; or create and register a new Timer if none is registered.
Timer	timer(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistry

public MetricRegistry()

Creates a new MetricRegistry.

MetricRegistry

protected MetricRegistry(ConcurrentMap<MetricName,Metric> metricsMap)

Creates a MetricRegistry with a custom ConcurrentMap implementation for use inside the registry. Call as the super-constructor to create a MetricRegistry with space- or time-bounded metric lifecycles, for example.

Parameters:

metricsMap - metricsMap

Method Detail

name

public static MetricName name(Class<?> klass,
                              String... names)

Parameters:

klass - klass

names - names

Returns:

MetricName

See Also:

name(String, String...)

name

public static MetricName name(String name,
                              String... names)

Shorthand method for backwards compatibility in creating metric names. Uses MetricName.build(String...) for its heavy lifting.

Parameters:

name - The first element of the name

names - The remaining elements of the name

Returns:

A metric name matching the specified components.

See Also:

MetricName.build(String...)

register

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

Type Parameters:

T - type of metrics

Parameters:

name - name

metric - metric

Returns:

T git smetric

Throws:

IllegalArgumentException

See Also:

register(MetricName, Metric)

register

public <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 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 Counter counter(String name)

Parameters:

name - name

Returns:

Counter counter

See Also:

counter(MetricName)

counter

public 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

histogram

public Histogram histogram(String name)

Parameters:

name - name

Returns:

Histogram Histogram

See Also:

histogram(MetricName)

histogram

public Histogram histogram(MetricName name)

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

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Histogram

meter

public Meter meter(String name)

Parameters:

name - name

Returns:

Meter Meter

See Also:

meter(MetricName)

meter

public Meter meter(MetricName name)

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

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Meter

timer

public Timer timer(String name)

Parameters:

name - name

Returns:

Timer Timer

See Also:

timer(MetricName)

timer

public Timer timer(MetricName name)

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

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Timer

remove

public 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

removeAll

public void removeAll()

Removes all the metrics in registry.

removeMatching

public void removeMatching(MetricFilter filter)

Removes all metrics which match the given filter.

Parameters:

filter - a filter

addListener

public void addListener(MetricRegistryListener listener)

Adds a MetricRegistryListener to a collection of listeners that will be notified on metric creation. Listeners will be notified in the order in which they are added. N.B.: The listener will be notified of all existing metrics when it first registers.

Parameters:

listener - the listener that will be notified

removeListener

public void removeListener(MetricRegistryListener listener)

Removes a MetricRegistryListener from this registry's collection of listeners.

Parameters:

listener - the listener that will be removed

getNames

public SortedSet<MetricName> getNames()

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

Returns:

the names of all the metrics

getGauges

public SortedMap<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 SortedMap<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 SortedMap<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 SortedMap<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

getHistograms

public SortedMap<MetricName,Histogram> getHistograms()

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

Returns:

all the histograms in the registry

getHistograms

public SortedMap<MetricName,Histogram> getHistograms(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the histograms in the registry

getMeters

public SortedMap<MetricName,Meter> getMeters()

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

Returns:

all the meters in the registry

getMeters

public SortedMap<MetricName,Meter> getMeters(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the meters in the registry

getTimers

public SortedMap<MetricName,Timer> getTimers()

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

Returns:

all the timers in the registry

getTimers

public SortedMap<MetricName,Timer> getTimers(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the timers in the registry

getOrAdd

public <T extends Metric> T getOrAdd(MetricName name,
                                     MetricRegistry.MetricBuilder<T> builder)

getMetrics

public Map<MetricName,Metric> getMetrics()

Description copied from interface: MetricSet

A map of metric names to metrics.

Specified by:

getMetrics in interface MetricSet

Returns:

the metrics