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

Interface OpenTelemetryConfig

All Superinterfaces:
Prototype.Api, Prototype.Factory<HelidonOpenTelemetry>
All Known Implementing Classes:
OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl
public interface OpenTelemetryConfig extends Prototype.Api
OpenTelemetry settings.
See Also:

  • Method Details

    • builder

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

    • builder

      static OpenTelemetryConfig.Builder builder(OpenTelemetryConfig 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 OpenTelemetryConfig 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 OpenTelemetryConfig 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 OpenTelemetryConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • service

      String service()
      Service name used in sending telemetry data to the collector.
      Returns:
      service name

    • enabled

      boolean enabled()
      Whether the OpenTelemetry support is enabled.
      Returns:
      true if enabled; false otherwise

    • global

      boolean global()
      Whether the OpenTelemetry instance created from this configuration should be made the global one.
      Returns:
      true if the configured instance should be made global; false otherwise

    • propagators

      List<io.opentelemetry.context.propagation.TextMapPropagator> propagators()
      OpenTelemetry TextMapPropagator instances added explicitly by the app.

      Default: "tracecontext,baggage".

      Returns:
      propagators
      See Also:

    • tracing

      Optional<OpenTelemetryTracingConfig> tracing()
      OpenTelemetry tracing settings.
      Returns:
      tracing settings

    • metrics

      Optional<OpenTelemetryMetricsConfig> metrics()
      OpenTelemetry metrics settings.
      Returns:
      metrics settings

    • logging

      Optional<OpenTelemetryLoggingConfig> logging()
      OpenTelemetry logging settings.
      Returns:
      logging settings

    • openTelemetry

      io.opentelemetry.api.OpenTelemetry openTelemetry()
      The OpenTelemetry instance to use for telemetry.

      Typically, this value will be the OpenTelemetry SDK instance created using this configuration, but if some other code (such as the OpenTelemetry agent) has already set the OTel global instance, this value will be that global instance.

      Returns:
      the OpenTelemetry instance