Package io.quarkus.observability.devresource

Interface DevResourceLifecycleManager<T extends io.quarkus.observability.common.config.ContainerConfig>

All Superinterfaces:
io.quarkus.test.common.QuarkusTestResourceLifecycleManager
public interface DevResourceLifecycleManager<T extends io.quarkus.observability.common.config.ContainerConfig> extends io.quarkus.test.common.QuarkusTestResourceLifecycleManager
Extends QuarkusTestResourceLifecycleManager so that classes implement both interfaces at the same time - simplifying testing.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.quarkus.test.common.QuarkusTestResourceLifecycleManager

    io.quarkus.test.common.QuarkusTestResourceLifecycleManager.Context, io.quarkus.test.common.QuarkusTestResourceLifecycleManager.TestInjector

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    GRAFANA
     
    static final int
    JAEGER
     
    static final int
    METRICS
     
    static final int
    OTEL
     
    static final int
    SCRAPER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    config(int privatePort, String host, int publicPort)
    Deduce current config from params.
    T
    config(io.quarkus.observability.common.config.ModulesConfiguration configuration)
    Deprecated.
    default T
    config(io.quarkus.observability.common.config.ModulesConfiguration configuration, ExtensionsCatalog catalog)
    Get resource's config from main observability configuration and extension catalog
    default Container<T>
    container(T config)
    Create container from config.
    default Container<T>
    container(T config, io.quarkus.observability.common.config.ModulesConfiguration root)
    Create container from config.
    default boolean
    enable()
    Should we enable / start this dev resource.
    default void
    initDev()
    Called even before QuarkusTestResourceLifecycleManager.start() so that the implementation can prepare itself to be used as dev resource (as opposed to test resource which uses a different init() method).

    Methods inherited from interface io.quarkus.test.common.QuarkusTestResourceLifecycleManager

    init, inject, inject, order, setContext, start, stop

  • Field Details

  • Method Details

    • config

      @Deprecated T config(io.quarkus.observability.common.config.ModulesConfiguration configuration)
      Deprecated.
      Get resource's config from main observability configuration.
      Parameters:
      configuration - main observability configuration
      Returns:
      module's config

    • config

      default T config(io.quarkus.observability.common.config.ModulesConfiguration configuration, ExtensionsCatalog catalog)
      Get resource's config from main observability configuration and extension catalog
      Parameters:
      configuration - main observability configuration
      catalog - observability catalog. If OpenTelemetry or Micrometer are enabled.
      Returns:
      module's config

    • enable

      default boolean enable()
      Should we enable / start this dev resource. e.g. we could already have actual service running Each impl should provide its own reason on why it disabled dev service.
      Returns:
      true if ok to start new dev service, false otherwise

    • container

      default Container<T> container(T config)
      Create container from config.
      Parameters:
      config - the config
      Returns:
      container id

    • container

      default Container<T> container(T config, io.quarkus.observability.common.config.ModulesConfiguration root)
      Create container from config.
      Parameters:
      config - the config
      root - the all modules config
      Returns:
      container id

    • config

      Map<String,String> config(int privatePort, String host, int publicPort)
      Deduce current config from params. If port are too dynamic / configured, it's hard to deduce, since configuration is not part of the devservice state. e.g. different ports then usual - Grafana UI is 3000, if you do not use 3000, it's hard or impossible to know which port belongs to certain property.
      Returns:
      A map of system properties that should be set for the running dev-mode app

    • initDev

      default void initDev()
      Called even before QuarkusTestResourceLifecycleManager.start() so that the implementation can prepare itself to be used as dev resource (as opposed to test resource which uses a different init() method).