Package io.opentelemetry.sdk.autoconfigure.spi.traces

Interface ConfigurableSamplerProvider

public interface ConfigurableSamplerProvider
A service provider interface (SPI) for providing additional samplers that can be used with the autoconfigured SDK. If the otel.traces.sampler property contains a value equal to what is returned by getName(), the sampler returned by createSampler(ConfigProperties) will be enabled and added to the SDK.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.opentelemetry.sdk.trace.samplers.Sampler
    createSampler(ConfigProperties config)
    Returns a Sampler that can be registered to OpenTelemetry by providing the property value specified by getName().
    String
    getName()
    Returns the name of this sampler, which can be specified with the otel.traces.sampler property to enable it.

  • Method Details

    • createSampler

      io.opentelemetry.sdk.trace.samplers.Sampler createSampler(ConfigProperties config)
      Returns a Sampler that can be registered to OpenTelemetry by providing the property value specified by getName().

    • getName

      String getName()
      Returns the name of this sampler, which can be specified with the otel.traces.sampler property to enable it. The name returned should NOT be the same as any other exporter name. If the name does conflict with another exporter name, the resulting behavior is undefined and it is explicitly unspecified which exporter will actually be used.