Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface ScopingConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ScopingConfig.BuilderBase.ScopingConfigImpl

public interface ScopingConfig
extends Prototype.Api

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ScopingConfig.Builder	Fluent API builder for ScopingConfig.
static class	ScopingConfig.BuilderBase<BUILDER extends ScopingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopingConfig>	Fluent API builder base for ScopingConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCOPE_TAG_NAME_DEFAULT	Default tag name for recording a meter's scope as a tag.

Method Summary

Modifier and Type	Method	Description
static ScopingConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ScopingConfig.Builder	builder(ScopingConfig instance)	Create a new fluent API builder from an existing instance.
static ScopingConfig	create()	Create a new instance with default values.
static ScopingConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	defaultValue()	Default scope value to associate with meters that are registered without an explicit setting; no setting means meters are assigned scope "application".
Map<String,ScopeConfig>	scopes()	Settings for individual scopes.
Optional<String>	tagName()	Tag name for storing meter scope values in the underlying implementation meter registry.

Field Details

SCOPE_TAG_NAME_DEFAULT

static final String SCOPE_TAG_NAME_DEFAULT

Default tag name for recording a meter's scope as a tag.

See Also:

• Constant Field Values

Method Details

builder

static ScopingConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ScopingConfig.Builder builder(ScopingConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ScopingConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ScopingConfig create()

Create a new instance with default values.

Returns:

a new instance

defaultValue

Optional<String> defaultValue()

Default scope value to associate with meters that are registered without an explicit setting; no setting means meters are assigned scope "application".

Returns:

default scope value

tagName

Optional<String> tagName()

Tag name for storing meter scope values in the underlying implementation meter registry.

Returns:

tag name for storing scope values

scopes

Map<String,ScopeConfig> scopes()

Settings for individual scopes.

Returns:

scope settings