Package io.opentelemetry.sdk.testing.junit4

Class OpenTelemetryRule

java.lang.Object

org.junit.rules.ExternalResource

io.opentelemetry.sdk.testing.junit4.OpenTelemetryRule

All Implemented Interfaces:

org.junit.rules.TestRule

public final class OpenTelemetryRule
extends org.junit.rules.ExternalResource

A JUnit4 rule which sets up the OpenTelemetrySdk for testing, resetting state between tests. This rule cannot be used with ClassRule.

 // public class CoolTest {
 //   @Rule public OpenTelemetryExtension otelTesting = OpenTelemetryExtension.create();
 //
 //   private Tracer tracer;
 //   private Meter meter;
 //
 //   @Before
 //   public void setUp() {
 //     tracer = otelTesting.getOpenTelemetry().getTracer("test");
 //     meter = otelTesting.getOpenTelemetry().getMeter("test");
 //   }
 //
 //   @Test
 //   public void test() {
 //     tracer.spanBuilder("name").startSpan().end();
 //     assertThat(otelTesting.getSpans()).containsExactly(expected);
 //
 //     LongCounter counter = meter.counterBuilder("counter-name").build();
 //     counter.add(1);
 //     assertThat(otelTesting.getMetrics()).satisfiesExactlyInAnyOrder(metricData -> {});
 //   }
 // }
 

Method Summary

Modifier and Type	Method	Description
protected void	after()
protected void	before()
void	clearMetrics()	Clears all registered metric instruments, such that getMetrics() is empty.
void	clearSpans()	Clears the collected exported SpanData.
static OpenTelemetryRule	create()	Returns a OpenTelemetryRule with a default SDK initialized with an in-memory span exporter and W3C trace context propagation.
List<io.opentelemetry.sdk.metrics.data.MetricData>	getMetrics()	Returns the current MetricData in AggregationTemporality.CUMULATIVE format.
io.opentelemetry.api.OpenTelemetry	getOpenTelemetry()	Returns the OpenTelemetrySdk created by this extension.
List<io.opentelemetry.sdk.trace.data.SpanData>	getSpans()	Returns all the exported SpanData so far.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static OpenTelemetryRule create()

Returns a OpenTelemetryRule with a default SDK initialized with an in-memory span exporter and W3C trace context propagation.

getOpenTelemetry

public io.opentelemetry.api.OpenTelemetry getOpenTelemetry()

Returns the OpenTelemetrySdk created by this extension.

getSpans

public List<io.opentelemetry.sdk.trace.data.SpanData> getSpans()

Returns all the exported SpanData so far.

getMetrics

public List<io.opentelemetry.sdk.metrics.data.MetricData> getMetrics()

Returns the current MetricData in AggregationTemporality.CUMULATIVE format.

Since:

1.15.0

clearSpans

public void clearSpans()

Clears the collected exported SpanData. Consider making your test smaller instead of manually clearing state using this method.

clearMetrics

public void clearMetrics()

Clears all registered metric instruments, such that getMetrics() is empty.

Since:

1.15.0

before

protected void before()

Overrides:

before in class org.junit.rules.ExternalResource

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource