org.eclipse.microprofile.metrics

Interface MetricRegistry

public interface MetricRegistry

The registry that stores metrics and their metadata. The MetricRegistry provides methods to register, create and retrieve metrics and their respective metadata.

See Also:

MetricFilter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricRegistry.Type An enumeration representing the scopes of the MetricRegistry

Method Summary

Modifier and Type	Method and Description
ConcurrentGauge	concurrentGauge(Metadata metadata) Return the ConcurrentGauge registered under the MetricID with the Metadata's name; or create and register a new ConcurrentGauge if none is registered.
ConcurrentGauge	concurrentGauge(Metadata metadata, Tag... tags) Return the ConcurrentGauge registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered.
ConcurrentGauge	concurrentGauge(MetricID metricID) Return the ConcurrentGauge registered under the MetricID; or create and register a new ConcurrentGauge if none is registered.
default ConcurrentGauge	concurrentGauge(String name) Return the ConcurrentGauge registered under the MetricID with this name; or create and register a new ConcurrentGauge if none is registered.
default ConcurrentGauge	concurrentGauge(String name, Tag... tags) Return the ConcurrentGauge registered under the MetricID with this name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered.
Counter	counter(Metadata metadata) Return the Counter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Counter if none is registered.
Counter	counter(Metadata metadata, Tag... tags) Return the Counter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Counter if none is registered.
Counter	counter(MetricID metricID) Return the Counter registered under the MetricID; or create and register a new Counter if none is registered.
default Counter	counter(String name) Return the Counter registered under the MetricID with this name and with no tags; or create and register a new Counter if none is registered.
default Counter	counter(String name, Tag... tags) Return the Counter registered under the MetricID with this name and with the provided Tags; or create and register a new Counter if none is registered.
Gauge<?>	gauge(MetricID metricID, Gauge<?> gauge) Return the Gauge registered under the MetricID; or create and register this gauge if none is registered.
default Gauge<?>	gauge(String name, Gauge<?> gauge) Return the Gauge registered under the MetricID with this name and with no tags; or create and register this gauge if none is registered.
default Gauge<?>	gauge(String name, Gauge<?> gauge, Tag... tags) Return the Gauge registered under the MetricID with this name and with the provided Tags; or create and register this gauge if none is registered.
default ConcurrentGauge	getConcurrentGauge(MetricID metricID) Return the ConcurrentGauge registered for the provided MetricID.
SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges() Returns a map of all the concurrent gauges in the registry and their MetricIDs.
default SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges(MetricFilter filter) Returns a map of all the concurrent gauges in the registry and their MetricIDs which match the given filter.
default Counter	getCounter(MetricID metricID) Return the Counter registered for the provided MetricID.
SortedMap<MetricID,Counter>	getCounters() Returns a map of all the counters in the registry and their MetricIDs.
default SortedMap<MetricID,Counter>	getCounters(MetricFilter filter) Returns a map of all the counters in the registry and their MetricIDs which match the given filter.
default Gauge<?>	getGauge(MetricID metricID) Return the Gauge registered for the provided MetricID.
SortedMap<MetricID,Gauge>	getGauges() Returns a map of all the gauges in the registry and their MetricIDs.
default SortedMap<MetricID,Gauge>	getGauges(MetricFilter filter) Returns a map of all the gauges in the registry and their MetricIDs which match the given filter.
default Histogram	getHistogram(MetricID metricID) Return the Histogram registered for the provided MetricID.
SortedMap<MetricID,Histogram>	getHistograms() Returns a map of all the histograms in the registry and their MetricIDs.
default SortedMap<MetricID,Histogram>	getHistograms(MetricFilter filter) Returns a map of all the histograms in the registry and their MetricIDs which match the given filter.
Map<String,Metadata>	getMetadata() Deprecated. Prior to 2.4 this method was the standard way to access Metadata by their name; Doing so might cause unnecessary creation of an intermediate map that might be computed by the implementation. Prefer getMetadata(String) for key based lookup of a single Metadata; Use getNames() to iterate over all names.
Metadata	getMetadata(String name) Return the Metadata for the provided name.
default Meter	getMeter(MetricID metricID) Return the Meter registered for the provided MetricID.
SortedMap<MetricID,Meter>	getMeters() Returns a map of all the meters in the registry and their MetricIDs.
default SortedMap<MetricID,Meter>	getMeters(MetricFilter filter) Returns a map of all the meters in the registry and their MetricIDs which match the given filter.
Metric	getMetric(MetricID metricID) Return the Metric registered for a provided MetricID.
default <T extends Metric> T	getMetric(MetricID metricID, Class<T> asType) Return the Metric registered for the provided MetricID as the provided type.
SortedSet<MetricID>	getMetricIDs() Returns a set of the MetricIDs of all the metrics in the registry.
Map<MetricID,Metric>	getMetrics() Deprecated. Prior to 2.4 this method was the standard way to access Metrics by their MetricID; Doing so might cause unnecessary creation of an intermediate map that might be computed by the implementation. Prefer getMetric(MetricID) for key based lookup of single Metric; Use getMetricIDs() to iterate over all metrics. Use getMetrics(MetricFilter) with MetricFilter.ALL if a (most likely) computed Map is preferred.
default <T extends Metric> SortedMap<MetricID,T>	getMetrics(Class<T> ofType, MetricFilter filter) Returns a map of all the metrics in the registry and their MetricIDs which match the given filter and which are assignable to the provided type.
SortedMap<MetricID,Metric>	getMetrics(MetricFilter filter) Returns a map of all the metrics in the registry and their MetricIDs which match the given filter.
SortedSet<String>	getNames() Returns a set of the names of all the metrics in the registry.
default SimpleTimer	getSimpleTimer(MetricID metricID) Return the SimpleTimer registered for the provided MetricID.
SortedMap<MetricID,SimpleTimer>	getSimpleTimers() Returns a map of all the simple timers in the registry and their MetricIDs.
default SortedMap<MetricID,SimpleTimer>	getSimpleTimers(MetricFilter filter) Returns a map of all the simple timers in the registry and their MetricIDs which match the given filter.
default Timer	getTimer(MetricID metricID) Return the Timer registered for the provided MetricID.
SortedMap<MetricID,Timer>	getTimers() Returns a map of all the timers in the registry and their MetricIDs.
default SortedMap<MetricID,Timer>	getTimers(MetricFilter filter) Returns a map of all the timers in the registry and their MetricIDs which match the given filter.
MetricRegistry.Type	getType() Returns the type of this metric registry.
Histogram	histogram(Metadata metadata) Return the Histogram registered under the MetricID with the Metadata's name and with no tags; or create and register a new Histogram if none is registered.
Histogram	histogram(Metadata metadata, Tag... tags) Return the Histogram registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Histogram if none is registered.
Histogram	histogram(MetricID metricID) Return the Histogram registered under the MetricID; or create and register a new Histogram if none is registered.
default Histogram	histogram(String name) Return the Histogram registered under the MetricID with this name and with no tags; or create and register a new Histogram if none is registered.
default Histogram	histogram(String name, Tag... tags) Return the Histogram registered under the MetricID with this name and with the provided Tags; or create and register a new Histogram if none is registered.
Meter	meter(Metadata metadata) Return the Meter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Meter if none is registered.
Meter	meter(Metadata metadata, Tag... tags) Return the Meter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Meter if none is registered.
Meter	meter(MetricID metricID) Return the Meter registered under the MetricID; or create and register a new Meter if none is registered.
default Meter	meter(String name) Return the Meter registered under the MetricID with this name and with no tags; or create and register a new Meter if none is registered.
default Meter	meter(String name, Tag... tags) Return the Meter registered under the MetricID with this name and with the provided Tags; or create and register a new Meter if none is registered.
static String	name(Class<?> klass, String... names) Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
static String	name(String name, String... names) Concatenates elements to form a dotted name, eliding any null values or empty strings.
<T extends Metric> T	register(Metadata metadata, T metric) Given a Metric and Metadata, registers the metric with a MetricID with the name provided by the Metadata and with no tags.
<T extends Metric> T	register(Metadata metadata, T metric, Tag... tags) Given a Metric and Metadata, registers both under a MetricID with the name provided by the Metadata and with the provided Tags.
<T extends Metric> T	register(String name, T metric) Given a Metric, registers it under a MetricID with the given name and with no tags.
boolean	remove(MetricID metricID) Removes the metric with the given MetricID
boolean	remove(String name) Removes all metrics with the given name.
void	removeMatching(MetricFilter filter) Removes all metrics which match the given filter.
SimpleTimer	simpleTimer(Metadata metadata) Return the SimpleTimer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new SimpleTimer if none is registered.
SimpleTimer	simpleTimer(Metadata metadata, Tag... tags) Return the SimpleTimer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new SimpleTimer if none is registered.
SimpleTimer	simpleTimer(MetricID metricID) Return the SimpleTimer registered under the MetricID; or create and register a new SimpleTimer if none is registered.
default SimpleTimer	simpleTimer(String name) Return the SimpleTimer registered under the MetricID with this name and with no tags; or create and register a new SimpleTimer if none is registered.
default SimpleTimer	simpleTimer(String name, Tag... tags) Return the SimpleTimer registered under the MetricID with this name and with the provided Tags; or create and register a new SimpleTimer if none is registered.
Timer	timer(Metadata metadata) Return the Timer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new Timer if none is registered.
Timer	timer(Metadata metadata, Tag... tags) Return the Timer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new Timer if none is registered.
Timer	timer(MetricID metricID) Return the Timer registered under the MetricID; or create and register a new Timer if none is registered.
default Timer	timer(String name) Return the Timer registered under the MetricID with this name and with no tags; or create and register a new Timer if none is registered.
default Timer	timer(String name, Tag... tags) Return the Timer registered under the MetricID with this name and with the provided Tags; or create and register a new Timer if none is registered.

Method Detail

name

static String 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

static String 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

register

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

Given a Metric, registers it under a MetricID with the given name and with no tags. A Metadata object will be registered with the name and type. However, if a Metadata object is already registered with this metric name and is not equal to the created Metadata object then an exception will be thrown.

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 if Metadata with different values has already been registered with the name

register

<T extends Metric> T register(Metadata metadata,
                              T metric)
                       throws IllegalArgumentException

Given a Metric and Metadata, registers the metric with a MetricID with the name provided by the Metadata and with no tags.

Note: If a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Type Parameters:

T - the type of the metric

Parameters:

metadata - the metadata

metric - the metric

Returns:

metric

Throws:

IllegalArgumentException - if the name is already registered or if Metadata with different values has already been registered with the name

Since:

1.1

register

<T extends Metric> T register(Metadata metadata,
                              T metric,
                              Tag... tags)
                       throws IllegalArgumentException

Given a Metric and Metadata, registers both under a MetricID with the name provided by the Metadata and with the provided Tags.

Note: If a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Type Parameters:

T - the type of the metric

Parameters:

metadata - the metadata

metric - the metric

tags - the tags of the metric

Returns:

metric

Throws:

IllegalArgumentException - if the name is already registered or if Metadata with different values has already been registered with the name

Since:

2.0

counter

default Counter counter(String name)

Return the Counter registered under the MetricID with this name and with no tags; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Counter

counter

default Counter counter(String name,
                        Tag... tags)

Return the Counter registered under the MetricID with this name and with the provided Tags; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Counter

Since:

2.0

counter

Counter counter(MetricID metricID)

Return the Counter registered under the MetricID; or create and register a new Counter if none is registered. If a Counter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing Counter

Since:

3.0

counter

Counter counter(Metadata metadata)

Return the Counter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Counter if none is registered. If a Counter was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing Counter

counter

Counter counter(Metadata metadata,
                Tag... tags)

Return the Counter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Counter if none is registered. If a Counter was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Counter

Since:

2.0

concurrentGauge

default ConcurrentGauge concurrentGauge(String name)

Return the ConcurrentGauge registered under the MetricID with this name; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing ConcurrentGauge

concurrentGauge

default ConcurrentGauge concurrentGauge(String name,
                                        Tag... tags)

Return the ConcurrentGauge registered under the MetricID with this name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing ConcurrentGauge

concurrentGauge

ConcurrentGauge concurrentGauge(MetricID metricID)

Return the ConcurrentGauge registered under the MetricID; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, a Metadata object will be registered with the name and type.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing ConcurrentGauge

Since:

3.0

concurrentGauge

ConcurrentGauge concurrentGauge(Metadata metadata)

Return the ConcurrentGauge registered under the MetricID with the Metadata's name; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing ConcurrentGauge

concurrentGauge

ConcurrentGauge concurrentGauge(Metadata metadata,
                                Tag... tags)

Return the ConcurrentGauge registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new ConcurrentGauge if none is registered. If a ConcurrentGauge was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing ConcurrentGauge

gauge

default Gauge<?> gauge(String name,
                       Gauge<?> gauge)

Return the Gauge registered under the MetricID with this name and with no tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

gauge - the Gauge to use if none is registered already

Returns:

the pre-existing or provided Gauge

Since:

3.0

gauge

default Gauge<?> gauge(String name,
                       Gauge<?> gauge,
                       Tag... tags)

Return the Gauge registered under the MetricID with this name and with the provided Tags; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

gauge - the Gauge to use if none is registered already

Returns:

the pre-existing or provided Gauge

Since:

3.0

gauge

Gauge<?> gauge(MetricID metricID,
               Gauge<?> gauge)

Return the Gauge registered under the MetricID; or create and register this gauge if none is registered. If a Gauge was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

gauge - the Gauge to use if none is registered already

Returns:

the pre-existing or provided Gauge

Since:

3.0

histogram

default Histogram histogram(String name)

Return the Histogram registered under the MetricID with this name and with no tags; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Histogram

histogram

default Histogram histogram(String name,
                            Tag... tags)

Return the Histogram registered under the MetricID with this name and with the provided Tags; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Histogram

Since:

2.0

histogram

Histogram histogram(MetricID metricID)

Return the Histogram registered under the MetricID; or create and register a new Histogram if none is registered. If a Histogram was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing Histogram

Since:

3.0

histogram

Histogram histogram(Metadata metadata)

Return the Histogram registered under the MetricID with the Metadata's name and with no tags; or create and register a new Histogram if none is registered. If a Histogram was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing Histogram

histogram

Histogram histogram(Metadata metadata,
                    Tag... tags)

Return the Histogram registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Histogram if none is registered. If a Histogram was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Histogram

Since:

2.0

meter

default Meter meter(String name)

Return the Meter registered under the MetricID with this name and with no tags; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Meter

meter

default Meter meter(String name,
                    Tag... tags)

Return the Meter registered under the MetricID with this name and with the provided Tags; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Meter

Since:

2.0

meter

Meter meter(MetricID metricID)

Return the Meter registered under the MetricID; or create and register a new Meter if none is registered. If a Meter was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing Meter

Since:

3.0

meter

Meter meter(Metadata metadata)

Return the Meter registered under the MetricID with the Metadata's name and with no tags; or create and register a new Meter if none is registered. If a Meter was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing Meter

meter

Meter meter(Metadata metadata,
            Tag... tags)

Return the Meter registered under the MetricID with the Metadata's name and with the provided Tags; or create and register a new Meter if none is registered. If a Meter was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Meter

Since:

2.0

timer

default Timer timer(String name)

Return the Timer registered under the MetricID with this name and with no tags; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing Timer

timer

default Timer timer(String name,
                    Tag... tags)

Return the Timer registered under the MetricID with this name and with the provided Tags; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Timer

Since:

2.0

timer

Timer timer(MetricID metricID)

Return the Timer registered under the MetricID; or create and register a new Timer if none is registered. If a Timer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing Timer

Since:

3.0

timer

Timer timer(Metadata metadata)

Return the Timer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new Timer if none is registered. If a Timer was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing Timer

timer

Timer timer(Metadata metadata,
            Tag... tags)

Return the Timer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new Timer if none is registered. If a Timer was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing Timer

Since:

2.0

simpleTimer

default SimpleTimer simpleTimer(String name)

Return the SimpleTimer registered under the MetricID with this name and with no tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

Returns:

a new or pre-existing SimpleTimer

Since:

2.3

simpleTimer

default SimpleTimer simpleTimer(String name,
                                Tag... tags)

Return the SimpleTimer registered under the MetricID with this name and with the provided Tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

name - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing SimpleTimer

Since:

2.3

simpleTimer

SimpleTimer simpleTimer(MetricID metricID)

Return the SimpleTimer registered under the MetricID; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, a Metadata object will be registered with the name and type. If a Metadata object is already registered with this metric name then that Metadata will be used.

Parameters:

metricID - the ID of the metric

Returns:

a new or pre-existing SimpleTimer

Since:

3.0

simpleTimer

SimpleTimer simpleTimer(Metadata metadata)

Return the SimpleTimer registered under the the MetricID with the Metadata's name and with no tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

Returns:

a new or pre-existing SimpleTimer

Since:

2.3

simpleTimer

SimpleTimer simpleTimer(Metadata metadata,
                        Tag... tags)

Return the SimpleTimer registered under the the MetricID with the Metadata's name and with the provided Tags; or create and register a new SimpleTimer if none is registered. If a SimpleTimer was created, the provided Metadata object will be registered.

Note: During retrieval or creation, if a Metadata object is already registered under this metric name and is not equal to the provided Metadata object then an exception will be thrown.

Parameters:

metadata - the name of the metric

tags - the tags of the metric

Returns:

a new or pre-existing SimpleTimer

Since:

2.3

getMetric

Metric getMetric(MetricID metricID)

Return the Metric registered for a provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Metric registered for the provided MetricID or null if none has been registered so far

Since:

3.0

getMetric

default <T extends Metric> T getMetric(MetricID metricID,
                                       Class<T> asType)

Return the Metric registered for the provided MetricID as the provided type.

Parameters:

metricID - lookup key, not null

asType - the return type which is expected to be compatible with the actual type of the registered metric

Returns:

the Metric registered for the provided MetricID or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to the provided type

Since:

3.0

getCounter

default Counter getCounter(MetricID metricID)

Return the Counter registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Counter registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to Counter

Since:

3.0

getConcurrentGauge

default ConcurrentGauge getConcurrentGauge(MetricID metricID)

Return the ConcurrentGauge registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the ConcurrentGauge registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to ConcurrentGauge

Since:

3.0

getGauge

default Gauge<?> getGauge(MetricID metricID)

Return the Gauge registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Gauge registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to Gauge

Since:

3.0

getHistogram

default Histogram getHistogram(MetricID metricID)

Return the Histogram registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Histogram registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to Histogram

Since:

3.0

getMeter

default Meter getMeter(MetricID metricID)

Return the Meter registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Meter registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to Meter

Since:

3.0

getTimer

default Timer getTimer(MetricID metricID)

Return the Timer registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the Timer registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to Timer

Since:

3.0

getSimpleTimer

default SimpleTimer getSimpleTimer(MetricID metricID)

Return the SimpleTimer registered for the provided MetricID.

Parameters:

metricID - lookup key, not null

Returns:

the SimpleTimer registered for the key or null if none has been registered so far

Throws:

IllegalArgumentException - If the registered metric was not assignable to SimpleTimer

Since:

3.0

getMetadata

Metadata getMetadata(String name)

Return the Metadata for the provided name.

Parameters:

name - the name of the metric

Returns:

the Metadata for the provided name of null if none has been registered for that name

Since:

3.0

remove

boolean remove(String name)

Removes all metrics with the given name.

Parameters:

name - the name of the metric

Returns:

whether or not the metric was removed

remove

boolean remove(MetricID metricID)

Removes the metric with the given MetricID

Parameters:

metricID - the MetricID of the metric

Returns:

whether or not the metric was removed

Since:

2.0

removeMatching

void removeMatching(MetricFilter filter)

Removes all metrics which match the given filter.

Parameters:

filter - a filter

getNames

SortedSet<String> getNames()

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

Returns:

the names of all the metrics

getMetricIDs

SortedSet<MetricID> getMetricIDs()

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

Returns:

the MetricIDs of all the metrics

getGauges

SortedMap<MetricID,Gauge> getGauges()

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

Returns:

all the gauges in the registry

getGauges

default SortedMap<MetricID,Gauge> getGauges(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the gauges in the registry

getCounters

SortedMap<MetricID,Counter> getCounters()

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

Returns:

all the counters in the registry

getCounters

default SortedMap<MetricID,Counter> getCounters(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the counters in the registry

getConcurrentGauges

SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges()

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

Returns:

all the concurrent gauges in the registry

getConcurrentGauges

default SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the concurrent gauges in the registry

getHistograms

SortedMap<MetricID,Histogram> getHistograms()

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

Returns:

all the histograms in the registry

getHistograms

default SortedMap<MetricID,Histogram> getHistograms(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the histograms in the registry

getMeters

SortedMap<MetricID,Meter> getMeters()

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

Returns:

all the meters in the registry

getMeters

default SortedMap<MetricID,Meter> getMeters(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the meters in the registry

getTimers

SortedMap<MetricID,Timer> getTimers()

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

Returns:

all the timers in the registry

getTimers

default SortedMap<MetricID,Timer> getTimers(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the timers in the registry

getSimpleTimers

SortedMap<MetricID,SimpleTimer> getSimpleTimers()

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

Returns:

all the timers in the registry

getSimpleTimers

default SortedMap<MetricID,SimpleTimer> getSimpleTimers(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the timers in the registry

getMetrics

SortedMap<MetricID,Metric> getMetrics(MetricFilter filter)

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

Parameters:

filter - the metric filter to match

Returns:

all the metrics in the registry

Since:

3.0

getMetrics

default <T extends Metric> SortedMap<MetricID,T> getMetrics(Class<T> ofType,
                                                            MetricFilter filter)

Returns a map of all the metrics in the registry and their MetricIDs which match the given filter and which are assignable to the provided type.

Parameters:

ofType - the type to which all returned metrics should be assignable

filter - the metric filter to match

Returns:

all the metrics in the registry

Since:

3.0

getMetrics

@Deprecated
Map<MetricID,Metric> getMetrics()

Deprecated. Prior to 2.4 this method was the standard way to access Metrics by their MetricID; Doing so might cause unnecessary creation of an intermediate map that might be computed by the implementation. Prefer getMetric(MetricID) for key based lookup of single Metric; Use getMetricIDs() to iterate over all metrics. Use getMetrics(MetricFilter) with MetricFilter.ALL if a (most likely) computed Map is preferred.

Returns a map of all the metrics in the registry and their MetricIDs.

Returns:

all the metrics in the registry

getMetadata

@Deprecated
Map<String,Metadata> getMetadata()

Deprecated. Prior to 2.4 this method was the standard way to access Metadata by their name; Doing so might cause unnecessary creation of an intermediate map that might be computed by the implementation. Prefer getMetadata(String) for key based lookup of a single Metadata; Use getNames() to iterate over all names.

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

Returns:

all the metadata in the registry

getType

MetricRegistry.Type getType()

Returns the type of this metric registry.

Returns:

Type of this registry (VENDOR, BASE, APPLICATION)