Package io.helidon.metrics

Class Registry

java.lang.Object

org.eclipse.microprofile.metrics.MetricRegistry

io.helidon.metrics.Registry

All Implemented Interfaces:

io.helidon.common.metrics.InternalBridge.MetricRegistry

public class Registry
extends MetricRegistry
implements io.helidon.common.metrics.InternalBridge.MetricRegistry

Metrics registry.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.microprofile.metrics.MetricRegistry

MetricRegistry.Type

Nested classes/interfaces inherited from interface io.helidon.common.metrics.InternalBridge.MetricRegistry

io.helidon.common.metrics.InternalBridge.MetricRegistry.RegistryFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Registry(MetricRegistry.Type type)	Create a registry of a certain type.

Method Summary

Modifier and Type	Method	Description
ConcurrentGauge	concurrentGauge(String name)
ConcurrentGauge	concurrentGauge(String name, Tag... tags)
ConcurrentGauge	concurrentGauge(Metadata metadata)
ConcurrentGauge	concurrentGauge(Metadata metadata, Tag... tags)
Counter	counter(io.helidon.common.metrics.InternalBridge.Metadata metadata)	Finds or creates a new Counter using the specified version-neutral Metadata.
Counter	counter(io.helidon.common.metrics.InternalBridge.Metadata metadata, Map<String,String> tags)	Finds or creates a new Counter using the specified version-neutral Metadata and version-neutral Tags.
Counter	counter(String name)	Finds or creates a new Counter using the specified name.
Counter	counter(String name, Tag... tags)
Counter	counter(Metadata metadata)
Counter	counter(Metadata metadata, Tag... tags)
static Registry	create(MetricRegistry.Type type)	Create a registry of a certain type.
boolean	empty()	Determines if registry is empty.
SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Counter>	getBridgeCounters()	Returns all Counter metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.
SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Gauge>	getBridgeGauges()	Returns all Gauge metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.
SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Histogram>	getBridgeHistograms()	Returns all Histogram metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.
SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Meter>	getBridgeMeters()	Returns all Meter metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.
Optional<Map.Entry<? extends io.helidon.common.metrics.InternalBridge.MetricID,? extends Metric>>	getBridgeMetric(String metricName)	Returns an Optional of the MetricID and Metric of the metric matching the given name.
Map<io.helidon.common.metrics.InternalBridge.MetricID,Metric>	getBridgeMetrics()	Returns all metrics from the registry as a map of version-neutral InternalBridge.MetricIDs to Metrics.
Map<io.helidon.common.metrics.InternalBridge.MetricID,Metric>	getBridgeMetrics(Predicate<? super Map.Entry<? extends io.helidon.common.metrics.InternalBridge.MetricID,? extends Metric>> predicate)	Returns all metrics from the registry as a map of version-neutral InternalBridge.MetricIDs to Metrics, filtered by the provided Predicate.
SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Timer>	getBridgeTimers()	Returns all Timer metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.
SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges()
SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges(MetricFilter filter)
SortedMap<MetricID,Counter>	getCounters()
SortedMap<MetricID,Counter>	getCounters(MetricFilter filter)
SortedMap<MetricID,Gauge>	getGauges()
SortedMap<MetricID,Gauge>	getGauges(MetricFilter filter)
SortedMap<MetricID,Histogram>	getHistograms()
SortedMap<MetricID,Histogram>	getHistograms(MetricFilter filter)
Map<String,Metadata>	getMetadata()
SortedMap<MetricID,Meter>	getMeters()
SortedMap<MetricID,Meter>	getMeters(MetricFilter filter)
Optional<Metric>	getMetric(String metricName)	Access a metric by name.
SortedSet<MetricID>	getMetricIDs()
Map<MetricID,Metric>	getMetrics()
SortedSet<String>	getNames()	Returns the names of all metrics in the registry.
Optional<Map.Entry<? extends Metric,List<MetricID>>>	getOptionalMetricWithIDsEntry(String metricName)	Get internal map entry given a metric name.
SortedMap<MetricID,Timer>	getTimers()
SortedMap<MetricID,Timer>	getTimers(MetricFilter filter)
Histogram	histogram(io.helidon.common.metrics.InternalBridge.Metadata metadata)	Finds or creates a new Histogram using the specified version-neutral Metadata.
Histogram	histogram(io.helidon.common.metrics.InternalBridge.Metadata metadata, Map<String,String> tags)	Finds or creates a new Histogram using the specified version-neutral Metadata and version-neutral Tags.
Histogram	histogram(String name)	Finds or creates a new Histogram using the specified Metadata.
Histogram	histogram(String name, Tag... tags)
Histogram	histogram(Metadata metadata)
Histogram	histogram(Metadata metadata, Tag... tags)
Meter	meter(io.helidon.common.metrics.InternalBridge.Metadata metadata)	Finds or creates a new Meter using the specified version-neutral Metadata.
Meter	meter(io.helidon.common.metrics.InternalBridge.Metadata metadata, Map<String,String> tags)	Finds or creates a new Meter using the specified version-neutral Metadata and version-neutral Tags.
Meter	meter(String name)	Finds or creates a new Meter using the specified name.
Meter	meter(String name, Tag... tags)
Meter	meter(Metadata metadata)
Meter	meter(Metadata metadata, Tag... tags)
<T extends Metric> T	register(io.helidon.common.metrics.InternalBridge.Metadata metadata, T metric)	Registers a new metric using the specified version-neutral InternalBridge.Metadata and the typed metric itself.
<T extends Metric> T	register(io.helidon.common.metrics.InternalBridge.MetricID metricID, T metric)	Registers a new metric using the specified version-neutral InternalBridge.MetricID and the typed metric itself.
<T extends Metric> T	register(String name, T metric)
<T extends Metric> T	register(Metadata metadata, T metric)
<T extends Metric> T	register(Metadata metadata, T metric, Tag... tags)
boolean	remove(String name)	Removes a metric by name.
boolean	remove(MetricID metricID)	Removes a metric by ID.
void	removeMatching(MetricFilter filter)
Timer	timer(io.helidon.common.metrics.InternalBridge.Metadata metadata)	Finds or creates a new Timer using the specified version-neutral Metadata.
Timer	timer(io.helidon.common.metrics.InternalBridge.Metadata metadata, Map<String,String> tags)	Finds or creates a new Timer using the specified version-neutral Metadata and version-neutral Tags.
Timer	timer(String name)	Finds or creates a new Timer using the specified name.
Timer	timer(String name, Tag... tags)
Timer	timer(Metadata metadata)
Timer	timer(Metadata metadata, Tag... tags)
String	toString()
String	type()	Returns type of this registry.

Methods inherited from class org.eclipse.microprofile.metrics.MetricRegistry

name, name

Methods inherited from class java.lang.Object

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

Constructor Detail

Registry

protected Registry(MetricRegistry.Type type)

Create a registry of a certain type.

Parameters:

type - Registry type.

Method Detail

create

public static Registry create(MetricRegistry.Type type)

Create a registry of a certain type.

Parameters:

type - Registry type.

Returns:

The newly created registry.

register

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

Specified by:

register in class MetricRegistry

Throws:

IllegalArgumentException

register

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

Specified by:

register in class MetricRegistry

Throws:

IllegalArgumentException

register

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

Specified by:

register in class MetricRegistry

Throws:

IllegalArgumentException

counter

public Counter counter(String name)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Counter using the specified name.

Specified by:

counter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

counter in class MetricRegistry

Parameters:

name - name for the new Counter

Returns:

the Counter

counter

public Counter counter(Metadata metadata)

Specified by:

counter in class MetricRegistry

counter

public Counter counter(io.helidon.common.metrics.InternalBridge.Metadata metadata)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Counter using the specified version-neutral Metadata.

Specified by:

counter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the counter

Returns:

the Counter

counter

public Counter counter(io.helidon.common.metrics.InternalBridge.Metadata metadata,
                       Map<String,String> tags)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Counter using the specified version-neutral Metadata and version-neutral Tags.

Specified by:

counter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the counter

tags - used in locating and, if needed, building the counter

Returns:

the Counter

counter

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

Specified by:

counter in class MetricRegistry

counter

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

Specified by:

counter in class MetricRegistry

histogram

public Histogram histogram(String name)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Histogram using the specified Metadata.

Specified by:

histogram in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

histogram in class MetricRegistry

Parameters:

name - used in locating and, if needed, building the histogram

Returns:

the Histogram

histogram

public Histogram histogram(Metadata metadata)

Specified by:

histogram in class MetricRegistry

histogram

public Histogram histogram(io.helidon.common.metrics.InternalBridge.Metadata metadata)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Histogram using the specified version-neutral Metadata.

Specified by:

histogram in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the histogram

Returns:

the Histogram

histogram

public Histogram histogram(io.helidon.common.metrics.InternalBridge.Metadata metadata,
                           Map<String,String> tags)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Histogram using the specified version-neutral Metadata and version-neutral Tags.

Specified by:

histogram in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the histogram

tags - used in locating and, if needed, building the histogram

Returns:

the Histogram

histogram

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

Specified by:

histogram in class MetricRegistry

histogram

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

Specified by:

histogram in class MetricRegistry

meter

public Meter meter(String name)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Meter using the specified name.

Specified by:

meter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

meter in class MetricRegistry

Parameters:

name - used in locating and, if needed, building the meter

Returns:

the Meter

meter

public Meter meter(Metadata metadata)

Specified by:

meter in class MetricRegistry

meter

public Meter meter(io.helidon.common.metrics.InternalBridge.Metadata metadata)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Meter using the specified version-neutral Metadata.

Specified by:

meter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the meter

Returns:

the Meter

meter

public Meter meter(io.helidon.common.metrics.InternalBridge.Metadata metadata,
                   Map<String,String> tags)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Meter using the specified version-neutral Metadata and version-neutral Tags.

Specified by:

meter in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the meter

tags - used in locating and, if needed, building the meter

Returns:

the Meter

meter

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

Specified by:

meter in class MetricRegistry

meter

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

Specified by:

meter in class MetricRegistry

timer

public Timer timer(String name)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Timer using the specified name.

Specified by:

timer in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

timer in class MetricRegistry

Parameters:

name - used in locating and, if needed, building the timer

Returns:

the Timer

timer

public Timer timer(Metadata metadata)

Specified by:

timer in class MetricRegistry

timer

public Timer timer(io.helidon.common.metrics.InternalBridge.Metadata metadata)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Timer using the specified version-neutral Metadata.

Specified by:

timer in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the timer

Returns:

the Timer

timer

public Timer timer(io.helidon.common.metrics.InternalBridge.Metadata metadata,
                   Map<String,String> tags)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Finds or creates a new Timer using the specified version-neutral Metadata and version-neutral Tags.

Specified by:

timer in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metadata - used in locating and, if needed, building the timer

tags - used in locationg and, if needed, building the timer

Returns:

the Timer

timer

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

Specified by:

timer in class MetricRegistry

timer

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

Specified by:

timer in class MetricRegistry

concurrentGauge

public ConcurrentGauge concurrentGauge(String name)

Specified by:

concurrentGauge in class MetricRegistry

concurrentGauge

public ConcurrentGauge concurrentGauge(Metadata metadata)

Specified by:

concurrentGauge in class MetricRegistry

concurrentGauge

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

Specified by:

concurrentGauge in class MetricRegistry

concurrentGauge

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

Specified by:

concurrentGauge in class MetricRegistry

remove

public boolean remove(String name)

Removes a metric by name. Synchronized for atomic update of more than one internal map.

Specified by:

remove in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

remove in class MetricRegistry

Parameters:

name - Name of the metric.

Returns:

Outcome of removal.

remove

public boolean remove(MetricID metricID)

Removes a metric by ID. Synchronized for atomic update of more than one internal map.

Specified by:

remove in class MetricRegistry

Parameters:

metricID - ID of metric.

Returns:

Outcome of removal.

removeMatching

public void removeMatching(MetricFilter filter)

Specified by:

removeMatching in class MetricRegistry

getNames

public SortedSet<String> getNames()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns the names of all metrics in the registry.

Specified by:

getNames in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Specified by:

getNames in class MetricRegistry

Returns:

a Set containing the names

getMetricIDs

public SortedSet<MetricID> getMetricIDs()

Specified by:

getMetricIDs in class MetricRegistry

getGauges

public SortedMap<MetricID,Gauge> getGauges()

Specified by:

getGauges in class MetricRegistry

getGauges

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

Specified by:

getGauges in class MetricRegistry

getCounters

public SortedMap<MetricID,Counter> getCounters()

Specified by:

getCounters in class MetricRegistry

getCounters

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

Specified by:

getCounters in class MetricRegistry

getHistograms

public SortedMap<MetricID,Histogram> getHistograms()

Specified by:

getHistograms in class MetricRegistry

getHistograms

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

Specified by:

getHistograms in class MetricRegistry

getMeters

public SortedMap<MetricID,Meter> getMeters()

Specified by:

getMeters in class MetricRegistry

getMeters

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

Specified by:

getMeters in class MetricRegistry

getTimers

public SortedMap<MetricID,Timer> getTimers()

Specified by:

getTimers in class MetricRegistry

getTimers

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

Specified by:

getTimers in class MetricRegistry

getConcurrentGauges

public SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges()

Specified by:

getConcurrentGauges in class MetricRegistry

getConcurrentGauges

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

Specified by:

getConcurrentGauges in class MetricRegistry

getMetadata

public Map<String,Metadata> getMetadata()

Specified by:

getMetadata in class MetricRegistry

getMetrics

public Map<MetricID,Metric> getMetrics()

Specified by:

getMetrics in class MetricRegistry

getBridgeMetrics

public Map<io.helidon.common.metrics.InternalBridge.MetricID,Metric> getBridgeMetrics(Predicate<? super Map.Entry<? extends io.helidon.common.metrics.InternalBridge.MetricID,? extends Metric>> predicate)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all metrics from the registry as a map of version-neutral InternalBridge.MetricIDs to Metrics, filtered by the provided Predicate.

Specified by:

getBridgeMetrics in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

predicate - for selecting which metrics to include in the result

Returns:

the metrics matching the criteria expressed in the predicate

getBridgeMetrics

public Map<io.helidon.common.metrics.InternalBridge.MetricID,Metric> getBridgeMetrics()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all metrics from the registry as a map of version-neutral InternalBridge.MetricIDs to Metrics.

Specified by:

getBridgeMetrics in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

the metrics

getBridgeGauges

public SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Gauge> getBridgeGauges()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all Gauge metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.

Specified by:

getBridgeGauges in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

a map of all gauges

getBridgeCounters

public SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Counter> getBridgeCounters()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all Counter metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.

Specified by:

getBridgeCounters in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

a map of all counters

getBridgeHistograms

public SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Histogram> getBridgeHistograms()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all Histogram metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.

Specified by:

getBridgeHistograms in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

a map of all histograms

getBridgeMeters

public SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Meter> getBridgeMeters()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all Meter metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.

Specified by:

getBridgeMeters in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

a map of all meters

getBridgeTimers

public SortedMap<io.helidon.common.metrics.InternalBridge.MetricID,Timer> getBridgeTimers()

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns all Timer metrics in the registry as a map of version-neutral InternalBridge.MetricID to Metric entries.

Specified by:

getBridgeTimers in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns:

a map of all timers

register

public <T extends Metric> T register(io.helidon.common.metrics.InternalBridge.Metadata metadata,
                                     T metric)
                              throws IllegalArgumentException

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Registers a new metric using the specified version-neutral InternalBridge.Metadata and the typed metric itself.

Specified by:

register in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Type Parameters:

T - the metric type

Parameters:

metadata - the metadata used in registering the metric

metric - the metric to register

Returns:

the registered metric

Throws:

IllegalArgumentException - if a metric with the same name but inconsistent metadata is already registered

register

public <T extends Metric> T register(io.helidon.common.metrics.InternalBridge.MetricID metricID,
                                     T metric)
                              throws IllegalArgumentException

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Registers a new metric using the specified version-neutral InternalBridge.MetricID and the typed metric itself.

Specified by:

register in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Type Parameters:

T - the metric type

Parameters:

metricID - the metric ID to be used in registering the metric

metric - the metric to register

Returns:

the registered metric

Throws:

IllegalArgumentException - if a metric with the same identify but inconsistent metadata is already registered

getMetric

public Optional<Metric> getMetric(String metricName)

Access a metric by name. Used by FT library.

Parameters:

metricName - Metric name.

Returns:

Optional metric.

getBridgeMetric

public Optional<Map.Entry<? extends io.helidon.common.metrics.InternalBridge.MetricID,? extends Metric>> getBridgeMetric(String metricName)

Description copied from interface: io.helidon.common.metrics.InternalBridge.MetricRegistry

Returns an Optional of the MetricID and Metric of the metric matching the given name. If multiple metrics match on the name (this can happen in MP Metrics 2.0 if the metrics were created with different tags) then the method returns the first metric with that name, if any.

Specified by:

getBridgeMetric in interface io.helidon.common.metrics.InternalBridge.MetricRegistry

Parameters:

metricName - name of the metric to find

Returns:

Optional of a Map.Entry for the matching ID and metric

type

public String type()

Returns type of this registry.

Returns:

The type.

empty

public boolean empty()

Determines if registry is empty.

Returns:

Outcome of test.

toString

public String toString()

Overrides:

toString in class Object

getOptionalMetricWithIDsEntry

public Optional<Map.Entry<? extends Metric,List<MetricID>>> getOptionalMetricWithIDsEntry(String metricName)

Get internal map entry given a metric name. Synchronized for atomic access of more than one internal map.

Parameters:

metricName - The metric name.

Returns:

Optional map entry..