com.codahale.metrics

Class MetricRegistry

java.lang.Object

com.codahale.metrics.MetricRegistry

All Implemented Interfaces:

Metric, MetricSet

public class MetricRegistry
extends java.lang.Object
implements MetricSet

A registry of metric instances.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MetricRegistry() Creates a new MetricRegistry.

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(java.lang.String name) Return the Counter registered under this name; or create and register a new Counter if none is registered.
Counter	counter(java.lang.String name, MetricRegistry.MetricSupplier<Counter> supplier) Return the Counter registered under this name; or create and register a new Counter using the provided MetricSupplier if none is registered.
Gauge	gauge(java.lang.String name, MetricRegistry.MetricSupplier<Gauge> supplier) Return the Gauge registered under this name; or create and register a new Gauge using the provided MetricSupplier if none is registered.
java.util.SortedMap<java.lang.String,Counter>	getCounters() Returns a map of all the counters in the registry and their names.
java.util.SortedMap<java.lang.String,Counter>	getCounters(MetricFilter filter) Returns a map of all the counters in the registry and their names which match the given filter.
java.util.SortedMap<java.lang.String,Gauge>	getGauges() Returns a map of all the gauges in the registry and their names.
java.util.SortedMap<java.lang.String,Gauge>	getGauges(MetricFilter filter) Returns a map of all the gauges in the registry and their names which match the given filter.
java.util.SortedMap<java.lang.String,Histogram>	getHistograms() Returns a map of all the histograms in the registry and their names.
java.util.SortedMap<java.lang.String,Histogram>	getHistograms(MetricFilter filter) Returns a map of all the histograms in the registry and their names which match the given filter.
java.util.SortedMap<java.lang.String,Meter>	getMeters() Returns a map of all the meters in the registry and their names.
java.util.SortedMap<java.lang.String,Meter>	getMeters(MetricFilter filter) Returns a map of all the meters in the registry and their names which match the given filter.
java.util.Map<java.lang.String,Metric>	getMetrics() A map of metric names to metrics.
java.util.SortedSet<java.lang.String>	getNames() Returns a set of the names of all the metrics in the registry.
java.util.SortedMap<java.lang.String,Timer>	getTimers() Returns a map of all the timers in the registry and their names.
java.util.SortedMap<java.lang.String,Timer>	getTimers(MetricFilter filter) Returns a map of all the timers in the registry and their names which match the given filter.
Histogram	histogram(java.lang.String name) Return the Histogram registered under this name; or create and register a new Histogram if none is registered.
Histogram	histogram(java.lang.String 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.
Meter	meter(java.lang.String name) Return the Meter registered under this name; or create and register a new Meter if none is registered.
Meter	meter(java.lang.String 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.
static java.lang.String	name(java.lang.Class<?> klass, java.lang.String... names) Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
static java.lang.String	name(java.lang.String name, java.lang.String... names) Concatenates elements to form a dotted name, eliding any null values or empty strings.
<T extends Metric> T	register(java.lang.String name, T metric) Given a Metric, registers it under the given name.
void	registerAll(MetricSet metrics) Given a metric set, registers them.
boolean	remove(java.lang.String 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(java.lang.String name) Return the Timer registered under this name; or create and register a new Timer if none is registered.
Timer	timer(java.lang.String 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistry

public MetricRegistry()

Creates a new MetricRegistry.

Method Detail

name

public static java.lang.String name(java.lang.String name,
                                    java.lang.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 java.lang.String name(java.lang.Class<?> klass,
                                    java.lang.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

register

public <T extends Metric> T register(java.lang.String name,
                                     T metric)
                              throws java.lang.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:

java.lang.IllegalArgumentException - if the name is already registered

registerAll

public void registerAll(MetricSet metrics)
                 throws java.lang.IllegalArgumentException

Given a metric set, registers them.

Parameters:

metrics - a set of metrics

Throws:

java.lang.IllegalArgumentException - if any of the names are already registered

counter

public Counter counter(java.lang.String 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

counter

public Counter counter(java.lang.String name,
                       MetricRegistry.MetricSupplier<Counter> 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(java.lang.String 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

histogram

public Histogram histogram(java.lang.String 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(java.lang.String 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

meter

public Meter meter(java.lang.String 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(java.lang.String 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(java.lang.String 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 Gauge gauge(java.lang.String name,
                   MetricRegistry.MetricSupplier<Gauge> 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(java.lang.String 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 java.util.SortedSet<java.lang.String> getNames()

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

Returns:

the names of all the metrics

getGauges

public java.util.SortedMap<java.lang.String,Gauge> getGauges()

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

Returns:

all the gauges in the registry

getGauges

public java.util.SortedMap<java.lang.String,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 java.util.SortedMap<java.lang.String,Counter> getCounters()

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

Returns:

all the counters in the registry

getCounters

public java.util.SortedMap<java.lang.String,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 java.util.SortedMap<java.lang.String,Histogram> getHistograms()

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

Returns:

all the histograms in the registry

getHistograms

public java.util.SortedMap<java.lang.String,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 java.util.SortedMap<java.lang.String,Meter> getMeters()

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

Returns:

all the meters in the registry

getMeters

public java.util.SortedMap<java.lang.String,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 java.util.SortedMap<java.lang.String,Timer> getTimers()

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

Returns:

all the timers in the registry

getTimers

public java.util.SortedMap<java.lang.String,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

getMetrics

public java.util.Map<java.lang.String,Metric> getMetrics()

Description copied from interface: MetricSet

A map of metric names to metrics.

Specified by:

getMetrics in interface MetricSet

Returns:

the metrics