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

Interface OpenTelemetryLoggingConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
OpenTelemetryLoggingConfig.BuilderBase.OpenTelemetryLoggingConfigImpl
public interface OpenTelemetryLoggingConfig extends Prototype.Api
Configuration settings for OpenTelemetry logging. Optional values left unspecified in the configuration defer to the OpenTelemetry defaults.
See Also:

  • Method Details

    • builder

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

    • builder

      static OpenTelemetryLoggingConfig.Builder builder(OpenTelemetryLoggingConfig 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 OpenTelemetryLoggingConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      @Deprecated static OpenTelemetryLoggingConfig create(Config config)
      Deprecated.
      use create(io.helidon.config.Config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static OpenTelemetryLoggingConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • enabled

      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

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

    • traceBased

      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

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

    • processorConfigs

      List<ProcessorConfig> processorConfigs()
      Settings for logging processors.
      Returns:
      logging processors

    • processors

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

    • exporterConfigs

      Map<String,io.opentelemetry.sdk.logs.export.LogRecordExporter> exporterConfigs()
      Log record exporters.

      The key in the map is a unique name--of the user's choice--for the exporter config settings. The ProcessorConfig.exporters() config setting for a processor config specifies zero or more of these names to associate the exporters built from the exporter configs with the processor built from the processor config.

      Returns:
      log record exporters

    • attributes

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