Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface ScopeConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ScopeConfig.BuilderBase.ScopeConfigImpl

public interface ScopeConfig
extends Prototype.Api

Configuration settings for a scope within the "metrics" config section.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScopeConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ScopeConfig.Builder	builder(ScopeConfig instance)	Create a new fluent API builder from an existing instance.
static ScopeConfig	create()	Create a new instance with default values.
static ScopeConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether the scope is enabled.
Optional<Pattern>	exclude()	Regular expression for meter names to exclude.
Optional<Pattern>	include()	Regular expression for meter names to include.
boolean	isMeterEnabled(String name)	Indicates whether the specified meter is enabled according to the scope configuration.
String	name()	Name of the scope to which the configuration applies.

Method Details

builder

static ScopeConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ScopeConfig.Builder builder(ScopeConfig 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 ScopeConfig 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 ScopeConfig create()

Create a new instance with default values.

Returns:

a new instance

isMeterEnabled

boolean isMeterEnabled(String name)

Indicates whether the specified meter is enabled according to the scope configuration.

Parameters:

name - meter name to check

Returns:

whether the meter is enabled

name

String name()

Name of the scope to which the configuration applies.

Returns:

scope name

enabled

boolean enabled()

Whether the scope is enabled.

Returns:

if the scope is enabled

include

Optional<Pattern> include()

Regular expression for meter names to include.

Returns:

include expression

exclude

Optional<Pattern> exclude()

Regular expression for meter names to exclude.

Returns:

exclude expression