Package com.vaadin.observability

Interface ObservabilityClientConfigurer

All Superinterfaces:
Serializable
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ObservabilityClientConfigurer extends Serializable
Configurator for front-end observability. Implementors of this class can configure the behaviour of the front-end observability for a UI instance, representing a single browser window or tab. The configurator is executed during UI initialization, before the navigation to the view happens. At this stage the VaadinService is fully initialized and the HTTP request is available and can be accessed through the VaadinRequest.getCurrent() method. Configurator instances are by default discovered and instantiated using ServiceLoader. This means that all implementations must have a zero-argument constructor and the fully qualified name of the implementation class must be listed on a separate line in a META-INF/services/com.vaadin.observability.ObservabilityClientConfigurer file present in the jar file containing the implementation class.

Integrations for specific runtime environments, such as OSGi or Spring, might also provide other ways of discovering listeners.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(ObservabilityClientConfiguration config)
    Configures front-end observability for a UI instance.

  • Method Details

    • configure

      void configure(ObservabilityClientConfiguration config)
      Configures front-end observability for a UI instance. By default, all instrumentations are active.
      Parameters:
      config - configuration instance to tune observability settings.