Module io.helidon.metrics.api

Package io.helidon.metrics.spi

Interface MetricsFactoryProvider

All Known Implementing Classes:

MicrometerMetricsFactoryProvider

public interface MetricsFactoryProvider

Creates new instances of MetricsFactory.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all metrics factories created by this provider.
default MetricsFactory	create(Config rootConfig, MetricsConfig metricsConfig, Collection<MetersProvider> metersProviders)	Deprecated, for removal: This API element is subject to removal in a future version. use create(io.helidon.config.Config, io.helidon.metrics.api.MetricsConfig, java.util.Collection) instead
default MetricsFactory	create(Config rootConfig, MetricsConfig metricsConfig, Collection<MetersProvider> metersProviders)	Creates a new MetricsFactory from which the caller can obtain MeterRegistry and Meter.Builder instances.

Method Details

create

@Deprecated(since="4.4.0",
            forRemoval=true)
default MetricsFactory create(Config rootConfig,
 MetricsConfig metricsConfig,
 Collection<MetersProvider> metersProviders)

Deprecated, for removal: This API element is subject to removal in a future version.

use create(io.helidon.config.Config, io.helidon.metrics.api.MetricsConfig, java.util.Collection) instead

Creates a new instance from configuration.

Parameters:

rootConfig - root config node

metricsConfig - metrics config

metersProviders - group of providers

Returns:

new metrics factory

create

default MetricsFactory create(Config rootConfig,
 MetricsConfig metricsConfig,
 Collection<MetersProvider> metersProviders)

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.

API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

Parameters:

rootConfig - root Config node

metricsConfig - MetricsConfig settings

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

Returns:

new metrics factory

Since:

4.4.0

close

void close()

Closes all metrics factories created by this provider.

Applications do not normally need to invoke this method.