io.micronaut.tracing.brave

Class BraveTracerConfiguration

java.lang.Object

io.micronaut.tracing.brave.BraveTracerConfiguration

All Implemented Interfaces:

Toggleable

@Requires(classes=brave.Tracing.class) @Requires(property="tracing.zipkin.enabled",value="true")
 @ConfigurationProperties(value="tracing.zipkin")
public class BraveTracerConfiguration
extends Object
implements Toggleable

A Configuration properties for Brave.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BraveTracerConfiguration.HttpClientSenderConfiguration Used to configure HTTP trace sending under the tracing.zipkin.http namespace.
static class	BraveTracerConfiguration.SamplerConfiguration The sampler configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static float	DEFAULT_SAMPLER_PROBABILITY
static String	PREFIX
protected brave.Tracing.Builder	tracingBuilder

Constructor Summary

Constructors

Constructor and Description
BraveTracerConfiguration(ApplicationConfiguration configuration) Constructs a new BraveTracerConfiguration.

Method Summary

Modifier and Type	Method and Description
brave.Tracing.Builder	getTracingBuilder()
boolean	isEnabled()
void	setClock(brave.Clock clock)
void	setCurrentTraceContext(brave.propagation.CurrentTraceContext traceContext) Sets the current trace context.
void	setEnabled(boolean enabled) Default value (false).
void	setErrorParser(brave.ErrorParser errorParser)
void	setPropagationFactory(brave.propagation.Propagation.Factory propagationFactory)
void	setSampler(brave.sampler.Sampler sampler)
void	setSamplerConfiguration(BraveTracerConfiguration.SamplerConfiguration samplerConfiguration)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

DEFAULT_SAMPLER_PROBABILITY

public static final float DEFAULT_SAMPLER_PROBABILITY

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

tracingBuilder

@ConfigurationBuilder(prefixes="",
                      excludes={"errorParser","clock","endpoint","spanReporter","propagationFactory","currentTraceContext","sampler"})
protected brave.Tracing.Builder tracingBuilder

Constructor Detail

BraveTracerConfiguration

public BraveTracerConfiguration(ApplicationConfiguration configuration)

Constructs a new BraveTracerConfiguration.

Parameters:

configuration - The application configuration

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Is tracing enabled

setEnabled

public void setEnabled(boolean enabled)

Default value (false).

Parameters:

enabled - True if tracing is enabled

setSamplerConfiguration

@Inject
public void setSamplerConfiguration(@Nullable
                                            BraveTracerConfiguration.SamplerConfiguration samplerConfiguration)

Parameters:

samplerConfiguration - The sampler configuration

getTracingBuilder

public brave.Tracing.Builder getTracingBuilder()

Returns:

The Tracing builder

setSampler

@Inject
public void setSampler(@Nullable
                               brave.sampler.Sampler sampler)

Parameters:

sampler - The Sampler to use

setErrorParser

@Inject
public void setErrorParser(@Nullable
                                   brave.ErrorParser errorParser)

Parameters:

errorParser - The ErrorParser to use

setPropagationFactory

@Inject
public void setPropagationFactory(@Nullable
                                          brave.propagation.Propagation.Factory propagationFactory)

Parameters:

propagationFactory - The Propagation.Factory to use

setClock

@Inject
public void setClock(@Nullable
                             brave.Clock clock)

Parameters:

clock - The Clock to use

setCurrentTraceContext

@Inject
public void setCurrentTraceContext(brave.propagation.CurrentTraceContext traceContext)

Sets the current trace context.

Parameters:

traceContext - The trace context