Module io.helidon.metrics

Package io.helidon.metrics

Class Registry

java.lang.Object

org.eclipse.microprofile.metrics.MetricRegistry

io.helidon.metrics.Registry

public class Registry
extends org.eclipse.microprofile.metrics.MetricRegistry

Metrics registry.

Nested Class Summary

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

org.eclipse.microprofile.metrics.MetricRegistry.Type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.metrics.ConcurrentGauge	concurrentGauge(String name)
org.eclipse.microprofile.metrics.ConcurrentGauge	concurrentGauge(String name, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.ConcurrentGauge	concurrentGauge(org.eclipse.microprofile.metrics.Metadata metadata)
org.eclipse.microprofile.metrics.ConcurrentGauge	concurrentGauge(org.eclipse.microprofile.metrics.Metadata metadata, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Counter	counter(String name)
org.eclipse.microprofile.metrics.Counter	counter(String name, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Counter	counter(org.eclipse.microprofile.metrics.Metadata metadata)
org.eclipse.microprofile.metrics.Counter	counter(org.eclipse.microprofile.metrics.Metadata metadata, org.eclipse.microprofile.metrics.Tag... tags)
static Registry	create(org.eclipse.microprofile.metrics.MetricRegistry.Type type)	Create a registry of a certain type.
boolean	empty()	Determines if registry is empty.
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.ConcurrentGauge>	getConcurrentGauges()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.ConcurrentGauge>	getConcurrentGauges(org.eclipse.microprofile.metrics.MetricFilter filter)
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Counter>	getCounters()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Counter>	getCounters(org.eclipse.microprofile.metrics.MetricFilter filter)
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Gauge>	getGauges()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Gauge>	getGauges(org.eclipse.microprofile.metrics.MetricFilter filter)
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Histogram>	getHistograms()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Histogram>	getHistograms(org.eclipse.microprofile.metrics.MetricFilter filter)
Map<String,org.eclipse.microprofile.metrics.Metadata>	getMetadata()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Meter>	getMeters()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Meter>	getMeters(org.eclipse.microprofile.metrics.MetricFilter filter)
Optional<org.eclipse.microprofile.metrics.Metric>	getMetric(String metricName)	Access a metric by name.
SortedSet<org.eclipse.microprofile.metrics.MetricID>	getMetricIDs()
Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric>	getMetrics()
SortedSet<String>	getNames()
Optional<Map.Entry<? extends org.eclipse.microprofile.metrics.Metric,List<org.eclipse.microprofile.metrics.MetricID>>>	getOptionalMetricWithIDsEntry(String metricName)	Get internal map entry given a metric name.
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Timer>	getTimers()
SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Timer>	getTimers(org.eclipse.microprofile.metrics.MetricFilter filter)
org.eclipse.microprofile.metrics.Histogram	histogram(String name)
org.eclipse.microprofile.metrics.Histogram	histogram(String name, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Histogram	histogram(org.eclipse.microprofile.metrics.Metadata metadata)
org.eclipse.microprofile.metrics.Histogram	histogram(org.eclipse.microprofile.metrics.Metadata metadata, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Meter	meter(String name)
org.eclipse.microprofile.metrics.Meter	meter(String name, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Meter	meter(org.eclipse.microprofile.metrics.Metadata metadata)
org.eclipse.microprofile.metrics.Meter	meter(org.eclipse.microprofile.metrics.Metadata metadata, org.eclipse.microprofile.metrics.Tag... tags)
<T extends org.eclipse.microprofile.metrics.Metric> T	register(String name, T metric)
<T extends org.eclipse.microprofile.metrics.Metric> T	register(org.eclipse.microprofile.metrics.Metadata metadata, T metric)
<T extends org.eclipse.microprofile.metrics.Metric> T	register(org.eclipse.microprofile.metrics.Metadata metadata, T metric, org.eclipse.microprofile.metrics.Tag... tags)
boolean	remove(String name)	Removes a metric by name.
boolean	remove(org.eclipse.microprofile.metrics.MetricID metricID)	Removes a metric by ID.
void	removeMatching(org.eclipse.microprofile.metrics.MetricFilter filter)
org.eclipse.microprofile.metrics.Timer	timer(String name)
org.eclipse.microprofile.metrics.Timer	timer(String name, org.eclipse.microprofile.metrics.Tag... tags)
org.eclipse.microprofile.metrics.Timer	timer(org.eclipse.microprofile.metrics.Metadata metadata)
org.eclipse.microprofile.metrics.Timer	timer(org.eclipse.microprofile.metrics.Metadata metadata, org.eclipse.microprofile.metrics.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(org.eclipse.microprofile.metrics.MetricRegistry.Type type)

Create a registry of a certain type.

Parameters:

type - Registry type.

Method Detail

create

public static Registry create(org.eclipse.microprofile.metrics.MetricRegistry.Type type)

Create a registry of a certain type.

Parameters:

type - Registry type.

Returns:

The newly created registry.

register

public <T extends org.eclipse.microprofile.metrics.Metric> T register(String name,
                                                                      T metric)
                                                               throws IllegalArgumentException

Specified by:

register in class org.eclipse.microprofile.metrics.MetricRegistry

Throws:

IllegalArgumentException

register

public <T extends org.eclipse.microprofile.metrics.Metric> T register(org.eclipse.microprofile.metrics.Metadata metadata,
                                                                      T metric)
                                                               throws IllegalArgumentException

Specified by:

register in class org.eclipse.microprofile.metrics.MetricRegistry

Throws:

IllegalArgumentException

register

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

Specified by:

register in class org.eclipse.microprofile.metrics.MetricRegistry

Throws:

IllegalArgumentException

counter

public org.eclipse.microprofile.metrics.Counter counter(String name)

Specified by:

counter in class org.eclipse.microprofile.metrics.MetricRegistry

counter

public org.eclipse.microprofile.metrics.Counter counter(org.eclipse.microprofile.metrics.Metadata metadata)

Specified by:

counter in class org.eclipse.microprofile.metrics.MetricRegistry

counter

public org.eclipse.microprofile.metrics.Counter counter(String name,
                                                        org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

counter in class org.eclipse.microprofile.metrics.MetricRegistry

counter

public org.eclipse.microprofile.metrics.Counter counter(org.eclipse.microprofile.metrics.Metadata metadata,
                                                        org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

counter in class org.eclipse.microprofile.metrics.MetricRegistry

histogram

public org.eclipse.microprofile.metrics.Histogram histogram(String name)

Specified by:

histogram in class org.eclipse.microprofile.metrics.MetricRegistry

histogram

public org.eclipse.microprofile.metrics.Histogram histogram(org.eclipse.microprofile.metrics.Metadata metadata)

Specified by:

histogram in class org.eclipse.microprofile.metrics.MetricRegistry

histogram

public org.eclipse.microprofile.metrics.Histogram histogram(String name,
                                                            org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

histogram in class org.eclipse.microprofile.metrics.MetricRegistry

histogram

public org.eclipse.microprofile.metrics.Histogram histogram(org.eclipse.microprofile.metrics.Metadata metadata,
                                                            org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

histogram in class org.eclipse.microprofile.metrics.MetricRegistry

meter

public org.eclipse.microprofile.metrics.Meter meter(String name)

Specified by:

meter in class org.eclipse.microprofile.metrics.MetricRegistry

meter

public org.eclipse.microprofile.metrics.Meter meter(org.eclipse.microprofile.metrics.Metadata metadata)

Specified by:

meter in class org.eclipse.microprofile.metrics.MetricRegistry

meter

public org.eclipse.microprofile.metrics.Meter meter(String name,
                                                    org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

meter in class org.eclipse.microprofile.metrics.MetricRegistry

meter

public org.eclipse.microprofile.metrics.Meter meter(org.eclipse.microprofile.metrics.Metadata metadata,
                                                    org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

meter in class org.eclipse.microprofile.metrics.MetricRegistry

timer

public org.eclipse.microprofile.metrics.Timer timer(String name)

Specified by:

timer in class org.eclipse.microprofile.metrics.MetricRegistry

timer

public org.eclipse.microprofile.metrics.Timer timer(org.eclipse.microprofile.metrics.Metadata metadata)

Specified by:

timer in class org.eclipse.microprofile.metrics.MetricRegistry

timer

public org.eclipse.microprofile.metrics.Timer timer(String name,
                                                    org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

timer in class org.eclipse.microprofile.metrics.MetricRegistry

timer

public org.eclipse.microprofile.metrics.Timer timer(org.eclipse.microprofile.metrics.Metadata metadata,
                                                    org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

timer in class org.eclipse.microprofile.metrics.MetricRegistry

concurrentGauge

public org.eclipse.microprofile.metrics.ConcurrentGauge concurrentGauge(String name)

Specified by:

concurrentGauge in class org.eclipse.microprofile.metrics.MetricRegistry

concurrentGauge

public org.eclipse.microprofile.metrics.ConcurrentGauge concurrentGauge(org.eclipse.microprofile.metrics.Metadata metadata)

Specified by:

concurrentGauge in class org.eclipse.microprofile.metrics.MetricRegistry

concurrentGauge

public org.eclipse.microprofile.metrics.ConcurrentGauge concurrentGauge(String name,
                                                                        org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

concurrentGauge in class org.eclipse.microprofile.metrics.MetricRegistry

concurrentGauge

public org.eclipse.microprofile.metrics.ConcurrentGauge concurrentGauge(org.eclipse.microprofile.metrics.Metadata metadata,
                                                                        org.eclipse.microprofile.metrics.Tag... tags)

Specified by:

concurrentGauge in class org.eclipse.microprofile.metrics.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 class org.eclipse.microprofile.metrics.MetricRegistry

Parameters:

name - Name of the metric.

Returns:

Outcome of removal.

remove

public boolean remove(org.eclipse.microprofile.metrics.MetricID metricID)

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

Specified by:

remove in class org.eclipse.microprofile.metrics.MetricRegistry

Parameters:

metricID - ID of metric.

Returns:

Outcome of removal.

removeMatching

public void removeMatching(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

removeMatching in class org.eclipse.microprofile.metrics.MetricRegistry

getNames

public SortedSet<String> getNames()

Specified by:

getNames in class org.eclipse.microprofile.metrics.MetricRegistry

getMetricIDs

public SortedSet<org.eclipse.microprofile.metrics.MetricID> getMetricIDs()

Specified by:

getMetricIDs in class org.eclipse.microprofile.metrics.MetricRegistry

getGauges

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Gauge> getGauges()

Specified by:

getGauges in class org.eclipse.microprofile.metrics.MetricRegistry

getGauges

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Gauge> getGauges(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getGauges in class org.eclipse.microprofile.metrics.MetricRegistry

getCounters

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Counter> getCounters()

Specified by:

getCounters in class org.eclipse.microprofile.metrics.MetricRegistry

getCounters

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Counter> getCounters(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getCounters in class org.eclipse.microprofile.metrics.MetricRegistry

getHistograms

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Histogram> getHistograms()

Specified by:

getHistograms in class org.eclipse.microprofile.metrics.MetricRegistry

getHistograms

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Histogram> getHistograms(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getHistograms in class org.eclipse.microprofile.metrics.MetricRegistry

getMeters

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Meter> getMeters()

Specified by:

getMeters in class org.eclipse.microprofile.metrics.MetricRegistry

getMeters

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Meter> getMeters(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getMeters in class org.eclipse.microprofile.metrics.MetricRegistry

getTimers

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Timer> getTimers()

Specified by:

getTimers in class org.eclipse.microprofile.metrics.MetricRegistry

getTimers

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Timer> getTimers(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getTimers in class org.eclipse.microprofile.metrics.MetricRegistry

getConcurrentGauges

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.ConcurrentGauge> getConcurrentGauges()

Specified by:

getConcurrentGauges in class org.eclipse.microprofile.metrics.MetricRegistry

getConcurrentGauges

public SortedMap<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.ConcurrentGauge> getConcurrentGauges(org.eclipse.microprofile.metrics.MetricFilter filter)

Specified by:

getConcurrentGauges in class org.eclipse.microprofile.metrics.MetricRegistry

getMetadata

public Map<String,org.eclipse.microprofile.metrics.Metadata> getMetadata()

Specified by:

getMetadata in class org.eclipse.microprofile.metrics.MetricRegistry

getMetrics

public Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric> getMetrics()

Specified by:

getMetrics in class org.eclipse.microprofile.metrics.MetricRegistry

getMetric

public Optional<org.eclipse.microprofile.metrics.Metric> getMetric(String metricName)

Access a metric by name. Used by FT library.

Parameters:

metricName - Metric name.

Returns:

Optional 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 org.eclipse.microprofile.metrics.Metric,List<org.eclipse.microprofile.metrics.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..