Module io.helidon.webserver.observe.tracing

Package io.helidon.webserver.observe.tracing

Interface TracingObserverConfig

All Superinterfaces:

ObserverConfigBase, Prototype.Api, Prototype.Factory<TracingObserver>

All Known Implementing Classes:

TracingObserverConfig.BuilderBase.TracingObserverConfigImpl

public interface TracingObserverConfig
extends Prototype.Api, ObserverConfigBase

Configuration of Tracing observer.

See Also:

• TracingObserver.create(io.helidon.webserver.observe.tracing.TracingObserverConfig)
• TracingObserver.builder()
• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TracingObserverConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static TracingObserverConfig.Builder	builder(TracingObserverConfig instance)	Create a new fluent API builder from an existing instance.
static TracingObserverConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether this observer is enabled.
TracingConfig	envConfig()	Use the provided configuration as a default for any request.
String	name()
List<PathTracingConfig>	pathConfigs()	Path specific configuration of tracing.
Set<String>	sockets()	Sockets to trace.
Tracer	tracer()	Tracer to use to extract inbound span context.
double	weight()	Weight of the feature registered with WebServer.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Method Details

builder

static TracingObserverConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static TracingObserverConfig.Builder builder(TracingObserverConfig 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 TracingObserverConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

name

String name()

envConfig

TracingConfig envConfig()

Use the provided configuration as a default for any request.

Returns:

default web server tracing configuration

pathConfigs

List<PathTracingConfig> pathConfigs()

Path specific configuration of tracing.

Returns:

configuration of tracing for specific paths

tracer

Tracer tracer()

Tracer to use to extract inbound span context.

Returns:

tracer to use

weight

double weight()

Weight of the feature registered with WebServer. Changing weight may cause tracing to be executed at a different time (such as after security, or even after all routes). Please understand feature weights before changing this order.

Returns:

weight of tracing feature

sockets

Set<String> sockets()

Sockets to trace.

If empty, all sockets will be traced. The default socket without any tag, additional sockets with a tag with the socket name.

Returns:

set of sockets to trace

enabled

boolean enabled()

Whether this observer is enabled.

Returns:

false to disable observer