Enum Class SamplerType

java.lang.Object
java.lang.Enum<SamplerType>
io.helidon.telemetry.otelconfig.SamplerType
All Implemented Interfaces:
Serializable, Comparable<SamplerType>, Constable

public enum SamplerType extends Enum<SamplerType>
Sampler types valid for OpenTelemetry tracing.

This enum intentionally omits jaeger-remote as that requires an additional library. Users who want to use that sampler can add the dependency themselves and prepare the OpenTelemetry objects explicitly rather than using this builder.

Helidon recognizes the string values as documented in the OpenTelemetry documentation Properties: traces; Properties for sampler.

  • Enum Constant Details

    • ALWAYS_ON

      public static final SamplerType ALWAYS_ON
      Always on sampler.
    • ALWAYS_OFF

      public static final SamplerType ALWAYS_OFF
      Always off sampler.
    • TRACEIDRATIO

      public static final SamplerType TRACEIDRATIO
      Trace ID ratio-based sampler.
    • PARENTBASED_ALWAYS_ON

      public static final SamplerType PARENTBASED_ALWAYS_ON
      Parent-based always-on sampler.
    • PARENTBASED_ALWAYS_OFF

      public static final SamplerType PARENTBASED_ALWAYS_OFF
      Parent-based always-off sampler.
    • PARENTBASED_TRACEIDRATIO

      public static final SamplerType PARENTBASED_TRACEIDRATIO
      Parent-based trace ID ration-based sampler.
  • Method Details

    • values

      public static SamplerType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static SamplerType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null