Package io.quarkus.opentelemetry.runtime.config.build

Interface TracesBuildConfig

public interface TracesBuildConfig
Tracing build time configuration

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addEndUserAttributes()
    If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis.
    Optional<Boolean>
    enabled()
    Enable tracing with OpenTelemetry.
    List<String>
    exporter()
    List of exporters supported by Quarkus.
    String
    sampler()
    The sampler to use for tracing.

  • Method Details

    • enabled

      @WithDefault("true") Optional<Boolean> enabled()
      Enable tracing with OpenTelemetry.

      This property is not available in the Open Telemetry SDK. It's Quarkus specific.

      Support for OpenTelemetry Tracing will be enabled if this value is true. The OpenTelemetry SDK ( OTelBuildConfig.enabled() ) is enabled by default and if disabled, OpenTelemetry Tracing will also be disabled.

    • exporter

      @WithDefault("cdi") List<String> exporter()
      List of exporters supported by Quarkus.

      List of exporters to be used for tracing, separated by commas. Has one of the values on ExporterType `otlp`, `cdi`, `none` or the full qualified name of a class implementing SpanExporter

      Default on Quarkus is "cdi".

    • sampler

      @WithDefault("parentbased_always_on") String sampler()
      The sampler to use for tracing.

      Has one of the values on SamplerType `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the Sampler implementation set in the provider: ConfigurableSamplerProvider.

      Fallbacks to the legacy property quarkus.opentelemetry.tracer.sampler.sampler.name or defaults to "parentbased_always_on".

    • addEndUserAttributes

      @WithName("eusp.enabled") @WithDefault("false") boolean addEndUserAttributes()
      If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis.
      See Also: