Module io.helidon.tracing.config

Package io.helidon.tracing.config

Class TracingConfigUtil

java.lang.Object

io.helidon.tracing.config.TracingConfigUtil

public final class TracingConfigUtil
extends Object

Utility to get the current tracing configuration. The tracing configuration must be registered in current Context. This can be achieved either through configuration of the global context and registering it with a server component, or by using a server specific approach, such as Routing.Builder#register(WebTracingConfig).

Field Summary

Fields

Modifier and Type	Field	Description
static Object	OUTBOUND_SPAN_QUALIFIER	Qualifier for outbound io.opentracing.SpanContext as registered with Context.

Method Summary

Modifier and Type	Method	Description
static SpanTracingConfig	spanConfig(String component, String spanName)	Get the configuration of a single span from current Context.
static SpanTracingConfig	spanConfig(String component, String spanName, boolean defaultEnabled)	Get the configuration of a single span from current Context.
static SpanTracingConfig	spanConfig(String component, String spanName, Context context)	Get the configuration of a single span from the provided Context.

Methods inherited from class java.lang.Object

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

Field Detail

OUTBOUND_SPAN_QUALIFIER

public static final Object OUTBOUND_SPAN_QUALIFIER

Qualifier for outbound io.opentracing.SpanContext as registered with Context.

Method Detail

spanConfig

public static SpanTracingConfig spanConfig(String component,
                                           String spanName)

Get the configuration of a single span from current Context.

Parameters:

component - component tracing this span

spanName - name of the span to trace

Returns:

span configuration, including configuration of span logs

spanConfig

public static SpanTracingConfig spanConfig(String component,
                                           String spanName,
                                           Context context)

Get the configuration of a single span from the provided Context.

Parameters:

component - component tracing this span

spanName - name of the span to trace

context - context to get tracing configuration from

Returns:

span configuration, including configuration of span logs

spanConfig

public static SpanTracingConfig spanConfig(String component,
                                           String spanName,
                                           boolean defaultEnabled)

Get the configuration of a single span from current Context.

Parameters:

component - component tracing this span

spanName - name of the span to trace

defaultEnabled - whether tracing should be enabled by default

Returns:

span configuration, including configuration of span logs