Module io.helidon.nima.observe
Package io.helidon.nima.observe.spi

Interface ObserveProvider

public interface ObserveProvider
ServiceLoader provider interface for observability services.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    configKey()
    Configuration key of this provider.
    String
    defaultEndpoint()
    Default endpoint of this provider.
    void
    register(io.helidon.config.Config config, String componentPath, HttpRouting.Builder routing)
    Register the provider's services and handlers to the routing builder.

  • Method Details

    • configKey

      String configKey()
      Configuration key of this provider. The following keys are reserved by Observe support:
      • enabled - enable/disable the service
      • endpoint - endpoint, if starts with / then absolute, otherwise relative to observe endpoint
      Returns:
      configuration key of this provider (such as health)

    • defaultEndpoint

      String defaultEndpoint()
      Default endpoint of this provider. To define a relative path, do not include forward slash (such as health would resolve into /observe/health).
      Returns:
      default endpoint under /observe

    • register

      void register(io.helidon.config.Config config, String componentPath, HttpRouting.Builder routing)
      Register the provider's services and handlers to the routing builder. The component MUST honor the provided component path.
      Parameters:
      config - configuration of this provider
      componentPath - component path to register under (such as /observe/health, based on configured endpoint and defaultEndpoint())
      routing - routing builder