com.emc.mongoose.api.metrics

Class CustomMetricRegistry

java.lang.Object

com.emc.mongoose.api.metrics.CustomMetricRegistry

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet, java.io.Closeable, java.lang.AutoCloseable

public final class CustomMetricRegistry
extends java.lang.Object
implements java.io.Closeable, com.codahale.metrics.MetricSet

A registry of metric instances.

Constructor Summary

Constructors

Constructor and Description
CustomMetricRegistry() Creates a new CustomMetricRegistry.

Method Summary

Modifier and Type	Method and Description
void	addListener(com.codahale.metrics.MetricRegistryListener listener) Adds a MetricRegistryListener to a collection of listeners that will be notified on metric creation.
void	close()
com.codahale.metrics.Counter	counter(java.lang.String name) Return the Counter registered under this name; or create and register a new Counter if none is registered.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter>	getCounters() Returns a map of all the counters in the registry and their names.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter>	getCounters(com.codahale.metrics.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,com.codahale.metrics.Gauge>	getGauges() Returns a map of all the gauges in the registry and their names.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Gauge>	getGauges(com.codahale.metrics.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,com.codahale.metrics.Histogram>	getHistograms() Returns a map of all the histograms in the registry and their names.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Histogram>	getHistograms(com.codahale.metrics.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,com.codahale.metrics.Meter>	getMeters() Returns a map of all the meters in the registry and their names.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Meter>	getMeters(com.codahale.metrics.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,com.codahale.metrics.Metric>	getMetrics()
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,com.codahale.metrics.Timer>	getTimers() Returns a map of all the timers in the registry and their names.
java.util.SortedMap<java.lang.String,com.codahale.metrics.Timer>	getTimers(com.codahale.metrics.MetricFilter filter) Returns a map of all the timers in the registry and their names which match the given filter.
com.codahale.metrics.Histogram	histogram(java.lang.String name) Return the Histogram registered under this name; or create and register a new Histogram if none is registered.
com.codahale.metrics.Meter	meter(java.lang.String name) Return the Meter registered under this name; or create and register a new Meter 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 com.codahale.metrics.Metric> T	register(java.lang.String name, T metric) Given a Metric, registers it under the given name.
void	registerAll(com.codahale.metrics.MetricSet metrics) Given a metric set, registers them.
boolean	remove(java.lang.String name) Removes the metric with the given name.
void	removeListener(com.codahale.metrics.MetricRegistryListener listener) Removes a MetricRegistryListener from this registry's collection of listeners.
void	removeMatching(com.codahale.metrics.MetricFilter filter) Removes all metrics which match the given filter.
com.codahale.metrics.Timer	timer(java.lang.String name) Return the Timer registered under this name; or create and register a new Timer if none is registered.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomMetricRegistry

public CustomMetricRegistry()

Creates a new CustomMetricRegistry.

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 final <T extends com.codahale.metrics.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 final void registerAll(com.codahale.metrics.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 final com.codahale.metrics.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

histogram

public final com.codahale.metrics.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

meter

public final com.codahale.metrics.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

timer

public final com.codahale.metrics.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

remove

public final 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 final void removeMatching(com.codahale.metrics.MetricFilter filter)

Removes all metrics which match the given filter.

Parameters:

filter - a filter

addListener

public final void addListener(com.codahale.metrics.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 final void removeListener(com.codahale.metrics.MetricRegistryListener listener)

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

Parameters:

listener - the listener that will be removed

getNames

public final 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 final java.util.SortedMap<java.lang.String,com.codahale.metrics.Gauge> getGauges()

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

Returns:

all the gauges in the registry

getGauges

public final java.util.SortedMap<java.lang.String,com.codahale.metrics.Gauge> getGauges(com.codahale.metrics.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 final java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter> getCounters()

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

Returns:

all the counters in the registry

getCounters

public final java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter> getCounters(com.codahale.metrics.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 final java.util.SortedMap<java.lang.String,com.codahale.metrics.Histogram> getHistograms()

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

Returns:

all the histograms in the registry

getHistograms

public final java.util.SortedMap<java.lang.String,com.codahale.metrics.Histogram> getHistograms(com.codahale.metrics.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 final java.util.SortedMap<java.lang.String,com.codahale.metrics.Meter> getMeters()

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

Returns:

all the meters in the registry

getMeters

public final java.util.SortedMap<java.lang.String,com.codahale.metrics.Meter> getMeters(com.codahale.metrics.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 final java.util.SortedMap<java.lang.String,com.codahale.metrics.Timer> getTimers()

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

Returns:

all the timers in the registry

getTimers

public final java.util.SortedMap<java.lang.String,com.codahale.metrics.Timer> getTimers(com.codahale.metrics.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 final java.util.Map<java.lang.String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet

close

public final void close()
                 throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException