Module io.helidon.webserver.observe
Package io.helidon.webserver.observe.spi

Interface ObserveProvider

All Superinterfaces:
ConfiguredProvider<Observer>, ConfiguredProvider<Observer>
All Known Implementing Classes:
ConfigObserveProvider, HealthObserveProvider, InfoObserveProvider, LogObserveProvider, MetricsObserveProvider, TracingObserveProvider
public interface ObserveProvider extends ConfiguredProvider<Observer>
ServiceLoader provider interface for observability services.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    configKey()
    Configuration key of this provider.
    default String
    type()
    Type of this observe provider, to map to Observer when explicitly configured by user (so we do not duplicate observers).

    Methods inherited from interface io.helidon.config.ConfiguredProvider

    create, create

  • Method Details

    • configKey

      String configKey()
      Configuration key of this provider. The following keys must be honored by Observe support:
      • enabled - enable/disable the service
      • endpoint - endpoint, if starts with / then absolute, otherwise relative to observe endpoint
      • cors - CORS setup for this endpoint
      Specified by:
      configKey in interface ConfiguredProvider<Observer>
      Specified by:
      configKey in interface ConfiguredProvider<Observer>
      Returns:
      configuration key of this provider (such as health)

    • type

      default String type()
      Type of this observe provider, to map to Observer when explicitly configured by user (so we do not duplicate observers).
      Returns:
      type of this observer, defaults to configKey()