Module io.helidon.metrics.providers.micrometer

Package io.helidon.metrics.providers.micrometer

Class MicrometerMetricsFactoryProvider

java.lang.Object

io.helidon.metrics.providers.micrometer.MicrometerMetricsFactoryProvider

All Implemented Interfaces:

MetricsFactoryProvider

public class MicrometerMetricsFactoryProvider
extends Object
implements MetricsFactoryProvider

Provides the Micrometer meter registry to use as a delegate for the implementation of the Helidon metrics API.

Constructor Summary

Constructors

Constructor	Description
MicrometerMetricsFactoryProvider()	Creates a new MetricsFactory based on Micrometer.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all metrics factories created by this provider.
MetricsFactory	create(Config rootConfig, io.helidon.metrics.api.MetricsConfig metricsConfig, Collection<MetersProvider> metersProviders)	Creates a new MetricsFactory from which the caller can obtain MeterRegistry and Meter.Builder instances.

Methods inherited from class java.lang.Object

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

Constructor Details

MicrometerMetricsFactoryProvider

public MicrometerMetricsFactoryProvider()

Creates a new MetricsFactory based on Micrometer. Public for service loading.

Method Details

create

public MetricsFactory create(Config rootConfig,
 io.helidon.metrics.api.MetricsConfig metricsConfig,
 Collection<MetersProvider> metersProviders)

Description copied from interface: MetricsFactoryProvider

Creates a new MetricsFactory from which the caller can obtain MeterRegistry and Meter.Builder instances.

The metricsConfig parameter will have been derived from the rootConfig. In many cases the new factory will only need to know the metrics configuration so that object is provided as a convenience. The root config node allows the factory to use information from elsewhere in the config tree if needed.

Specified by:

create in interface MetricsFactoryProvider

Parameters:

rootConfig - root Config node

metricsConfig - MetricsConfig settings

metersProviders - group of MetersProvider which can furnish Meter.Builder instances

Returns:

new metrics factory

close

public void close()

Description copied from interface: MetricsFactoryProvider

Closes all metrics factories created by this provider.

Applications do not normally need to invoke this method.

Specified by:

close in interface MetricsFactoryProvider