Interface ExtendedTracerConfig

All Superinterfaces:
Prototype.Api
All Known Subinterfaces:
OpenTelemetryTracerConfig, io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracerConfigBlueprint
All Known Implementing Classes:
ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl, OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl
public interface ExtendedTracerConfig extends Prototype.Api
Common settings for tracers including settings for span processors and secure client connections.
See Also:

  • Method Details

    • builder

      static ExtendedTracerConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static ExtendedTracerConfig.Builder builder(ExtendedTracerConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static ExtendedTracerConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • serviceName

      String serviceName()
      Service name of the traced service.
      Returns:
      service name

    • collectorUri

      Optional<URI> collectorUri()
      URI for the collector to which to send tracing data.
      Returns:
      tracing collector URI

    • collectorProtocol

      Optional<String> collectorProtocol()
      Protocol (such as http or https) used in connecting to the tracing collector.
      Returns:
      collector protocol

    • collectorPort

      Optional<Integer> collectorPort()
      Port used in connecting to the tracing collector.
      Returns:
      collector port number

    • collectorHost

      Optional<String> collectorHost()
      Host used in connecting to the tracing collector.
      Returns:
      collector host

    • collectorPath

      Optional<String> collectorPath()
      Path at the collector host and port used when sending trace data to the collector.
      Returns:
      collector path

    • tracerTags

      Map<String,String> tracerTags()
      Tracer-level tags with String values added to all reported spans.
      Returns:
      tracer-level string-valued tags

    • intTracerTags

      Map<String,Integer> intTracerTags()
      Tracer level tags with integer values added to all reported spans.
      Returns:
      tracer-level integer-valued tags

    • booleanTracerTags

      Map<String,Boolean> booleanTracerTags()
      Tracer-level tags with boolean values added to all reported spans.
      Returns:
      tracer-level boolean-valued tags

    • enabled

      boolean enabled()
      Whether to enable tracing. That is, whether to use a fully-featured tracing implementation on the path vs. a no-op implementation.
      Returns:
      whether tracing is enabled

    • registered

      boolean registered()
      Whether this tracer configuration should be treated as an application-wide ownership candidate when it is resolved from the Helidon service registry.
      Returns:
      whether this configuration should be treated as an application-wide ownership candidate

    • registerGlobal

      boolean registerGlobal()
      Whether the OpenTelemetry instance created from this configuration should be published as the OpenTelemetry global; if an OpenTelemetry global already exists, Helidon leaves it unchanged and uses the existing global as the application OpenTelemetry instance.
      Returns:
      whether to publish the configured OpenTelemetry instance as global

    • privateKey

      Optional<Resource> privateKey()
      Private key for connecting securely to the tracing collector.
      Returns:
      private key

    • clientCertificate

      Optional<Resource> clientCertificate()
      Client certificate for connecting securely to the tracing collector.
      Returns:
      client certificate

    • trustedCertificate

      Optional<Resource> trustedCertificate()
      Trusted certificates for connecting to the tracing collector.
      Returns:
      trusted certificates

    • spanProcessorType

      SpanProcessorType spanProcessorType()
      Type of span processor for accumulating spans before transmission to the tracing collector.
      Returns:
      span processor type

    • scheduleDelay

      Duration scheduleDelay()
      Delay between consecutive transmissions to the tracing collector (batch processing).
      Returns:
      delay between consecutive transmissions

    • maxQueueSize

      int maxQueueSize()
      Maximum number of spans retained before discarding any not sent to the tracing collector (batch processing).
      Returns:
      maximum number of spans kept for transmission

    • maxExportBatchSize

      int maxExportBatchSize()
      Maximum number of spans grouped for transmission together; typically does not exceed maxQueueSize() (batch processing).
      Returns:
      maximum number of spans batched

    • exportTimeout

      Duration exportTimeout()
      Maximum time a transmission can be in progress before being cancelled.
      Returns:
      maximum transmission time

    • samplerType

      SamplerType samplerType()
      Type of sampler for collecting spans.
      Returns:
      sampler type

    • samplerParam

      double samplerParam()
      Parameter value used by the selected sampler; interpretation depends on the sampler type..
      Returns:
      sampler parameter value