Interface ObserveProvider

All Superinterfaces:
ConfiguredProvider<Observer>
All Known Implementing Classes:
ConfigObserveProvider, HealthObserveProvider, InfoObserveProvider, LogObserveProvider, MetricsObserveProvider, TracingObserveProvider
public interface ObserveProvider extends ConfiguredProvider<Observer>
Provider interface for observability services. Registry-managed applications discover providers through the owning ServiceRegistry; direct construction and backward compatibility use ServiceLoader.

  • 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 ConfiguredProvider

    create, create
    Modifier and Type
    Method
    Description
    Observer
    create(Config config, String name)
    Create a new instance from the configuration located on the provided node.
    default Observer
    create(Config config, String name, ServiceRegistry serviceRegistry)
    Create a new instance from configuration using services from the registry which owns the configured instance.

  • 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>
      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()