Package io.quarkus.jaeger.runtime

Class JaegerConfig

java.lang.Object

io.quarkus.jaeger.runtime.JaegerConfig

@ConfigRoot(phase=RUN_TIME)
public class JaegerConfig
extends Object

The Jaeger configuration.

Field Summary

Fields

Modifier and Type	Field	Description
Optional<InetSocketAddress>	agentHostPort	The hostname and port for communicating with agent via UDP
Optional<String>	authToken	Authentication Token to send as "Bearer" to the endpoint
Boolean	disableTracerRegistration	Whether the registration of tracer as the global tracer should be disabled.
Optional<URI>	endpoint	The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces
Boolean	logTraceContext	Whether the trace context should be logged.
Optional<String>	password	Password to send as part of "Basic" authentication to the endpoint
Optional<String>	propagation	Comma separated list of formats to use for propagating the trace context.
Optional<Duration>	reporterFlushInterval	The reporter's flush interval
Optional<Boolean>	reporterLogSpans	Whether the reporter should also log the spans
OptionalInt	reporterMaxQueueSize	The reporter's maximum queue size
Optional<InetSocketAddress>	samplerManagerHostPort	The host name and port when using the remote controlled sampler
Optional<BigDecimal>	samplerParam	The sampler parameter (number)
Optional<String>	samplerType	The sampler type (const, probabilistic, ratelimiting or remote)
Optional<String>	senderFactory	The sender factory class name
Optional<String>	serviceName	The service name
Optional<String>	tags	A comma separated list of name = value tracer level tags, which get added to all reported spans.
Optional<String>	user	Username to send as part of "Basic" authentication to the endpoint

Constructor Summary

Constructors

Constructor	Description
JaegerConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

endpoint

@ConfigItem
public Optional<URI> endpoint

The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces

authToken

@ConfigItem
public Optional<String> authToken

Authentication Token to send as "Bearer" to the endpoint

user

@ConfigItem
public Optional<String> user

Username to send as part of "Basic" authentication to the endpoint

password

@ConfigItem
public Optional<String> password

Password to send as part of "Basic" authentication to the endpoint

agentHostPort

@ConfigItem
public Optional<InetSocketAddress> agentHostPort

The hostname and port for communicating with agent via UDP

reporterLogSpans

@ConfigItem
public Optional<Boolean> reporterLogSpans

Whether the reporter should also log the spans

reporterMaxQueueSize

@ConfigItem
public OptionalInt reporterMaxQueueSize

The reporter's maximum queue size

reporterFlushInterval

@ConfigItem
public Optional<Duration> reporterFlushInterval

The reporter's flush interval

samplerType

@ConfigItem
public Optional<String> samplerType

The sampler type (const, probabilistic, ratelimiting or remote)

samplerParam

@ConfigItem
public Optional<BigDecimal> samplerParam

The sampler parameter (number)

samplerManagerHostPort

@ConfigItem
public Optional<InetSocketAddress> samplerManagerHostPort

The host name and port when using the remote controlled sampler

serviceName

@ConfigItem
public Optional<String> serviceName

The service name

tags

@ConfigItem
public Optional<String> tags

A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format ${envVarName:default}, where the :default is optional, and identifies a value to be used if the environment variable cannot be found

propagation

@ConfigItem
public Optional<String> propagation

Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3

senderFactory

@ConfigItem
public Optional<String> senderFactory

The sender factory class name

logTraceContext

@ConfigItem(defaultValue="true")
public Boolean logTraceContext

Whether the trace context should be logged.

disableTracerRegistration

@ConfigItem(defaultValue="false")
public Boolean disableTracerRegistration

Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer.

Constructor Detail

JaegerConfig

public JaegerConfig()