Module io.helidon.metrics.api

Package io.helidon.metrics.api

Class AbstractRegistry<M extends HelidonMetric>

java.lang.Object

io.helidon.metrics.api.AbstractRegistry<M>

Type Parameters:

M - general type of metric implementation supported by an implementation of this class (e.g., HelidonMetric

All Implemented Interfaces:

MetricRegistry

Direct Known Subclasses:

Registry

public abstract class AbstractRegistry<M extends HelidonMetric>
extends Object
implements MetricRegistry

Common behavior for any category (e.g., full-featured or no-op) metrics registry.

This class provides the bookkeeping for tracking the metrics which are created and registered along with their IDs and metadata. Concrete subclasses create new instances of the various types of metrics (counter, timer, etc.).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractRegistry.GaugeFactory	Gauge factories based on either functions or suppliers.

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

MetricRegistry.Type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRegistry(MetricRegistry.Type type, Class<M> metricClass, RegistrySettings registrySettings)	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)
ConcurrentGauge	concurrentGauge(MetricID metricID)
Counter	counter(String name)
Counter	counter(String name, Tag... tags)
Counter	counter(Metadata metadata)
Counter	counter(Metadata metadata, Tag... tags)
Counter	counter(MetricID metricID)
protected abstract <R extends Number> Gauge<R>	createGauge(Metadata metadata, Supplier<R> supplier)	Creates a gauge instance according to the specified supplier which returns the gauge value.
protected <T, R extends Number> Gauge<R>	createGauge(Metadata metadata, T object, Function<T,R> func)	Creates a gauge instance according to the provided metadata such that retrievals of the gauge value trigger an invocation of the provided function, passing the indicated object.
protected static MetricType	deriveType(MetricType candidateType, Metric metric)	Infers the MetricType from a provided candidate type and a metric instance.
boolean	empty()	Determines if registry is empty.
<T extends Number> Gauge<T>	gauge(String name, Supplier<T> supplier, Tag... tags)
<T, R extends Number> Gauge<R>	gauge(String name, T object, Function<T,R> func, Tag... tags)
<T extends Number> Gauge<T>	gauge(Metadata metadata, Supplier<T> supplier, Tag... tags)
<T, R extends Number> Gauge<R>	gauge(Metadata metadata, T object, Function<T,R> func, Tag... tags)
<T extends Number> Gauge<T>	gauge(MetricID metricID, Supplier<T> supplier)
<T, R extends Number> Gauge<R>	gauge(MetricID metricID, T object, Function<T,R> func)
ConcurrentGauge	getConcurrentGauge(MetricID metricID)
SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges()
SortedMap<MetricID,ConcurrentGauge>	getConcurrentGauges(MetricFilter filter)
Counter	getCounter(MetricID metricID)
SortedMap<MetricID,Counter>	getCounters()
SortedMap<MetricID,Counter>	getCounters(MetricFilter filter)
Gauge<?>	getGauge(MetricID metricID)
SortedMap<MetricID,Gauge>	getGauges()
SortedMap<MetricID,Gauge>	getGauges(MetricFilter filter)
Histogram	getHistogram(MetricID metricID)
SortedMap<MetricID,Histogram>	getHistograms()
SortedMap<MetricID,Histogram>	getHistograms(MetricFilter filter)
Map<String,Metadata>	getMetadata()
Metadata	getMetadata(String name)
Meter	getMeter(MetricID metricID)
SortedMap<MetricID,Meter>	getMeters()
SortedMap<MetricID,Meter>	getMeters(MetricFilter filter)
Metric	getMetric(MetricID metricID)
<T extends Metric> T	getMetric(MetricID metricID, Class<T> asType)
SortedSet<MetricID>	getMetricIDs()
Map<MetricID,Metric>	getMetrics()
<T extends Metric> SortedMap<MetricID,T>	getMetrics(Class<T> ofType, MetricFilter filter)
SortedMap<MetricID,Metric>	getMetrics(MetricFilter filter)
protected List<Map.Entry<MetricID,M>>	getMetricsByName(String metricName)	Returns a list of metric ID/metric pairs which match the provided metric name.
SortedSet<String>	getNames()
protected Optional<Map.Entry<MetricID,M>>	getOptionalMetricEntry(String metricName)	Returns an Optional for an entry containing a metric ID and the corresponding metric matching the specified metric name.
SimpleTimer	getSimpleTimer(MetricID metricID)
SortedMap<MetricID,SimpleTimer>	getSimpleTimers()
SortedMap<MetricID,SimpleTimer>	getSimpleTimers(MetricFilter filter)
Timer	getTimer(MetricID metricID)
SortedMap<MetricID,Timer>	getTimers()
SortedMap<MetricID,Timer>	getTimers(MetricFilter filter)
MetricRegistry.Type	getType()
Histogram	histogram(String name)
Histogram	histogram(String name, Tag... tags)
Histogram	histogram(Metadata metadata)
Histogram	histogram(Metadata metadata, Tag... tags)
Histogram	histogram(MetricID metricID)
static boolean	isMarkedAsDeleted(Metric metric)	Indicates whether the specific metrics has been marked as deleted.
protected abstract boolean	isMetricEnabled(String metricName)	Indicates whether the specified metric name is enabled or not.
protected boolean	isStrictExemplars()
Map.Entry<Metadata,List<MetricID>>	metadataWithIDs(String metricName)	Returns a map entry, its key the metadata and its value all metric IDs matching the provided metric name.
Meter	meter(String name)
Meter	meter(String name, Tag... tags)
Meter	meter(Metadata metadata)
Meter	meter(Metadata metadata, Tag... tags)
Meter	meter(MetricID metricID)
protected Map<MetricType,BiFunction<String,Metadata,M>>	metricFactories()	For testing.
protected List<MetricID>	metricIDsForName(String metricName)	Returns a list of metric IDs given a metric name.
protected abstract Map<MetricType,BiFunction<String,Metadata,M>>	prepareMetricFactories()	Provides a map from MicroProfile metric type to a factory which creates a concrete metric instance of the MP metric type which also extends the implementation metric base class for the concrete implementation (e.g., no-op or full-featured).
protected abstract Map<Class<? extends M>,MetricType>	prepareMetricToTypeMap()	Prepares the map from Java types of implementation metrics to the corresponding MetricType.
<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)
RegistrySettings	registrySettings()
boolean	remove(String name)	Removes a metric by name.
boolean	remove(MetricID metricID)	Removes a metric by ID.
void	removeMatching(MetricFilter filter)
SimpleTimer	simpleTimer(String name)
SimpleTimer	simpleTimer(String name, Tag... tags)
SimpleTimer	simpleTimer(Metadata metadata)
SimpleTimer	simpleTimer(Metadata metadata, Tag... tags)
SimpleTimer	simpleTimer(MetricID metricID)
protected Stream<Map.Entry<MetricID,M>>	stream()	Returns a stream of Map.Entry for this registry for enabled metrics.
Timer	timer(String name)
Timer	timer(String name, Tag... tags)
Timer	timer(Metadata metadata)
Timer	timer(Metadata metadata, Tag... tags)
Timer	timer(MetricID metricID)
protected abstract <T extends Metric> M	toImpl(Metadata metadata, T metric)	Creates a new instance of an implementation wrapper around the indicated metric.
String	toString()
String	type()	Returns type of this registry.
void	update(RegistrySettings registrySettings)	Update the registry settings for this registry.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractRegistry

protected AbstractRegistry(MetricRegistry.Type type,
 Class<M> metricClass,
 RegistrySettings registrySettings)

Create a registry of a certain type.

Parameters:

type - Registry type.

metricClass - class of the specific metric type this registry manages

registrySettings - registry settings which influence this registry

Method Details

isMarkedAsDeleted

public static boolean isMarkedAsDeleted(Metric metric)

Indicates whether the specific metrics has been marked as deleted.

Parameters:

metric - the metric to check

Returns:

true if it's a Helidon metric and has been marked as deleted; false otherwise

isMetricEnabled

protected abstract boolean isMetricEnabled(String metricName)

Indicates whether the specified metric name is enabled or not.

Concrete implementations of this method should account for registry settings that might have disabled the specified metric or the registry as a whole. They do not need to check whether metrics in its entirety is enabled.

Parameters:

metricName - name of the metric to check

Returns:

true if the metric is enabled; false otherwise

register

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

Specified by:

register in interface MetricRegistry

Throws:

IllegalArgumentException

register

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

Specified by:

register in interface MetricRegistry

Throws:

IllegalArgumentException

register

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

Specified by:

register in interface MetricRegistry

Throws:

IllegalArgumentException

counter

public Counter counter(String name)

Specified by:

counter in interface MetricRegistry

counter

public Counter counter(Metadata metadata)

Specified by:

counter in interface MetricRegistry

counter

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

Specified by:

counter in interface MetricRegistry

counter

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

Specified by:

counter in interface MetricRegistry

counter

public Counter counter(MetricID metricID)

Specified by:

counter in interface MetricRegistry

getCounter

public Counter getCounter(MetricID metricID)

Specified by:

getCounter in interface MetricRegistry

histogram

public Histogram histogram(String name)

Specified by:

histogram in interface MetricRegistry

histogram

public Histogram histogram(Metadata metadata)

Specified by:

histogram in interface MetricRegistry

histogram

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

Specified by:

histogram in interface MetricRegistry

histogram

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

Specified by:

histogram in interface MetricRegistry

histogram

public Histogram histogram(MetricID metricID)

Specified by:

histogram in interface MetricRegistry

getHistogram

public Histogram getHistogram(MetricID metricID)

Specified by:

getHistogram in interface MetricRegistry

meter

public Meter meter(String name)

Specified by:

meter in interface MetricRegistry

meter

public Meter meter(Metadata metadata)

Specified by:

meter in interface MetricRegistry

meter

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

Specified by:

meter in interface MetricRegistry

meter

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

Specified by:

meter in interface MetricRegistry

meter

public Meter meter(MetricID metricID)

Specified by:

meter in interface MetricRegistry

getMeter

public Meter getMeter(MetricID metricID)

Specified by:

getMeter in interface MetricRegistry

timer

public Timer timer(String name)

Specified by:

timer in interface MetricRegistry

timer

public Timer timer(Metadata metadata)

Specified by:

timer in interface MetricRegistry

timer

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

Specified by:

timer in interface MetricRegistry

timer

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

Specified by:

timer in interface MetricRegistry

timer

public Timer timer(MetricID metricID)

Specified by:

timer in interface MetricRegistry

getTimer

public Timer getTimer(MetricID metricID)

Specified by:

getTimer in interface MetricRegistry

concurrentGauge

public ConcurrentGauge concurrentGauge(String name)

Specified by:

concurrentGauge in interface MetricRegistry

concurrentGauge

public ConcurrentGauge concurrentGauge(Metadata metadata)

Specified by:

concurrentGauge in interface MetricRegistry

concurrentGauge

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

Specified by:

concurrentGauge in interface MetricRegistry

concurrentGauge

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

Specified by:

concurrentGauge in interface MetricRegistry

concurrentGauge

public ConcurrentGauge concurrentGauge(MetricID metricID)

Specified by:

concurrentGauge in interface MetricRegistry

getConcurrentGauge

public ConcurrentGauge getConcurrentGauge(MetricID metricID)

Specified by:

getConcurrentGauge in interface MetricRegistry

simpleTimer

public SimpleTimer simpleTimer(String name)

Specified by:

simpleTimer in interface MetricRegistry

simpleTimer

public SimpleTimer simpleTimer(Metadata metadata)

Specified by:

simpleTimer in interface MetricRegistry

simpleTimer

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

Specified by:

simpleTimer in interface MetricRegistry

simpleTimer

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

Specified by:

simpleTimer in interface MetricRegistry

getSimpleTimer

public SimpleTimer getSimpleTimer(MetricID metricID)

Specified by:

getSimpleTimer in interface MetricRegistry

simpleTimer

public SimpleTimer simpleTimer(MetricID metricID)

Specified by:

simpleTimer in interface MetricRegistry

gauge

public <T,
R extends Number> Gauge<R> gauge(String name,
 T object,
 Function<T,R> func,
 Tag... tags)

Specified by:

gauge in interface MetricRegistry

gauge

public <T,
R extends Number> Gauge<R> gauge(MetricID metricID,
 T object,
 Function<T,R> func)

Specified by:

gauge in interface MetricRegistry

gauge

public <T,
R extends Number> Gauge<R> gauge(Metadata metadata,
 T object,
 Function<T,R> func,
 Tag... tags)

Specified by:

gauge in interface MetricRegistry

gauge

public <T extends Number> Gauge<T> gauge(String name,
 Supplier<T> supplier,
 Tag... tags)

Specified by:

gauge in interface MetricRegistry

gauge

public <T extends Number> Gauge<T> gauge(MetricID metricID,
 Supplier<T> supplier)

Specified by:

gauge in interface MetricRegistry

gauge

public <T extends Number> Gauge<T> gauge(Metadata metadata,
 Supplier<T> supplier,
 Tag... tags)

Specified by:

gauge in interface MetricRegistry

getGauge

public Gauge<?> getGauge(MetricID metricID)

Specified by:

getGauge in interface MetricRegistry

remove

public boolean remove(String name)

Removes a metric by name.

Specified by:

remove in interface MetricRegistry

Parameters:

name - Name of the metric.

Returns:

Outcome of removal.

remove

public boolean remove(MetricID metricID)

Removes a metric by ID.

Specified by:

remove in interface MetricRegistry

Parameters:

metricID - ID of metric.

Returns:

Outcome of removal.

removeMatching

public void removeMatching(MetricFilter filter)

Specified by:

removeMatching in interface MetricRegistry

getNames

public SortedSet<String> getNames()

Specified by:

getNames in interface MetricRegistry

getMetricIDs

public SortedSet<MetricID> getMetricIDs()

Specified by:

getMetricIDs in interface MetricRegistry

getGauges

public SortedMap<MetricID,Gauge> getGauges()

Specified by:

getGauges in interface MetricRegistry

getGauges

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

Specified by:

getGauges in interface MetricRegistry

getCounters

public SortedMap<MetricID,Counter> getCounters()

Specified by:

getCounters in interface MetricRegistry

getCounters

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

Specified by:

getCounters in interface MetricRegistry

getHistograms

public SortedMap<MetricID,Histogram> getHistograms()

Specified by:

getHistograms in interface MetricRegistry

getHistograms

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

Specified by:

getHistograms in interface MetricRegistry

getMeters

public SortedMap<MetricID,Meter> getMeters()

Specified by:

getMeters in interface MetricRegistry

getMeters

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

Specified by:

getMeters in interface MetricRegistry

getTimers

public SortedMap<MetricID,Timer> getTimers()

Specified by:

getTimers in interface MetricRegistry

getTimers

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

Specified by:

getTimers in interface MetricRegistry

getConcurrentGauges

public SortedMap<MetricID,ConcurrentGauge> getConcurrentGauges()

Specified by:

getConcurrentGauges in interface MetricRegistry

getConcurrentGauges

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

Specified by:

getConcurrentGauges in interface MetricRegistry

getSimpleTimers

public SortedMap<MetricID,SimpleTimer> getSimpleTimers()

Specified by:

getSimpleTimers in interface MetricRegistry

getSimpleTimers

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

Specified by:

getSimpleTimers in interface MetricRegistry

getMetadata

public Map<String,Metadata> getMetadata()

Specified by:

getMetadata in interface MetricRegistry

getMetadata

public Metadata getMetadata(String name)

Specified by:

getMetadata in interface MetricRegistry

getMetrics

public Map<MetricID,Metric> getMetrics()

Specified by:

getMetrics in interface MetricRegistry

getMetrics

public SortedMap<MetricID,Metric> getMetrics(MetricFilter filter)

Specified by:

getMetrics in interface MetricRegistry

getMetrics

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

Specified by:

getMetrics in interface MetricRegistry

getMetric

public Metric getMetric(MetricID metricID)

Specified by:

getMetric in interface MetricRegistry

getMetric

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

Specified by:

getMetric in interface MetricRegistry

update

public void update(RegistrySettings registrySettings)

Update the registry settings for this registry.

Parameters:

registrySettings - new settings to use going forward

type

public String type()

Returns type of this registry.

Returns:

The type.

getType

public MetricRegistry.Type getType()

Specified by:

getType in interface MetricRegistry

empty

public boolean empty()

Determines if registry is empty.

Returns:

Outcome of test.

toString

public String toString()

Overrides:

toString in class Object

metadataWithIDs

public Map.Entry<Metadata,List<MetricID>> metadataWithIDs(String metricName)

Returns a map entry, its key the metadata and its value all metric IDs matching the provided metric name.

Parameters:

metricName - name to search for

Returns:

the metadata and metric IDs known for the specified metric name; null if the name is not registered

registrySettings

public RegistrySettings registrySettings()

Returns:

the registry settings used to set up the registry

isStrictExemplars

protected boolean isStrictExemplars()

Returns:

whether exemplars are to be implemented strictly

stream

protected Stream<Map.Entry<MetricID,M>> stream()

Returns a stream of Map.Entry for this registry for enabled metrics.

Returns:

Stream of Map.Entry

toImpl

protected abstract <T extends Metric> M toImpl(Metadata metadata,
 T metric)

Creates a new instance of an implementation wrapper around the indicated metric.

Type Parameters:

T - specific type of Metric provided and wrapped

Parameters:

metadata - Metadata for the metric

metric - the existing metric to be wrapped by the impl

Returns:

new wrapper implementation around the specified metric instance

prepareMetricFactories

protected abstract Map<MetricType,BiFunction<String,Metadata,M>> prepareMetricFactories()

Provides a map from MicroProfile metric type to a factory which creates a concrete metric instance of the MP metric type which also extends the implementation metric base class for the concrete implementation (e.g., no-op or full-featured).

Returns:

map from each MicroProfile metric type to the correspondingfactory method

getOptionalMetricEntry

protected Optional<Map.Entry<MetricID,M>> getOptionalMetricEntry(String metricName)

Returns an Optional for an entry containing a metric ID and the corresponding metric matching the specified metric name.

If multiple metrics match the name (because of tags), the returned metric is, preferentially, the one (if any) with no tags. If all metrics registered under the specified name have tags, then the method returns the metric which was registered earliest

Parameters:

metricName - name of the metric of interest

Returns:

Optional of a map entry containing the metric ID and the metric selected

getMetricsByName

protected List<Map.Entry<MetricID,M>> getMetricsByName(String metricName)

Returns a list of metric ID/metric pairs which match the provided metric name.

Parameters:

metricName - name of the metric of interest

Returns:

List of entries indicating metrics with the specified name; empty of no matches

metricIDsForName

protected List<MetricID> metricIDsForName(String metricName)

Returns a list of metric IDs given a metric name.

Parameters:

metricName - name of the metric of interest

Returns:

list of metric IDs for metrics with the specified name; empty if no matches

createGauge

protected <T,
R extends Number> Gauge<R> createGauge(Metadata metadata,
 T object,
 Function<T,R> func)

Creates a gauge instance according to the provided metadata such that retrievals of the gauge value trigger an invocation of the provided function, passing the indicated object.

This default implementation uses a capturing lambda for retrieving the value. Concrete subclasses can override this implementation if capturing lambda behavior might become a performance issue.

Type Parameters:

T - Java type of the function parameter (and the object to pass to it)

R - specific Number subtype the gauge reports

Parameters:

metadata - metadata to use in creating the gauge

object - object to pass to the value-returning function

func - gauge-value-returning function

Returns:

new gauge

createGauge

protected abstract <R extends Number> Gauge<R> createGauge(Metadata metadata,
 Supplier<R> supplier)

Creates a gauge instance according to the specified supplier which returns the gauge value.

Type Parameters:

R - specific Number subtype the supplier returns

Parameters:

metadata - metadata to use in creating the gauge

supplier - gauge-value-returning supplier

Returns:

new gauge

deriveType

protected static MetricType deriveType(MetricType candidateType,
 Metric metric)

Infers the MetricType from a provided candidate type and a metric instance.

Parameters:

candidateType - type of metric to use if not invalid; typically computed from an existing metric

metric - the metric for which to derive the metric type

Returns:

the MetricType of the metric

metricFactories

protected Map<MetricType,BiFunction<String,Metadata,M>> metricFactories()

For testing.

Returns:

map from MicroProfile metric type to factory functions.

prepareMetricToTypeMap

protected abstract Map<Class<? extends M>,MetricType> prepareMetricToTypeMap()

Prepares the map from Java types of implementation metrics to the corresponding MetricType.

Returns:

prepared map for a given metrics implementation