io.micronaut.tracing.jaeger

Class JaegerConfiguration

java.lang.Object

io.micronaut.tracing.jaeger.JaegerConfiguration

All Implemented Interfaces:

Toggleable

@ConfigurationProperties(value="tracing.jaeger")
public class JaegerConfiguration
extends java.lang.Object
implements Toggleable

Configuration for Jaeger tracing.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JaegerConfiguration.JaegerReporterConfiguration The reporter configuration bean.
static class	JaegerConfiguration.JaegerSamplerConfiguration The sampler configuration bean.
static class	JaegerConfiguration.JaegerSenderConfiguration The sender configuration bean.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jaegertracing.Configuration	configuration
static boolean	DEFAULT_ENABLED The default enable value.
static java.lang.String	PREFIX The configuration prefix.

Constructor Summary

Constructors

Constructor and Description
JaegerConfiguration(ApplicationConfiguration applicationConfiguration) Initialize Jaeger with common application configurations.

Method Summary

Modifier and Type	Method and Description
io.jaegertracing.Configuration	getConfiguration()
boolean	isEnabled()
boolean	isExpandExceptionLogs()
boolean	isZipkinSharedRpcSpan()
void	setCodecConfiguration(io.jaegertracing.Configuration.CodecConfiguration codecConfiguration) Sets the codec configuration.
void	setEnabled(boolean enabled) Enable/Disable Jaeger.
void	setExpandExceptionLogs(boolean expandExceptionLogs) Whether to expand exception logs.
void	setReporterConfiguration(io.jaegertracing.Configuration.ReporterConfiguration reporterConfiguration) Sets the reporter configuration.
void	setReporterConfiguration(JaegerConfiguration.JaegerReporterConfiguration reporterConfiguration) Sets the reporter configuration.
void	setSamplerConfiguration(io.jaegertracing.Configuration.SamplerConfiguration samplerConfiguration) Sets the sampler configuration.
void	setSamplerConfiguration(JaegerConfiguration.JaegerSamplerConfiguration samplerConfiguration) Sets the sampler configuration.
void	setZipkinSharedRpcSpan(boolean zipkinSharedRpcSpan) Whether to use Zipkin shared RPC.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

The configuration prefix.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

configuration

@ConfigurationBuilder(prefixes="with",
                      includes="tracerTags")
protected final io.jaegertracing.Configuration configuration

Constructor Detail

JaegerConfiguration

public JaegerConfiguration(ApplicationConfiguration applicationConfiguration)

Initialize Jaeger with common application configurations.

Parameters:

applicationConfiguration - The common application configurations

Method Detail

isExpandExceptionLogs

public boolean isExpandExceptionLogs()

Returns:

Whether to expand exception logs

setExpandExceptionLogs

public void setExpandExceptionLogs(boolean expandExceptionLogs)

Whether to expand exception logs.

Parameters:

expandExceptionLogs - True if they should be expanded

isZipkinSharedRpcSpan

public boolean isZipkinSharedRpcSpan()

Returns:

Whether to use Zipkin shared RPC

setZipkinSharedRpcSpan

public void setZipkinSharedRpcSpan(boolean zipkinSharedRpcSpan)

Whether to use Zipkin shared RPC.

Parameters:

zipkinSharedRpcSpan - True if Zipkin shared RPC should be used

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the component is enabled

setEnabled

public void setEnabled(boolean enabled)

Enable/Disable Jaeger. Default value (false).

Parameters:

enabled - A boolean to enable/disabled Jaeger

getConfiguration

public io.jaegertracing.Configuration getConfiguration()

Returns:

The Jaeger Configuration object

setSamplerConfiguration

@Inject
public void setSamplerConfiguration(@Nullable
                                            io.jaegertracing.Configuration.SamplerConfiguration samplerConfiguration)

Sets the sampler configuration.

Parameters:

samplerConfiguration - The sampler configuration

setReporterConfiguration

@Inject
public void setReporterConfiguration(@Nullable
                                             io.jaegertracing.Configuration.ReporterConfiguration reporterConfiguration)

Sets the reporter configuration.

Parameters:

reporterConfiguration - The reporter configuration

setSamplerConfiguration

@Inject
public void setSamplerConfiguration(@Nullable
                                            JaegerConfiguration.JaegerSamplerConfiguration samplerConfiguration)

Sets the sampler configuration.

Parameters:

samplerConfiguration - The sampler configuration

setReporterConfiguration

@Inject
public void setReporterConfiguration(@Nullable
                                             JaegerConfiguration.JaegerReporterConfiguration reporterConfiguration)

Sets the reporter configuration.

Parameters:

reporterConfiguration - The reporter configuration

setCodecConfiguration

@Inject
public void setCodecConfiguration(@Nullable
                                          io.jaegertracing.Configuration.CodecConfiguration codecConfiguration)

Sets the codec configuration.

Parameters:

codecConfiguration - The codec configuration