Skip to content

chore: add showcase integration tests for OpenTelemetry parent context tracing #14535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jinseopkim0 wants to merge 6 commits into from
Open

chore: add showcase integration tests for OpenTelemetry parent context tracing #14535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f85641e
feat(gax): link T3 attempt spans to parent context and clean up on op…
jinseopkim0 Sep 25, 2026
62cc385
fix(gax): prevent new attempt spans after operation completion
jinseopkim0 Sep 25, 2026
a7219ae
fix(gax): use imported ReentrantLock
jinseopkim0 Sep 25, 2026
436ea49
chore(gax): add integration test for OpenTelemetry attempt span tracing
jinseopkim0 Sep 28, 2026
0415df5
chore: add showcase integration tests for OpenTelemetry parent contex…
jinseopkim0 Sep 28, 2026
7568af5
chore: fix showcase retry tests and prevent cache overwrite in ci
jinseopkim0 Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/showcase.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ jobs:
with:
java-version: 8
distribution: temurin
cache: maven
- run: java -version
- name: Parse showcase version
working-directory: java-showcase/gapic-showcase
Expand Down
193 changes: 193 additions & 0 deletions java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@
import io.grpc.MethodDescriptor;
import io.opentelemetry.api.GlobalOpenTelemetry;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.context.Scope;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
Expand Down Expand Up @@ -127,6 +130,7 @@ class ITOtelTracing {

private InMemorySpanExporter spanExporter;
private OpenTelemetrySdk openTelemetrySdk;
private Tracer tracer;

@BeforeEach
void setup() {
Expand All @@ -139,6 +143,7 @@ void setup() {

openTelemetrySdk =
OpenTelemetrySdk.builder().setTracerProvider(tracerProvider).buildAndRegisterGlobal();
tracer = openTelemetrySdk.getTracer("it-otel-tracing-test");
}

@AfterEach
Expand Down Expand Up @@ -218,6 +223,42 @@ void testTracing_successfulEcho_grpc() throws Exception {
}
}

@Test
void testTracing_successfulEcho_grpc_linkedToParentContext() throws Exception {
OpenTelemetryTracingFactory tracingFactory = new OpenTelemetryTracingFactory(openTelemetrySdk);

EchoSettings grpcEchoSettings = createEchoSettings(false);
EchoStub stub = createStubWithServiceName(grpcEchoSettings, tracingFactory);

try (EchoClient client = EchoClient.create(stub)) {
Span parentSpan = tracer.spanBuilder("application-parent-operation").startSpan();
try (Scope scope = parentSpan.makeCurrent()) {
client.echo(EchoRequest.newBuilder().setContent("tracing-test").build());
} finally {
parentSpan.end();
}

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertThat(spans).isNotEmpty();

SpanData attemptSpan =
spans.stream()
.filter(span -> span.getName().equals(SPAN_NAME_ECHO_GRPC))
.findFirst()
.orElseThrow(() -> new AssertionError("Attempt span not found"));
SpanData rootSpan =
spans.stream()
.filter(span -> span.getName().equals("application-parent-operation"))
.findFirst()
.orElseThrow(() -> new AssertionError("Parent span not found"));

assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
assertThat(attemptSpan.getParentSpanId()).isEqualTo(rootSpan.getSpanContext().getSpanId());
assertThat(attemptSpan.getSpanContext().getTraceId())
.isEqualTo(rootSpan.getSpanContext().getTraceId());
}
}

@Test
void testTracing_successfulEcho_httpjson() throws Exception {
OpenTelemetryTracingFactory tracingFactory = new OpenTelemetryTracingFactory(openTelemetrySdk);
Expand Down Expand Up @@ -305,6 +346,42 @@ void testTracing_successfulEcho_httpjson() throws Exception {
}
}

@Test
void testTracing_successfulEcho_httpjson_linkedToParentContext() throws Exception {
OpenTelemetryTracingFactory tracingFactory = new OpenTelemetryTracingFactory(openTelemetrySdk);

EchoSettings httpJsonEchoSettings = createEchoSettings(true);
EchoStub stub = createStubWithServiceName(httpJsonEchoSettings, tracingFactory);

try (EchoClient client = EchoClient.create(stub)) {
Span parentSpan = tracer.spanBuilder("application-parent-operation").startSpan();
try (Scope scope = parentSpan.makeCurrent()) {
client.echo(EchoRequest.newBuilder().setContent("tracing-test").build());
} finally {
parentSpan.end();
}

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertThat(spans).isNotEmpty();

SpanData attemptSpan =
spans.stream()
.filter(span -> span.getName().equals(SPAN_NAME_ECHO_HTTP))
.findFirst()
.orElseThrow(() -> new AssertionError("Attempt span not found"));
SpanData rootSpan =
spans.stream()
.filter(span -> span.getName().equals("application-parent-operation"))
.findFirst()
.orElseThrow(() -> new AssertionError("Parent span not found"));

assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
assertThat(attemptSpan.getParentSpanId()).isEqualTo(rootSpan.getSpanContext().getSpanId());
assertThat(attemptSpan.getSpanContext().getTraceId())
.isEqualTo(rootSpan.getSpanContext().getTraceId());
}
}

private long computeExpectedHttpJsonResponseSize(Message message)
throws InvalidProtocolBufferException {
String jsonPayload = com.google.protobuf.util.JsonFormat.printer().print(message);
Expand Down Expand Up @@ -441,6 +518,64 @@ void testTracing_retry_grpc() throws Exception {
assertThat(resendCounts).containsExactlyElementsIn(expectedCounts).inOrder();
}

@Test
void testTracing_retry_grpc_linkedToParentContext() throws Exception {
final int attempts = 5;
final StatusCode.Code statusCode = StatusCode.Code.UNAVAILABLE;
RetrySettings retrySettings =
RetrySettings.newBuilder()
.setTotalTimeout(org.threeten.bp.Duration.ofMillis(5000L))
.setMaxAttempts(attempts)
.build();

OpenTelemetryTracingFactory tracingFactory = new OpenTelemetryTracingFactory(openTelemetrySdk);

EchoSettings grpcEchoSettings = createEchoSettings(false);
EchoStubSettings.Builder grpcEchoSettingsBuilder =
(EchoStubSettings.Builder) grpcEchoSettings.getStubSettings().toBuilder();
grpcEchoSettingsBuilder
.echoSettings()
.setRetrySettings(retrySettings)
.setRetryableCodes(statusCode);
grpcEchoSettingsBuilder.setTracerFactory(tracingFactory);
EchoStub stub = new ExtendedEchoStubSettings(grpcEchoSettingsBuilder).createStub();
EchoClient grpcClient = EchoClient.create(stub);

EchoRequest echoRequest =
EchoRequest.newBuilder()
.setError(Status.newBuilder().setCode(statusCode.ordinal()).build())
.build();

Span parentSpan = tracer.spanBuilder("application-parent-operation").startSpan();
try (Scope scope = parentSpan.makeCurrent()) {
assertThrows(UnavailableException.class, () -> grpcClient.echo(echoRequest));
} finally {
parentSpan.end();
}

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertThat(spans).hasSize(attempts + 1);

SpanData rootSpan =
spans.stream()
.filter(span -> span.getName().equals("application-parent-operation"))
.findFirst()
.orElseThrow(() -> new AssertionError("Parent span not found"));

List<SpanData> attemptSpans =
spans.stream()
.filter(span -> span.getName().equals(SPAN_NAME_ECHO_GRPC))
.collect(java.util.stream.Collectors.toList());
assertThat(attemptSpans).hasSize(attempts);

for (SpanData attemptSpan : attemptSpans) {
assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
assertThat(attemptSpan.getParentSpanId()).isEqualTo(rootSpan.getSpanContext().getSpanId());
assertThat(attemptSpan.getSpanContext().getTraceId())
.isEqualTo(rootSpan.getSpanContext().getTraceId());
}
}

@Test
void testTracing_retry_httpjson() throws Exception {
final int attempts = 5;
Expand Down Expand Up @@ -519,6 +654,64 @@ void testTracing_retry_httpjson() throws Exception {
assertThat(resendCounts).containsExactlyElementsIn(expectedCounts).inOrder();
}

@Test
void testTracing_retry_httpjson_linkedToParentContext() throws Exception {
final int attempts = 5;
final StatusCode.Code statusCode = StatusCode.Code.INVALID_ARGUMENT;
RetrySettings retrySettings =
RetrySettings.newBuilder()
.setTotalTimeout(org.threeten.bp.Duration.ofMillis(5000L))
.setMaxAttempts(attempts)
.build();

OpenTelemetryTracingFactory tracingFactory = new OpenTelemetryTracingFactory(openTelemetrySdk);

EchoSettings httpJsonEchoSettings = createEchoSettings(true);
EchoStubSettings.Builder httpJsonEchoSettingsBuilder =
(EchoStubSettings.Builder) httpJsonEchoSettings.getStubSettings().toBuilder();
httpJsonEchoSettingsBuilder
.echoSettings()
.setRetrySettings(retrySettings)
.setRetryableCodes(statusCode);
httpJsonEchoSettingsBuilder.setTracerFactory(tracingFactory);
EchoStub stub = new ExtendedEchoStubSettings(httpJsonEchoSettingsBuilder).createStub();
EchoClient httpClient = EchoClient.create(stub);

EchoRequest echoRequest =
EchoRequest.newBuilder()
.setError(Status.newBuilder().setCode(statusCode.ordinal()).build())
.build();

Span parentSpan = tracer.spanBuilder("application-parent-operation").startSpan();
try (Scope scope = parentSpan.makeCurrent()) {
assertThrows(InvalidArgumentException.class, () -> httpClient.echo(echoRequest));
} finally {
parentSpan.end();
}

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertThat(spans).hasSize(attempts + 1);

SpanData rootSpan =
spans.stream()
.filter(span -> span.getName().equals("application-parent-operation"))
.findFirst()
.orElseThrow(() -> new AssertionError("Parent span not found"));

List<SpanData> attemptSpans =
spans.stream()
.filter(span -> span.getName().equals(SPAN_NAME_ECHO_HTTP))
.collect(java.util.stream.Collectors.toList());
assertThat(attemptSpans).hasSize(attempts);

for (SpanData attemptSpan : attemptSpans) {
assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
assertThat(attemptSpan.getParentSpanId()).isEqualTo(rootSpan.getSpanContext().getSpanId());
assertThat(attemptSpan.getSpanContext().getTraceId())
.isEqualTo(rootSpan.getSpanContext().getTraceId());
}
}

private SpanData getErrorSpan() {
List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertThat(spans).isNotEmpty();
Expand Down
Loading
Loading