Package io.dropwizard.metrics5

Class MetricRegistry

java.lang.Object

io.dropwizard.metrics5.MetricRegistry

All Implemented Interfaces:

Metric, MetricSet

Direct Known Subclasses:

NoopMetricRegistry

public class MetricRegistry
extends Object
implements MetricSet

A registry of metric instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricRegistry.MetricSupplier<T extends Metric>

Constructor Summary

Constructors

Constructor	Description
MetricRegistry()	Creates a new MetricRegistry.

Method Summary

Modifier and Type	Method	Description
void	addListener(MetricRegistryListener listener)	Adds a MetricRegistryListener to a collection of listeners that will be notified on metric creation.
protected ConcurrentMap<MetricName,Metric>	buildMap()	Creates a new ConcurrentMap implementation for use inside the registry.
Counter	counter(MetricName name)	Return the Counter registered under this name; or create and register a new Counter if none is registered.
<T extends Counter> T	counter(MetricName name, MetricRegistry.MetricSupplier<T> supplier)	Return the Counter registered under this name; or create and register a new Counter using the provided MetricSupplier if none is registered.
Counter	counter(String name)	See counter(MetricName)
<T extends Gauge> T	gauge(MetricName name)	Return the Gauge registered under this name; or create and register a new SettableGauge if none is registered.
<T extends Gauge> T	gauge(MetricName name, MetricRegistry.MetricSupplier<T> supplier)	Return the Gauge registered under this name; or create and register a new Gauge using the provided MetricSupplier if none is registered.
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.
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(MetricName name, MetricRegistry.MetricSupplier<Histogram> supplier)	Return the Histogram registered under this name; or create and register a new Histogram using the provided MetricSupplier if none is registered.
Histogram	histogram(String name)	See histogram(MetricName)
Meter	meter(MetricName name)	Return the Meter registered under this name; or create and register a new Meter if none is registered.
Meter	meter(MetricName name, MetricRegistry.MetricSupplier<Meter> supplier)	Return the Meter registered under this name; or create and register a new Meter using the provided MetricSupplier if none is registered.
Meter	meter(String name)	See meter(MetricName)
static MetricName	name(Class<?> klass, String... names)	Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
static MetricName	name(String name, String... names)	Concatenates elements to form a dotted name, eliding any null values or empty strings.
<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)	See register(MetricName, Metric)
void	registerAll(MetricName prefix, MetricSet metrics)
void	registerAll(MetricSet metrics)	Given a metric set, registers them.
boolean	remove(MetricName name)	Removes the metric with the given name.
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(MetricName name, MetricRegistry.MetricSupplier<Timer> supplier)	Return the Timer registered under this name; or create and register a new Timer using the provided MetricSupplier if none is registered.
Timer	timer(String name)	See timer(MetricName)

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.

Method Detail

name

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

Concatenates elements to form a dotted name, eliding any null values or empty strings.

Parameters:

name - the first element of the name

names - the remaining elements of the name

Returns:

name and names concatenated by periods

name

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

Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.

Parameters:

klass - the first element of the name

names - the remaining elements of the name

Returns:

klass and names concatenated by periods

buildMap

protected ConcurrentMap<MetricName,Metric> buildMap()

Creates a new ConcurrentMap implementation for use inside the registry. Override this to create a MetricRegistry with space- or time-bounded metric lifecycles, for example.

Returns:

a new ConcurrentMap

register

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

See register(MetricName, Metric)

Throws:

IllegalArgumentException

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 or metric variable is null

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)

See 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)

See histogram(MetricName)

counter

public <T extends Counter> T counter(MetricName name,
                                     MetricRegistry.MetricSupplier<T> supplier)

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

Parameters:

name - the name of the metric

supplier - a MetricSupplier that can be used to manufacture a counter.

Returns:

a new or pre-existing Counter

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)

See meter(MetricName)

histogram

public Histogram histogram(MetricName name,
                           MetricRegistry.MetricSupplier<Histogram> supplier)

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

Parameters:

name - the name of the metric

supplier - a MetricSupplier that can be used to manufacture a histogram

Returns:

a new or pre-existing Histogram

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)

See timer(MetricName)

meter

public Meter meter(MetricName name,
                   MetricRegistry.MetricSupplier<Meter> supplier)

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

Parameters:

name - the name of the metric

supplier - a MetricSupplier that can be used to manufacture a Meter

Returns:

a new or pre-existing Meter

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

timer

public Timer timer(MetricName name,
                   MetricRegistry.MetricSupplier<Timer> supplier)

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

Parameters:

name - the name of the metric

supplier - a MetricSupplier that can be used to manufacture a Timer

Returns:

a new or pre-existing Timer

gauge

public <T extends Gauge> T gauge(MetricName name)

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

Parameters:

name - the name of the metric

Returns:

a pre-existing Gauge or a new SettableGauge

Since:

4.2

gauge

public <T extends Gauge> T gauge(MetricName name,
                                 MetricRegistry.MetricSupplier<T> supplier)

Return the Gauge registered under this name; or create and register a new Gauge using the provided MetricSupplier if none is registered.

Parameters:

name - the name of the metric

supplier - a MetricSupplier that can be used to manufacture a Gauge

Returns:

a new or pre-existing Gauge

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

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

registerAll

public void registerAll(MetricName prefix,
                        MetricSet metrics)
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

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