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

Interface ObserveFeatureConfig

All Superinterfaces:
Prototype.Api, Prototype.Factory<ObserveFeature>
All Known Implementing Classes:
ObserveFeatureConfig.BuilderBase.ObserveFeatureConfigImpl
public interface ObserveFeatureConfig extends Prototype.Api
Configuration for observability feature itself.
See Also:

  • Method Details

    • builder

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

    • builder

      static ObserveFeatureConfig.Builder builder(ObserveFeatureConfig 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 ObserveFeatureConfig 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

      static ObserveFeatureConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • cors

      CrossOriginConfig cors()
      Cors support inherited by each observe provider, unless explicitly configured.
      Returns:
      cors support to use

    • enabled

      boolean enabled()
      Whether the observe support is enabled.
      Returns:
      false to disable observe feature

    • endpoint

      String endpoint()
      Root endpoint to use for observe providers. By default, all observe endpoint are under this root endpoint.

      Example:
      If root endpoint is /observe (the default), and default health endpoint is health (relative), health endpoint would be /observe/health.

      Returns:
      endpoint to use

    • weight

      double weight()
      Change the weight of this feature. This may change the order of registration of this feature. By default, observability weight is 80.0 so it is registered after routing.
      Returns:
      weight to use

    • observers

      List<Observer> observers()
      Observers to use with this observe features. Each observer type is registered only once, unless it uses a custom name (default name is the same as the type).
      Returns:
      list of observers to use in this feature

    • config

      Optional<Config> config()
      Configuration of the observe feature, if present.
      Returns:
      config node of the feature

    • sockets

      List<String> sockets()
      Sockets the observability endpoint should be exposed on. If not defined, defaults to the default socket ("@default". Each observer may have its own configuration of sockets that are relevant to it, this only controls the endpoints!
      Returns:
      list of sockets to register observe endpoint on

    • name

      String name()
      Name of this instance.
      Returns:
      instance name