Skip to content

Commit 35fcc32

Browse files
westarlewestarle
committed
test: Add end-to-end integration test for trace propagation
1 parent 0d220c9 commit 35fcc32

File tree

2 files changed

+263
-0
lines changed

2 files changed

+263
-0
lines changed

‎sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTracePropagationInterceptor.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public class GrpcTracePropagationInterceptor implements ClientInterceptor {
5959
isAvailable = true;
6060
} catch (ClassNotFoundException e) {
6161
// OpenTelemetry API is not available
62+
e.printStackTrace();
6263
}
6364
IS_OPENTELEMETRY_AVAILABLE = isAvailable;
6465
}

‎sdk-platform-java/java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracePropagation.java‎

Lines changed: 262 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,262 @@
1+
/*
2+
* Copyright 2026 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.showcase.v1beta1.it;
18+
19+
import static com.google.common.truth.Truth.assertThat;
20+
21+
import com.google.api.gax.httpjson.ApiMethodDescriptor;
22+
import com.google.api.gax.httpjson.ForwardingHttpJsonClientCall;
23+
import com.google.api.gax.httpjson.ForwardingHttpJsonClientCallListener;
24+
import com.google.api.gax.httpjson.HttpJsonCallOptions;
25+
import com.google.api.gax.httpjson.HttpJsonChannel;
26+
import com.google.api.gax.httpjson.HttpJsonClientCall;
27+
import com.google.api.gax.httpjson.HttpJsonClientInterceptor;
28+
import com.google.api.gax.httpjson.HttpJsonMetadata;
29+
import com.google.api.gax.tracing.SpanTracerFactory;
30+
import com.google.common.collect.ImmutableList;
31+
import com.google.showcase.v1beta1.EchoClient;
32+
import com.google.showcase.v1beta1.EchoRequest;
33+
import com.google.showcase.v1beta1.EchoSettings;
34+
import com.google.showcase.v1beta1.it.util.TestClientInitializer;
35+
import io.grpc.CallOptions;
36+
import io.grpc.Channel;
37+
import io.grpc.ClientCall;
38+
import io.grpc.ClientInterceptor;
39+
import io.grpc.ForwardingClientCall;
40+
import io.grpc.ForwardingClientCallListener;
41+
import io.grpc.Metadata;
42+
import io.grpc.MethodDescriptor;
43+
import io.opentelemetry.api.GlobalOpenTelemetry;
44+
import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
45+
import io.opentelemetry.context.propagation.ContextPropagators;
46+
import io.opentelemetry.sdk.OpenTelemetrySdk;
47+
import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;
48+
import io.opentelemetry.sdk.trace.SdkTracerProvider;
49+
import io.opentelemetry.sdk.trace.data.SpanData;
50+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
51+
import java.util.List;
52+
import java.util.Map;
53+
import java.util.concurrent.TimeUnit;
54+
import org.junit.jupiter.api.AfterAll;
55+
import org.junit.jupiter.api.BeforeAll;
56+
import org.junit.jupiter.api.BeforeEach;
57+
import org.junit.jupiter.api.Test;
58+
59+
class ITOtelTracePropagation {
60+
private static final Metadata.Key<String> TRACEPARENT_GRPC_HEADER_KEY =
61+
Metadata.Key.of("traceparent", Metadata.ASCII_STRING_MARSHALLER);
62+
private static final String TRACEPARENT_HTTP_HEADER_KEY = "traceparent";
63+
64+
private static InMemorySpanExporter spanExporter;
65+
private static OpenTelemetrySdk openTelemetrySdk;
66+
67+
private static class GrpcResponseCapturingClientInterceptor implements ClientInterceptor {
68+
private Metadata responseHeaders;
69+
70+
@Override
71+
public <RequestT, ResponseT> ClientCall<RequestT, ResponseT> interceptCall(
72+
MethodDescriptor<RequestT, ResponseT> method, final CallOptions callOptions, Channel next) {
73+
ClientCall<RequestT, ResponseT> call = next.newCall(method, callOptions);
74+
return new ForwardingClientCall.SimpleForwardingClientCall<RequestT, ResponseT>(call) {
75+
@Override
76+
public void start(ClientCall.Listener<ResponseT> responseListener, Metadata headers) {
77+
ClientCall.Listener<ResponseT> forwardingResponseListener =
78+
new ForwardingClientCallListener.SimpleForwardingClientCallListener<ResponseT>(responseListener) {
79+
@Override
80+
public void onHeaders(Metadata headers) {
81+
responseHeaders = headers;
82+
super.onHeaders(headers);
83+
}
84+
};
85+
super.start(forwardingResponseListener, headers);
86+
}
87+
};
88+
}
89+
}
90+
91+
private static class HttpJsonResponseCapturingClientInterceptor implements HttpJsonClientInterceptor {
92+
private HttpJsonMetadata responseHeaders;
93+
94+
@Override
95+
public <RequestT, ResponseT> HttpJsonClientCall<RequestT, ResponseT> interceptCall(
96+
ApiMethodDescriptor<RequestT, ResponseT> method,
97+
HttpJsonCallOptions callOptions,
98+
HttpJsonChannel next) {
99+
HttpJsonClientCall<RequestT, ResponseT> call = next.newCall(method, callOptions);
100+
return new ForwardingHttpJsonClientCall.SimpleForwardingHttpJsonClientCall<
101+
RequestT, ResponseT>(call) {
102+
@Override
103+
public void start(Listener<ResponseT> responseListener, HttpJsonMetadata requestHeaders) {
104+
Listener<ResponseT> forwardingResponseListener =
105+
new ForwardingHttpJsonClientCallListener.SimpleForwardingHttpJsonClientCallListener<
106+
ResponseT>(responseListener) {
107+
@Override
108+
public void onHeaders(HttpJsonMetadata headers) {
109+
responseHeaders = headers;
110+
super.onHeaders(headers);
111+
}
112+
113+
@Override
114+
public void onMessage(ResponseT message) {
115+
super.onMessage(message);
116+
}
117+
118+
@Override
119+
public void onClose(int statusCode, HttpJsonMetadata trailers) {
120+
super.onClose(statusCode, trailers);
121+
}
122+
};
123+
super.start(forwardingResponseListener, requestHeaders);
124+
}
125+
};
126+
}
127+
}
128+
129+
private static GrpcResponseCapturingClientInterceptor grpcInterceptor;
130+
private static HttpJsonResponseCapturingClientInterceptor httpJsonInterceptor;
131+
132+
private static EchoClient grpcClient;
133+
private static EchoClient httpJsonClient;
134+
135+
@BeforeAll
136+
static void setup() throws Exception {
137+
spanExporter = InMemorySpanExporter.create();
138+
139+
SdkTracerProvider tracerProvider =
140+
SdkTracerProvider.builder()
141+
.addSpanProcessor(SimpleSpanProcessor.create(spanExporter))
142+
.build();
143+
144+
openTelemetrySdk =
145+
OpenTelemetrySdk.builder()
146+
.setTracerProvider(tracerProvider)
147+
.setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
148+
.buildAndRegisterGlobal();
149+
150+
SpanTracerFactory tracingFactory = new SpanTracerFactory(openTelemetrySdk);
151+
152+
// Create gRPC Interceptor and Client
153+
grpcInterceptor = new GrpcResponseCapturingClientInterceptor();
154+
grpcClient =
155+
TestClientInitializer.createGrpcEchoClientOpentelemetry(
156+
tracingFactory,
157+
EchoSettings.defaultGrpcTransportProviderBuilder()
158+
.setChannelConfigurator(io.grpc.ManagedChannelBuilder::usePlaintext)
159+
.setInterceptorProvider(() -> ImmutableList.of(grpcInterceptor))
160+
.build());
161+
162+
// Create HttpJson Interceptor and Client
163+
httpJsonInterceptor = new HttpJsonResponseCapturingClientInterceptor();
164+
EchoSettings httpJsonEchoSettings =
165+
EchoSettings.newHttpJsonBuilder()
166+
.setCredentialsProvider(com.google.api.gax.core.NoCredentialsProvider.create())
167+
.setTransportChannelProvider(
168+
EchoSettings.defaultHttpJsonTransportProviderBuilder()
169+
.setEndpoint(TestClientInitializer.DEFAULT_HTTPJSON_ENDPOINT)
170+
.setInterceptorProvider(() -> ImmutableList.of(httpJsonInterceptor))
171+
.build())
172+
.build();
173+
174+
com.google.showcase.v1beta1.stub.EchoStubSettings echoStubSettings =
175+
(com.google.showcase.v1beta1.stub.EchoStubSettings)
176+
httpJsonEchoSettings.getStubSettings().toBuilder()
177+
.setTracerFactory(tracingFactory)
178+
.build();
179+
com.google.showcase.v1beta1.stub.EchoStub stub = echoStubSettings.createStub();
180+
httpJsonClient = EchoClient.create(stub);
181+
}
182+
183+
@BeforeEach
184+
void cleanUp() {
185+
spanExporter.reset();
186+
grpcInterceptor.responseHeaders = null;
187+
httpJsonInterceptor.responseHeaders = null;
188+
}
189+
190+
@AfterAll
191+
static void tearDown() throws InterruptedException {
192+
grpcClient.close();
193+
httpJsonClient.close();
194+
195+
grpcClient.awaitTermination(TestClientInitializer.AWAIT_TERMINATION_SECONDS, TimeUnit.SECONDS);
196+
httpJsonClient.awaitTermination(
197+
TestClientInitializer.AWAIT_TERMINATION_SECONDS, TimeUnit.SECONDS);
198+
199+
if (openTelemetrySdk != null) {
200+
openTelemetrySdk.close();
201+
}
202+
GlobalOpenTelemetry.resetForTest();
203+
}
204+
205+
@Test
206+
void testTracePropagation_grpc() {
207+
EchoRequest request = EchoRequest.newBuilder().setContent("test-grpc-propagation").build();
208+
grpcClient.echo(request);
209+
210+
List<SpanData> spans = spanExporter.getFinishedSpanItems();
211+
assertThat(spans).isNotEmpty();
212+
213+
SpanData attemptSpan =
214+
spans.stream()
215+
.filter(span -> span.getName().equals("google.showcase.v1beta1.Echo/Echo"))
216+
.findFirst()
217+
.orElseThrow(() -> new AssertionError("Attempt span not found"));
218+
219+
String expectedTraceId = attemptSpan.getSpanContext().getTraceId();
220+
String expectedSpanId = attemptSpan.getSpanContext().getSpanId();
221+
String expectedTraceparent = "00-" + expectedTraceId + "-" + expectedSpanId + "-01";
222+
223+
String headerValue = grpcInterceptor.responseHeaders.get(TRACEPARENT_GRPC_HEADER_KEY);
224+
assertThat(headerValue).isNotNull();
225+
assertThat(headerValue).isEqualTo(expectedTraceparent);
226+
}
227+
228+
@Test
229+
void testTracePropagation_httpjson() {
230+
EchoRequest request = EchoRequest.newBuilder().setContent("test-http-propagation").build();
231+
httpJsonClient.echo(request);
232+
233+
List<SpanData> spans = spanExporter.getFinishedSpanItems();
234+
assertThat(spans).isNotEmpty();
235+
236+
// The T4 CLIENT span generated by ApiTracer (SpanTracer)
237+
SpanData attemptSpan =
238+
spans.stream()
239+
.filter(span -> span.getName().equals("POST v1beta1/echo:echo"))
240+
.findFirst()
241+
.orElseThrow(() -> new AssertionError("Attempt span not found"));
242+
243+
String expectedTraceId = attemptSpan.getSpanContext().getTraceId();
244+
String expectedSpanId = attemptSpan.getSpanContext().getSpanId();
245+
String expectedTraceparent = "00-" + expectedTraceId + "-" + expectedSpanId + "-01";
246+
247+
assertThat(httpJsonInterceptor.responseHeaders).isNotNull();
248+
Map<String, Object> headers = httpJsonInterceptor.responseHeaders.getHeaders();
249+
String expectedHttpHeaderKey = "x-showcase-request-" + TRACEPARENT_HTTP_HEADER_KEY;
250+
assertThat(headers).containsKey(expectedHttpHeaderKey);
251+
252+
Object headerVal = headers.get(expectedHttpHeaderKey);
253+
if (headerVal instanceof List) {
254+
@SuppressWarnings("unchecked")
255+
List<String> traceparentHeaders = (List<String>) headerVal;
256+
assertThat(traceparentHeaders).hasSize(1);
257+
assertThat(traceparentHeaders.get(0)).isEqualTo(expectedTraceparent);
258+
} else {
259+
assertThat(String.valueOf(headerVal)).isEqualTo(expectedTraceparent);
260+
}
261+
}
262+
}

0 commit comments

Comments
 (0)