Package org.eclipse.microprofile.metrics
Class MetricRegistry
java.lang.Object
org.eclipse.microprofile.metrics.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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enumeration representing the scopes of the MetricRegistry -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract Counter
abstract Counter
Returns a map of all the counters in the registry and their names.getCounters
(MetricFilter filter) Returns a map of all the counters in the registry and their names which match the given filter.Returns a map of all the gauges in the registry and their names.getGauges
(MetricFilter filter) Returns a map of all the gauges in the registry and their names which match the given filter.Returns a map of all the histograms in the registry and their names.getHistograms
(MetricFilter filter) Returns a map of all the histograms in the registry and their names which match the given filter.Returns a map of all the metadata in the registry and their names.Returns a map of all the meters in the registry and their names.getMeters
(MetricFilter filter) Returns a map of all the meters in the registry and their names which match the given filter.Returns a map of all the metrics in the registry and their names.getNames()
Returns a set of the names of all the metrics in the registry.Returns a map of all the timers in the registry and their names.getTimers
(MetricFilter filter) Returns a map of all the timers in the registry and their names which match the given filter.abstract Histogram
abstract Histogram
abstract Meter
abstract Meter
static String
Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.static String
Concatenates elements to form a dotted name, eliding any null values or empty strings.abstract <T extends Metric>
TGiven aMetric
, registers it under the given name.abstract <T extends Metric>
Tabstract boolean
Removes the metric with the given name.abstract void
removeMatching
(MetricFilter filter) Removes all metrics which match the given filter.abstract Timer
abstract Timer
-
Constructor Details
-
MetricRegistry
public MetricRegistry()
-
-
Method Details
-
name
Concatenates elements to form a dotted name, eliding any null values or empty strings.- Parameters:
name
- the first element of the namenames
- the remaining elements of the name- Returns:
name
andnames
concatenated by periods
-
name
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 namenames
- the remaining elements of the name- Returns:
klass
andnames
concatenated by periods
-
register
public abstract <T extends Metric> T register(String name, T metric) throws IllegalArgumentException Given aMetric
, registers it under the given name. AMetadata
object will be registered with the name and type.- Type Parameters:
T
- the type of the metric- Parameters:
name
- the name of the metricmetric
- the metric- Returns:
metric
- Throws:
IllegalArgumentException
- if the name is already registered
-
register
public abstract <T extends Metric> T register(String name, T metric, Metadata metadata) throws IllegalArgumentException - Type Parameters:
T
- the type of the metric- Parameters:
name
- the name of the metricmetric
- the metricmetadata
- the metadata- Returns:
metric
- Throws:
IllegalArgumentException
- if the name is already registered
-
counter
Return theCounter
registered under this name; or create and register a newCounter
if none is registered. If aCounter
was created, aMetadata
object will be registered with the name and type.- Parameters:
name
- the name of the metric- Returns:
- a new or pre-existing
Counter
-
counter
Return theCounter
registered under theMetadata
's name; or create and register a newCounter
if none is registered. If aCounter
was created, the providedMetadata
object will be registered.Note: The
Metadata
will not be updated if the metric is already registered.- Parameters:
metadata
- the name of the metric- Returns:
- a new or pre-existing
Counter
-
histogram
Return theHistogram
registered under this name; or create and register a newHistogram
if none is registered. If aHistogram
was created, aMetadata
object will be registered with the name and type.- Parameters:
name
- the name of the metric- Returns:
- a new or pre-existing
Histogram
-
histogram
Return theHistogram
registered under theMetadata
's name; or create and register a newHistogram
if none is registered. If aHistogram
was created, the providedMetadata
object will be registered.Note: The
Metadata
will not be updated if the metric is already registered.- Parameters:
metadata
- the name of the metric- Returns:
- a new or pre-existing
Histogram
-
meter
Return theMeter
registered under this name; or create and register a newMeter
if none is registered. If aMeter
was created, aMetadata
object will be registered with the name and type.- Parameters:
name
- the name of the metric- Returns:
- a new or pre-existing
Meter
-
meter
Return theMeter
registered under theMetadata
's name; or create and register a newMeter
if none is registered. If aMeter
was created, the providedMetadata
object will be registered.Note: The
Metadata
will not be updated if the metric is already registered.- Parameters:
metadata
- the name of the metric- Returns:
- a new or pre-existing
Meter
-
timer
Return theTimer
registered under this name; or create and register a newTimer
if none is registered. If aTimer
was created, aMetadata
object will be registered with the name and type.- Parameters:
name
- the name of the metric- Returns:
- a new or pre-existing
Timer
-
timer
Return theTimer
registered under theMetadata
's name; or create and register a newTimer
if none is registered. If aTimer
was created, the providedMetadata
object will be registered.Note: The
Metadata
will not be updated if the metric is already registered.- Parameters:
metadata
- the name of the metric- Returns:
- a new or pre-existing
Timer
-
remove
Removes the metric with the given name.- Parameters:
name
- the name of the metric- Returns:
- whether or not the metric was removed
-
removeMatching
Removes all metrics which match the given filter.- Parameters:
filter
- a filter
-
getNames
Returns a set of the names of all the metrics in the registry.- Returns:
- the names of all the metrics
-
getGauges
Returns a map of all the gauges in the registry and their names.- Returns:
- all the gauges in the registry
-
getGauges
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
Returns a map of all the counters in the registry and their names.- Returns:
- all the counters in the registry
-
getCounters
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
Returns a map of all the histograms in the registry and their names.- Returns:
- all the histograms in the registry
-
getHistograms
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
Returns a map of all the meters in the registry and their names.- Returns:
- all the meters in the registry
-
getMeters
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
Returns a map of all the timers in the registry and their names.- Returns:
- all the timers in the registry
-
getTimers
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
Returns a map of all the metrics in the registry and their names.- Returns:
- all the metrics in the registry
-
getMetadata
Returns a map of all the metadata in the registry and their names.- Returns:
- all the metadata in the registry
-