Module io.helidon.telemetry.otelconfig
Package io.helidon.telemetry.otelconfig

Class OpenTelemetryLoggingConfig.BuilderBase<BUILDER extends OpenTelemetryLoggingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenTelemetryLoggingConfig>

java.lang.Object
io.helidon.telemetry.otelconfig.OpenTelemetryLoggingConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
OpenTelemetryLoggingConfig.Builder
Enclosing interface:
OpenTelemetryLoggingConfig
public abstract static class OpenTelemetryLoggingConfig.BuilderBase<BUILDER extends OpenTelemetryLoggingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenTelemetryLoggingConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenTelemetryLoggingConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenTelemetryLoggingConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(OpenTelemetryLoggingConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenTelemetryLoggingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenTelemetryLoggingConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenTelemetryLoggingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenTelemetryLoggingConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearEnabled

      public BUILDER clearEnabled()
      Clear existing value of enabled.
      Returns:
      updated builder instance
      See Also:

    • enabled

      public BUILDER enabled(boolean enabled)
      Whether the OpenTelemetry logger should be enabled. (Passed to OpenTelemetry.)
      Parameters:
      enabled - true if the OpenTelemetry logger should be enabled, false otherwise
      Returns:
      updated builder instance
      See Also:

    • clearMinimumSeverity

      public BUILDER clearMinimumSeverity()
      Clear existing value of minimumSeverity.
      Returns:
      updated builder instance
      See Also:

    • minimumSeverity

      public BUILDER minimumSeverity(io.opentelemetry.api.logs.Severity minimumSeverity)
      Minimum severity level of log records to process.
      Parameters:
      minimumSeverity - minimum severity level
      Returns:
      updated builder instance
      See Also:

    • clearTraceBased

      public BUILDER clearTraceBased()
      Clear existing value of traceBased.
      Returns:
      updated builder instance
      See Also:

    • traceBased

      public BUILDER traceBased(boolean traceBased)
      Whether to include only log records from traces which are sampled. Defaults to the OpenTelemetry default.
      Parameters:
      traceBased - whether to restrict exported log records to only those from sampled traces
      Returns:
      updated builder instance
      See Also:

    • clearLogLimits

      public BUILDER clearLogLimits()
      Clear existing value of logLimits.
      Returns:
      updated builder instance
      See Also:

    • logLimits

      public BUILDER logLimits(io.opentelemetry.sdk.logs.LogLimits logLimits)
      Log limits to apply to log transmission.
      Parameters:
      logLimits - log limits
      Returns:
      updated builder instance
      See Also:

    • logLimits

      public BUILDER logLimits(Consumer<io.opentelemetry.sdk.logs.LogLimitsBuilder> consumer)
      Log limits to apply to log transmission.
      Parameters:
      consumer - consumer of builder of log limits
      Returns:
      updated builder instance
      See Also:

    • logLimits

      public BUILDER logLimits(Supplier<? extends io.opentelemetry.sdk.logs.LogLimits> supplier)
      Log limits to apply to log transmission.
      Parameters:
      supplier - supplier of log limits
      Returns:
      updated builder instance
      See Also:

    • clearProcessors

      public BUILDER clearProcessors()
      Clear all processors.
      Returns:
      updated builder instance
      See Also:

    • processors

      public BUILDER processors(List<? extends io.opentelemetry.sdk.logs.LogRecordProcessor> processors)
      Pre-constructed (non-configured) logging processors.
      Parameters:
      processors - logging processors
      Returns:
      updated builder instance
      See Also:

    • addProcessors

      public BUILDER addProcessors(List<? extends io.opentelemetry.sdk.logs.LogRecordProcessor> processors)
      Pre-constructed (non-configured) logging processors.
      Parameters:
      processors - logging processors
      Returns:
      updated builder instance
      See Also:

    • addProcessor

      public BUILDER addProcessor(io.opentelemetry.sdk.logs.LogRecordProcessor processor)
      Pre-constructed (non-configured) logging processors.
      Parameters:
      processor - add single logging processors
      Returns:
      updated builder instance
      See Also:

    • clearAttributes

      public BUILDER clearAttributes()
      Clear existing value of attributes.
      Returns:
      updated builder instance
      See Also:

    • attributes

      public BUILDER attributes(io.opentelemetry.api.common.AttributesBuilder attributes)
      Name/value pairs passed to OpenTelemetry.
      Parameters:
      attributes - typed attribute settings
      Returns:
      updated builder instance
      See Also:

    • enabled

      public Optional<Boolean> enabled()
      Whether the OpenTelemetry logger should be enabled. (Passed to OpenTelemetry.)
      Returns:
      true if the OpenTelemetry logger should be enabled, false otherwise

    • minimumSeverity

      public Optional<io.opentelemetry.api.logs.Severity> minimumSeverity()
      Minimum severity level of log records to process.
      Returns:
      minimum severity level

    • traceBased

      public Optional<Boolean> traceBased()
      Whether to include only log records from traces which are sampled. Defaults to the OpenTelemetry default.
      Returns:
      whether to restrict exported log records to only those from sampled traces

    • logLimits

      public Optional<io.opentelemetry.sdk.logs.LogLimits> logLimits()
      Log limits to apply to log transmission.
      Returns:
      log limits

    • processors

      public List<io.opentelemetry.sdk.logs.LogRecordProcessor> processors()
      Pre-constructed (non-configured) logging processors.
      Returns:
      logging processors

    • attributes

      public Optional<io.opentelemetry.api.common.AttributesBuilder> attributes()
      Name/value pairs passed to OpenTelemetry.
      Returns:
      typed attribute settings

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance