Module io.helidon.tracing

Package io.helidon.tracing

Class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

java.lang.Object

io.helidon.tracing.ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

All Implemented Interfaces:

Prototype.Api, ExtendedTracerConfig

Direct Known Subclasses:

OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl

Enclosing class:

ExtendedTracerConfig.BuilderBase<BUILDER extends ExtendedTracerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ExtendedTracerConfig>

protected static class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl
extends Object
implements ExtendedTracerConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.tracing.ExtendedTracerConfig

ExtendedTracerConfig.Builder, ExtendedTracerConfig.BuilderBase<BUILDER extends ExtendedTracerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ExtendedTracerConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExtendedTracerConfigImpl(ExtendedTracerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Map<String,Boolean>	booleanTracerTags()	Tracer-level tags with boolean values added to all reported spans.
Optional<Resource>	clientCertificate()	Client certificate for connecting securely to the tracing collector.
Optional<String>	collectorHost()	Host used in connecting to the tracing collector.
Optional<String>	collectorPath()	Path at the collector host and port used when sending trace data to the collector.
Optional<Integer>	collectorPort()	Port used in connecting to the tracing collector.
Optional<String>	collectorProtocol()	Protocol (such as http or https) used in connecting to the tracing collector.
Optional<URI>	collectorUri()	URI for the collector to which to send tracing data.
boolean	enabled()	Whether to enable tracing.
boolean	equals(Object o)
Duration	exportTimeout()	Maximum time a transmission can be in progress before being cancelled.
int	hashCode()
Map<String,Integer>	intTracerTags()	Tracer level tags with integer values added to all reported spans.
int	maxExportBatchSize()	Maximum number of spans grouped for transmission together; typically does not exceed ExtendedTracerConfig.maxQueueSize() (batch processing).
int	maxQueueSize()	Maximum number of spans retained before discarding any not sent to the tracing collector (batch processing).
Optional<Resource>	privateKey()	Private key for connecting securely to the tracing collector.
boolean	registerGlobal()	Whether to create and register a tracer as the global tracer.
double	samplerParam()	Parameter value used by the selected sampler; interpretation depends on the sampler type..
SamplerType	samplerType()	Type of sampler for collecting spans.
Duration	scheduleDelay()	Delay between consecutive transmissions to the tracing collector (batch processing).
String	serviceName()	Service name of the traced service.
SpanProcessorType	spanProcessorType()	Type of span processor for accumulating spans before transmission to the tracing collector.
String	toString()
Map<String,String>	tracerTags()	Tracer-level tags with String values added to all reported spans.
Optional<Resource>	trustedCertificate()	Trusted certificates for connecting to the tracing collector.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExtendedTracerConfigImpl

protected ExtendedTracerConfigImpl(ExtendedTracerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

serviceName

public String serviceName()

Description copied from interface: ExtendedTracerConfig

Service name of the traced service.

Specified by:

serviceName in interface ExtendedTracerConfig

Returns:

service name

collectorUri

public Optional<URI> collectorUri()

Description copied from interface: ExtendedTracerConfig

URI for the collector to which to send tracing data.

Specified by:

collectorUri in interface ExtendedTracerConfig

Returns:

tracing collector URI

collectorProtocol

public Optional<String> collectorProtocol()

Description copied from interface: ExtendedTracerConfig

Protocol (such as http or https) used in connecting to the tracing collector.

Specified by:

collectorProtocol in interface ExtendedTracerConfig

Returns:

collector protocol

collectorPort

public Optional<Integer> collectorPort()

Description copied from interface: ExtendedTracerConfig

Port used in connecting to the tracing collector.

Specified by:

collectorPort in interface ExtendedTracerConfig

Returns:

collector port number

collectorHost

public Optional<String> collectorHost()

Description copied from interface: ExtendedTracerConfig

Host used in connecting to the tracing collector.

Specified by:

collectorHost in interface ExtendedTracerConfig

Returns:

collector host

collectorPath

public Optional<String> collectorPath()

Description copied from interface: ExtendedTracerConfig

Path at the collector host and port used when sending trace data to the collector.

Specified by:

collectorPath in interface ExtendedTracerConfig

Returns:

collector path

tracerTags

public Map<String,String> tracerTags()

Description copied from interface: ExtendedTracerConfig

Tracer-level tags with String values added to all reported spans.

Specified by:

tracerTags in interface ExtendedTracerConfig

Returns:

tracer-level string-valued tags

intTracerTags

public Map<String,Integer> intTracerTags()

Description copied from interface: ExtendedTracerConfig

Tracer level tags with integer values added to all reported spans.

Specified by:

intTracerTags in interface ExtendedTracerConfig

Returns:

tracer-level integer-valued tags

booleanTracerTags

public Map<String,Boolean> booleanTracerTags()

Description copied from interface: ExtendedTracerConfig

Tracer-level tags with boolean values added to all reported spans.

Specified by:

booleanTracerTags in interface ExtendedTracerConfig

Returns:

tracer-level boolean-valued tags

enabled

public boolean enabled()

Description copied from interface: ExtendedTracerConfig

Whether to enable tracing. That is, whether to use a fully-featured tracing implementation on the path vs. a no-op implementation.

Specified by:

enabled in interface ExtendedTracerConfig

Returns:

whether tracing is enabled

registerGlobal

public boolean registerGlobal()

Description copied from interface: ExtendedTracerConfig

Whether to create and register a tracer as the global tracer.

Specified by:

registerGlobal in interface ExtendedTracerConfig

Returns:

whether to register the configured tracer as global

privateKey

public Optional<Resource> privateKey()

Description copied from interface: ExtendedTracerConfig

Private key for connecting securely to the tracing collector.

Specified by:

privateKey in interface ExtendedTracerConfig

Returns:

private key

clientCertificate

public Optional<Resource> clientCertificate()

Description copied from interface: ExtendedTracerConfig

Client certificate for connecting securely to the tracing collector.

Specified by:

clientCertificate in interface ExtendedTracerConfig

Returns:

client certificate

trustedCertificate

public Optional<Resource> trustedCertificate()

Description copied from interface: ExtendedTracerConfig

Trusted certificates for connecting to the tracing collector.

Specified by:

trustedCertificate in interface ExtendedTracerConfig

Returns:

trusted certificates

spanProcessorType

public SpanProcessorType spanProcessorType()

Description copied from interface: ExtendedTracerConfig

Type of span processor for accumulating spans before transmission to the tracing collector.

Specified by:

spanProcessorType in interface ExtendedTracerConfig

Returns:

span processor type

scheduleDelay

public Duration scheduleDelay()

Description copied from interface: ExtendedTracerConfig

Delay between consecutive transmissions to the tracing collector (batch processing).

Specified by:

scheduleDelay in interface ExtendedTracerConfig

Returns:

delay between consecutive transmissions

maxQueueSize

public int maxQueueSize()

Description copied from interface: ExtendedTracerConfig

Maximum number of spans retained before discarding any not sent to the tracing collector (batch processing).

Specified by:

maxQueueSize in interface ExtendedTracerConfig

Returns:

maximum number of spans kept for transmission

maxExportBatchSize

public int maxExportBatchSize()

Description copied from interface: ExtendedTracerConfig

Maximum number of spans grouped for transmission together; typically does not exceed ExtendedTracerConfig.maxQueueSize() (batch processing).

Specified by:

maxExportBatchSize in interface ExtendedTracerConfig

Returns:

maximum number of spans batched

exportTimeout

public Duration exportTimeout()

Description copied from interface: ExtendedTracerConfig

Maximum time a transmission can be in progress before being cancelled.

Specified by:

exportTimeout in interface ExtendedTracerConfig

Returns:

maximum transmission time

samplerType

public SamplerType samplerType()

Description copied from interface: ExtendedTracerConfig

Type of sampler for collecting spans.

Specified by:

samplerType in interface ExtendedTracerConfig

Returns:

sampler type

samplerParam

public double samplerParam()

Description copied from interface: ExtendedTracerConfig

Parameter value used by the selected sampler; interpretation depends on the sampler type..

Specified by:

samplerParam in interface ExtendedTracerConfig

Returns:

sampler parameter value

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object