Package io.quarkus.observability.devresource

Interface DevResourceLifecycleManager<T extends ContainerConfig>

All Superinterfaces:

QuarkusTestResourceLifecycleManager

public interface DevResourceLifecycleManager<T extends ContainerConfig>
extends 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

QuarkusTestResourceLifecycleManager.Context, 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)	Deduct current config from params.
T	config(ModulesConfiguration configuration)	Get resource's config from main observability configuration.
default Container<T>	container(T config)	Create container from config.
default Container<T>	container(T 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

METRICS

static final int METRICS

See Also:

• Constant Field Values

SCRAPER

static final int SCRAPER

See Also:

• Constant Field Values

GRAFANA

static final int GRAFANA

See Also:

• Constant Field Values

JAEGER

static final int JAEGER

See Also:

• Constant Field Values

OTEL

static final int OTEL

See Also:

• Constant Field Values

Method Details

config

T config(ModulesConfiguration configuration)

Get resource's config from main observability configuration.

Parameters:

configuration - main observability configuration

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,
 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)

Deduct current config from params. If port are too dynamic / configured, it's hard to deduct, 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).