Package org.jboss.as.test.shared.observability.containers

Class OpenTelemetryCollectorContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.jboss.as.test.shared.observability.containers.BaseContainer<OpenTelemetryCollectorContainer>

org.jboss.as.test.shared.observability.containers.OpenTelemetryCollectorContainer

All Implemented Interfaces:

AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<OpenTelemetryCollectorContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class OpenTelemetryCollectorContainer
extends BaseContainer<OpenTelemetryCollectorContainer>

Author:

Jason Lee, Radoslav Husar

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field	Description
static final int	HEALTH_CHECK_PORT
static final String	IMAGE_NAME
static final String	IMAGE_VERSION
static final String	OTEL_COLLECTOR_CONFIG_YAML
static final int	OTLP_GRPC_PORT
static final int	OTLP_HTTP_PORT
static final int	PROMETHEUS_PORT

Fields inherited from class org.jboss.as.test.shared.observability.containers.BaseContainer

loggingEnabled

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryCollectorContainer()

Method Summary

Modifier and Type	Method	Description
List<PrometheusMetric>	assertMetrics(Consumer<List<PrometheusMetric>> assertionConsumer)	Continually evaluates assertions provided in a consumer until the state obtained from the Prometheus endpoint matches the expected state or until a timeout elapses.
List<PrometheusMetric>	assertMetrics(Consumer<List<PrometheusMetric>> assertionConsumer, Duration timeout)	Variant of assertMetrics(Consumer) that can be configured with a timeout duration.
List<JaegerTrace>	assertTraces(String serviceName, Consumer<List<JaegerTrace>> assertionConsumer)	Continually evaluates assertions provided in a consumer until the state obtained from the Jaeger endpoint matches the expected state or until a timeout elapses.
List<JaegerTrace>	assertTraces(String serviceName, Consumer<List<JaegerTrace>> assertionConsumer, Duration timeout)	Variant of assertTraces(String, Consumer) that can be configured with a timeout duration.
List<PrometheusMetric>	fetchMetrics()	Fetches a current snapshot of the metrics from the Prometheus endpoint.
List<PrometheusMetric>	fetchMetrics(String nameToMonitor)	Deprecated. Use assertMetrics(Consumer) instead.
List<PrometheusMetric>	getMetricsByName(List<PrometheusMetric> metrics, String key)	Given a list of PrometheusMetric instances, return a sublist whose key matches key.
String	getOtlpGrpcEndpoint()
String	getOtlpHttpEndpoint()
String	getPrometheusUrl()
List<JaegerTrace>	getTraces(String serviceName)
void	start()
void	stop()

Methods inherited from class org.jboss.as.test.shared.observability.containers.BaseContainer

debugLog, debugLog

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, starting, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Details

IMAGE_NAME

public static final String IMAGE_NAME

See Also:

• Constant Field Values

IMAGE_VERSION

public static final String IMAGE_VERSION

See Also:

• Constant Field Values

OTLP_GRPC_PORT

public static final int OTLP_GRPC_PORT

See Also:

• Constant Field Values

OTLP_HTTP_PORT

public static final int OTLP_HTTP_PORT

See Also:

• Constant Field Values

PROMETHEUS_PORT

public static final int PROMETHEUS_PORT

See Also:

• Constant Field Values

HEALTH_CHECK_PORT

public static final int HEALTH_CHECK_PORT

See Also:

• Constant Field Values

OTEL_COLLECTOR_CONFIG_YAML

public static final String OTEL_COLLECTOR_CONFIG_YAML

See Also:

• Constant Field Values

Constructor Details

OpenTelemetryCollectorContainer

public OpenTelemetryCollectorContainer()

Method Details

start

public void start()

Specified by:

start in interface org.testcontainers.lifecycle.Startable

Overrides:

start in class org.testcontainers.containers.GenericContainer<OpenTelemetryCollectorContainer>

stop

public void stop()

Specified by:

stop in interface org.testcontainers.lifecycle.Startable

Overrides:

stop in class org.testcontainers.containers.GenericContainer<OpenTelemetryCollectorContainer>

getOtlpGrpcEndpoint

public String getOtlpGrpcEndpoint()

getOtlpHttpEndpoint

public String getOtlpHttpEndpoint()

getPrometheusUrl

public String getPrometheusUrl()

getTraces

public List<JaegerTrace> getTraces(String serviceName)
                            throws InterruptedException

Throws:

InterruptedException

getMetricsByName

public List<PrometheusMetric> getMetricsByName(List<PrometheusMetric> metrics,
 String key)

Given a list of PrometheusMetric instances, return a sublist whose key matches key. Note that the key name must match the Prometheus conventions (see here for details.

Parameters:

metrics - List of PrometheusMetrics to filter.

key - The name of the metric to find

Returns:

a sublist of metrics that matches key

assertTraces

public List<JaegerTrace> assertTraces(String serviceName,
 Consumer<List<JaegerTrace>> assertionConsumer)
                               throws InterruptedException

Continually evaluates assertions provided in a consumer until the state obtained from the Jaeger endpoint matches the expected state or until a timeout elapses. By default, polls the collector every second for 30 seconds. Returns snapshot of the Jaeger traces that passed the assertions; typically ignored.

Parameters:

assertionConsumer - consumer implementation that contains Assertions throwing AssertionError()s if the state obtained from the Jaeger endpoint does not match the expected state

Returns:

list of Jaeger traces; typically ignored.

Throws:

AssertionError - last AssertionError thrown by the provided assertionConsumer before timeout elapsed

InterruptedException - if interrupted

assertTraces

public List<JaegerTrace> assertTraces(String serviceName,
 Consumer<List<JaegerTrace>> assertionConsumer,
 Duration timeout)
                               throws InterruptedException

Variant of assertTraces(String, Consumer) that can be configured with a timeout duration.

Throws:

InterruptedException

assertMetrics

public List<PrometheusMetric> assertMetrics(Consumer<List<PrometheusMetric>> assertionConsumer)
                                     throws AssertionError,
InterruptedException

Continually evaluates assertions provided in a consumer until the state obtained from the Prometheus endpoint matches the expected state or until a timeout elapses. By default, polls the collector every second for 30 seconds. Typically otel.metric.export.interval must be adjusted to lower values since the default is attempting to push every 60 seconds, which is well above the default timeout of this method. Returns snapshot of the prometheus registry that passed the assertions; typically ignored.

Parameters:

assertionConsumer - consumer implementation that contains Assertions throwing AssertionError()s if the state obtained from the Prometheus endpoint does not match the expected state

Returns:

list of prometheus metrics; typically ignored.

Throws:

AssertionError - last AssertionError thrown by the provided assertionConsumer before timeout elapsed

InterruptedException - if interrupted

assertMetrics

public List<PrometheusMetric> assertMetrics(Consumer<List<PrometheusMetric>> assertionConsumer,
 Duration timeout)
                                     throws AssertionError,
InterruptedException

Variant of assertMetrics(Consumer) that can be configured with a timeout duration.

Throws:

AssertionError

InterruptedException

fetchMetrics

public List<PrometheusMetric> fetchMetrics()

Fetches a current snapshot of the metrics from the Prometheus endpoint.

Returns:

list of prometheus metrics

fetchMetrics

@Deprecated
public List<PrometheusMetric> fetchMetrics(String nameToMonitor)
                                    throws InterruptedException

Deprecated.

Use assertMetrics(Consumer) instead.

Throws:

InterruptedException