Module io.helidon.telemetry.otelconfig

Package io.helidon.telemetry.otelconfig

Interface ViewRegistrationConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ViewRegistrationConfig.BuilderBase.ViewRegistrationConfigImpl

public interface ViewRegistrationConfig
extends Prototype.Api

Settings for an OpenTelemetry metrics view registration.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.sdk.metrics.Aggregation	aggregation()	Aggregation for the metric view, configurable as an AggregationType: DROP, DEFAULT, SUM, LAST_VALUE, EXPLICIT_BUCKET_HISTOGRAM, BASE2_EXPONENTIAL_BUCKET_HISTOGRAM.
Optional<Predicate<String>>	attributeFilter()	Attribute name filter, configurable as a string compiled as a regular expression using Pattern.
static ViewRegistrationConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ViewRegistrationConfig.Builder	builder(ViewRegistrationConfig instance)	Create a new fluent API builder from an existing instance.
Optional<Integer>	cardinalityLimit()	Cardinality limit.
static ViewRegistrationConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static ViewRegistrationConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	description()	Metric view description.
io.opentelemetry.sdk.metrics.InstrumentSelector	instrumentSelector()	Instrument selector, configurable using InstrumentSelectorConfig.
Optional<String>	name()	Metrics view name.
default io.opentelemetry.sdk.metrics.View	view()	Creates a View instance based on the config settings.

Method Details

builder

static ViewRegistrationConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ViewRegistrationConfig.Builder builder(ViewRegistrationConfig 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 ViewRegistrationConfig 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

@Deprecated
static ViewRegistrationConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

view

default io.opentelemetry.sdk.metrics.View view()

Creates a View instance based on the config settings.

Returns:

View

name

Optional<String> name()

Metrics view name.

Returns:

metric view name

description

Optional<String> description()

Metric view description.

Returns:

metric view description

aggregation

io.opentelemetry.sdk.metrics.Aggregation aggregation()

Aggregation for the metric view, configurable as an AggregationType: DROP, DEFAULT, SUM, LAST_VALUE, EXPLICIT_BUCKET_HISTOGRAM, BASE2_EXPONENTIAL_BUCKET_HISTOGRAM.

Returns:

aggregation for the metric view

attributeFilter

Optional<Predicate<String>> attributeFilter()

Attribute name filter, configurable as a string compiled as a regular expression using Pattern.

Returns:

attribute name filter

instrumentSelector

io.opentelemetry.sdk.metrics.InstrumentSelector instrumentSelector()

Instrument selector, configurable using InstrumentSelectorConfig.

Returns:

instrument selector

cardinalityLimit

Optional<Integer> cardinalityLimit()

Cardinality limit.

Returns:

cardinality limit