Module io.helidon.metrics

Package io.helidon.metrics

Class RegistryFactory

java.lang.Object

io.helidon.metrics.RegistryFactory

All Implemented Interfaces:

RegistryFactory

public class RegistryFactory
extends Object
implements RegistryFactory

Access point to all registries. There are two options to use the factory:

1. A singleton instance, obtained through getInstance() or getInstance(io.helidon.config.Config). This instance is lazily initialized - the latest call that provides a config instance before a MetricRegistry.Type.BASE registry is obtained would be used to configure the base registry (as that is the only configurable registry in current implementation)
2. A custom instance, obtained through create(Config) or create(). This would create a new instance of a registry factory (in case multiple instances are desired), independent on the singleton instance and on other instances provided by these methods.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegistryFactory(MetricsSettings metricsSettings, Registry appRegistry, Registry vendorRegistry)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
static RegistryFactory	create()	Deprecated, for removal: This API element is subject to removal in a future version. Use RegistryFactory.create()
static RegistryFactory	create(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. Use RegistryFactory.create(Config)
static RegistryFactory	getInstance()	Deprecated, for removal: This API element is subject to removal in a future version. Use RegistryFactory.getInstance()
static RegistryFactory	getInstance(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. Use RegistryFactory.getInstance(MetricsSettings)
MetricRegistry	getRegistry(MetricRegistry.Type type)	Get a registry based on its type.
void	update(MetricsSettings metricsSettings)	Updates the metrics settings for the RegistryFactory.

Methods inherited from class java.lang.Object

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

Constructor Details

RegistryFactory

protected RegistryFactory(MetricsSettings metricsSettings,
 Registry appRegistry,
 Registry vendorRegistry)

Create a new instance.

Parameters:

metricsSettings - metrics setting to use in preparing the registry factory

appRegistry - application registry to provide from the factory

vendorRegistry - vendor registry to provide from the factory

Method Details

create

@Deprecated(since="2.4.0",
            forRemoval=true)
public static RegistryFactory create()

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

Use RegistryFactory.create()

Create a new factory with default configuration, with pre-filled MetricRegistry.Type.VENDOR and MetricRegistry.Type.BASE metrics.

Returns:

a new registry factory

create

@Deprecated(since="2.4.0",
            forRemoval=true)
public static RegistryFactory create(Config config)

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

Use RegistryFactory.create(Config)

Create a new factory with provided configuration, with pre filled MetricRegistry.Type.VENDOR and MetricRegistry.Type.BASE metrics.

Parameters:

config - configuration to use

Returns:

a new registry factory

getInstance

@Deprecated(since="2.4.0",
            forRemoval=true)
public static RegistryFactory getInstance()

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

Use RegistryFactory.getInstance()

Get a singleton instance of the registry factory.

Returns:

registry factory singleton

getInstance

@Deprecated(since="2.4.0",
            forRemoval=true)
public static RegistryFactory getInstance(Config config)

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

Use RegistryFactory.getInstance(MetricsSettings)

Get a singleton instance of the registry factory for and update it with provided configuration. Note that the config is used only if nobody access the base registry.

Parameters:

config - configuration of the registry factory used to update behavior of the instance returned

Returns:

registry factory singleton

getRegistry

public MetricRegistry getRegistry(MetricRegistry.Type type)

Get a registry based on its type. For MetricRegistry.Type.APPLICATION and MetricRegistry.Type.VENDOR returns a modifiable registry, for MetricRegistry.Type.BASE returns a final registry (cannot register new metrics).

Specified by:

getRegistry in interface RegistryFactory

Parameters:

type - type of registry

Returns:

MetricRegistry for the type defined.

update

public void update(MetricsSettings metricsSettings)

Description copied from interface: RegistryFactory

Updates the metrics settings for the RegistryFactory.

Reserved for use by internal Helidon code.

Specified by:

update in interface RegistryFactory

Parameters:

metricsSettings - metrics settings to use in updating the factory