Module io.helidon.metrics

Package io.helidon.metrics

Class MetricsSupport.Builder

java.lang.Object

io.helidon.servicecommon.rest.HelidonRestServiceSupport.Builder<MetricsSupport.Builder,MetricsSupport>

io.helidon.metrics.MetricsSupport.Builder

All Implemented Interfaces:

Builder<MetricsSupport.Builder,MetricsSupport>, MetricsSupport.Builder<MetricsSupport.Builder,MetricsSupport>, Supplier<MetricsSupport>

Enclosing class:

MetricsSupport

public static class MetricsSupport.Builder
extends HelidonRestServiceSupport.Builder<MetricsSupport.Builder,MetricsSupport>
implements MetricsSupport.Builder<MetricsSupport.Builder,MetricsSupport>

A fluent API builder to build instances of MetricsSupport.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Creates a new builder instance.

Method Summary

Modifier and Type	Method	Description
MetricsSupport	build()	Returns the new MetricsSupport instance according to the builder's settings.
protected MetricsSupport	build(Function<MetricsSupport.Builder,MetricsSupport> factory)	Creates a new MetricsSupport instance from the provided factory.
MetricsSupport.Builder	config(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. Use metricsSettings(MetricsSettings.Builder) instead
MetricsSupport.Builder	keyPerformanceIndicatorsMetricsConfig(Config kpiConfig)	Deprecated, for removal: This API element is subject to removal in a future version. Use metricsSettings(MetricsSettings.Builder) with MetricsSettings.Builder.keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder) instead.
MetricsSupport.Builder	keyPerformanceIndicatorsMetricsSettings(KeyPerformanceIndicatorMetricsSettings.Builder builder)	Deprecated, for removal: This API element is subject to removal in a future version. Use metricsSettings(MetricsSettings.Builder) with MetricsSettings.Builder.keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder) instead.
MetricsSupport.Builder	metricsSettings(MetricsSettings.Builder metricsSettingsBuilder)	Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.
MetricsSupport.Builder	registryFactory(RegistryFactory factory)	If you want to have multiple registry factories with different endpoints, you may create them using RegistryFactory.create(MetricsSettings) or RegistryFactory.create() and create multiple MetricsSupport instances with different HelidonRestServiceSupport.Builder.webContext(String) contexts}.
protected Config	webContextConfig(Config config)	Returns the web-context Config node from the provided config.

Methods inherited from class io.helidon.servicecommon.rest.HelidonRestServiceSupport.Builder

config, crossOriginConfig, crossOriginConfig, restServiceSettings, webContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Methods inherited from interface io.helidon.metrics.serviceapi.MetricsSupport.Builder

restServiceSettings

Constructor Details

Builder

protected Builder()

Creates a new builder instance.

Method Details

webContextConfig

protected Config webContextConfig(Config config)

Description copied from class: HelidonRestServiceSupport.Builder

Returns the web-context Config node from the provided config.

Overrides:

webContextConfig in class HelidonRestServiceSupport.Builder<MetricsSupport.Builder,MetricsSupport>

Parameters:

config - config to query for web-context

Returns:

Config node for web-context

build

public MetricsSupport build()

Description copied from interface: MetricsSupport.Builder

Returns the new MetricsSupport instance according to the builder's settings.

Specified by:

build in interface Builder<MetricsSupport.Builder,MetricsSupport>

Specified by:

build in interface MetricsSupport.Builder<MetricsSupport.Builder,MetricsSupport>

Returns:

the new metrics support

build

protected MetricsSupport build(Function<MetricsSupport.Builder,MetricsSupport> factory)

Creates a new MetricsSupport instance from the provided factory.

Parameters:

factory - the factory which maps the builder to a MetricsSupport instance

Returns:

the created MetricsSupport instance

config

@Deprecated(since="2.4.0",
            forRemoval=true)
public MetricsSupport.Builder config(Config config)

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

Use metricsSettings(MetricsSettings.Builder) instead

Override default configuration.

Overrides:

config in class HelidonRestServiceSupport.Builder<MetricsSupport.Builder,MetricsSupport>

Parameters:

config - configuration instance

Returns:

updated builder instance

See Also:

• Details about key performance metrics configuration

metricsSettings

public MetricsSupport.Builder metricsSettings(MetricsSettings.Builder metricsSettingsBuilder)

Description copied from interface: MetricsSupport.Builder

Assigns MetricsSettings which will be used in creating the MetricsSupport instance at build-time.

Specified by:

metricsSettings in interface MetricsSupport.Builder<MetricsSupport.Builder,MetricsSupport>

Parameters:

metricsSettingsBuilder - the metrics settings to assign for use in building the MetricsSupport instance

Returns:

updated builder

registryFactory

public MetricsSupport.Builder registryFactory(RegistryFactory factory)

If you want to have multiple registry factories with different endpoints, you may create them using RegistryFactory.create(MetricsSettings) or RegistryFactory.create() and create multiple MetricsSupport instances with different HelidonRestServiceSupport.Builder.webContext(String) contexts}.

If this method is not called, MetricsSupport would use the shared instance as provided by RegistryFactory.getInstance(io.helidon.config.Config)

Parameters:

factory - factory to use in this metric support

Returns:

updated builder instance

keyPerformanceIndicatorsMetricsSettings

@Deprecated(since="2.4.0",
            forRemoval=true)
public MetricsSupport.Builder keyPerformanceIndicatorsMetricsSettings(KeyPerformanceIndicatorMetricsSettings.Builder builder)

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

Use metricsSettings(MetricsSettings.Builder) with MetricsSettings.Builder.keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder) instead.

Sets the builder for KPI metrics settings, overriding any previously-assigned settings.

Parameters:

builder - for the KPI metrics settings

Returns:

updated builder instance

keyPerformanceIndicatorsMetricsConfig

@Deprecated(since="2.4.0",
            forRemoval=true)
public MetricsSupport.Builder keyPerformanceIndicatorsMetricsConfig(Config kpiConfig)

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

Use metricsSettings(MetricsSettings.Builder) with MetricsSettings.Builder.keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder) instead.

Updates the KPI metrics config using the extended KPI metrics config node provided.

Parameters:

kpiConfig - Config node containing extended KPI metrics config

Returns:

updated builder instance