Visitar URL original
feat(bigquery): add HTTP response attribute tracing by ldetmer · Pull Request #12109 · googleapis/google-cloud-java · GitHub
Skip to content

feat(bigquery): add HTTP response attribute tracing #12109

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

Merged
ldetmer merged 7 commits into from
Mar 19, 2026
Merged

feat(bigquery): add HTTP response attribute tracing #12109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d7852fa
feat: add HTTP response attribute tracing
ldetmer Mar 18, 2026
8964bb6
minor clean up
ldetmer Mar 18, 2026
0538c07
formatting
ldetmer Mar 18, 2026
9369e85
fixed how request content length is populated
ldetmer Mar 18, 2026
3ef80c6
add NPE check for request body
ldetmer Mar 18, 2026
4816521
added logic to handle encoded content
ldetmer Mar 19, 2026
8f64289
Merge branch 'main' into http-response-attributes
ldetmer Mar 19, 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
47 changes: 47 additions & 0 deletions ...uery/src/main/java/com/google/cloud/bigquery/telemetry/HttpTracingRequestInitializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,25 @@ public void initialize(HttpRequest request) throws IOException {
String host = request.getUrl().getHost();
int port = request.getUrl().getPort();
addInitialHttpAttributesToSpan(span, host, port);

HttpResponseInterceptor originalInterceptor = request.getResponseInterceptor();
request.setResponseInterceptor(
response -> {
addCommonResponseAttributesToSpan(request, response, span);

@blakeli0 blakeli0 Mar 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A general questions regarding the interceptors. Do we know if they runs on the same thread or a different thread? If it is a different thread, there might be a chance that the Span is already ended.

@ldetmer ldetmer Mar 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It runs on the same thread. The client uses a syncronous execute call from apiary. So it will always get intercepted, and processed before it returns to the client.

if (originalInterceptor != null) {
originalInterceptor.interceptResponse(response);
}
});

HttpUnsuccessfulResponseHandler originalHandler = request.getUnsuccessfulResponseHandler();
request.setUnsuccessfulResponseHandler(
(request1, response, supportsRetry) -> {
addCommonResponseAttributesToSpan(request1, response, span);
if (originalHandler != null) {
return originalHandler.handleResponse(request1, response, supportsRetry);
}
return false;
});
}

/** Add initial HTTP attributes to the existing active span */
Expand All @@ -89,4 +108,32 @@ private void addInitialHttpAttributesToSpan(Span span, String host, Integer port
}
// TODO add full sanitized url, url domain, request method
}

private static void addCommonResponseAttributesToSpan(
HttpRequest request, HttpResponse response, Span span) {
// We add request body size and update request method after we receive response as
// the data is not always available until after the http request execution
addRequestBodySizeToSpan(request, span);
span.setAttribute(HTTP_REQUEST_METHOD, request.getRequestMethod());
addResponseBodySizeToSpan(response, span);
span.setAttribute(HTTP_RESPONSE_STATUS_CODE, response.getStatusCode());
}

static void addRequestBodySizeToSpan(HttpRequest request, Span span) {
try {
if (request.getContent() != null && request.getEncoding() == null) {
span.setAttribute(HTTP_REQUEST_BODY_SIZE, request.getContent().getLength());
}
} catch (IOException e) {
// Ignore - body size not available
}
}

static void addResponseBodySizeToSpan(HttpResponse response, Span span) {
Long contentLength = response.getHeaders().getContentLength();
if (contentLength != null && contentLength > 0) {
span.setAttribute(HTTP_RESPONSE_BODY_SIZE, contentLength);
}
// TODO handle chunked responses
}
}
223 changes: 206 additions & 17 deletions .../src/test/java/com/google/cloud/bigquery/telemetry/HttpTracingRequestInitializerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,24 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.google.api.client.http.ByteArrayContent;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpEncoding;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpResponseException;
import com.google.api.client.http.HttpResponseInterceptor;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.HttpUnsuccessfulResponseHandler;
import com.google.api.client.http.LowLevelHttpRequest;
import com.google.api.client.http.LowLevelHttpResponse;
import com.google.api.client.testing.http.MockHttpTransport;
Expand Down Expand Up @@ -77,22 +85,23 @@ public void setUp() {
}

@Test
public void testRequestAttributesAreSetIfSpanExists() throws IOException {
HttpTransport transport = createTransport();
HttpRequest request = buildGetRequest(transport, initializer, BASE_URL);
public void testAllAttributesAreSetOnSuccessfulCall() throws IOException {
HttpResponseInterceptor originalInterceptor = mock(HttpResponseInterceptor.class);
HttpRequestInitializer delegateInitializer =
request -> request.setResponseInterceptor(originalInterceptor);
HttpTracingRequestInitializer tracingInitializer =
new HttpTracingRequestInitializer(delegateInitializer, tracer);
String responseContent = "{\"status\": \"ok\"}";
HttpTransport transport = createTransport(200, responseContent);
HttpContent requestContent =
ByteArrayContent.fromString("application/json", "{\"test\": \"data\"}");
HttpRequest request = buildPostRequest(transport, tracingInitializer, BASE_URL, requestContent);

HttpResponse response = request.execute();
response.disconnect();

// End the span before verifying exported spans, so it appears in the exporter
spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());

SpanData span = spans.get(0);
verifyGeneralSpanData(span);
verify(originalInterceptor, times(1)).interceptResponse(any(HttpResponse.class));
closeAndVerifySpanData(200, "POST", 16, requestContent.getLength());
}

@Test
Expand All @@ -103,14 +112,11 @@ public void testExistingParentAttributesAreNotAffectedByRequestAttributes() thro

HttpResponse response = request.execute();
response.disconnect();

// End the span before verifying exported spans, so it appears in the exporter
spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());

SpanData span = spans.get(0);
assertEquals("value", span.getAttributes().get(AttributeKey.stringKey("parent_attribute")));
}
Expand Down Expand Up @@ -152,14 +158,160 @@ public void testDelegateInitializerIsCalled() throws IOException {
verify(delegateInitializer, times(1)).initialize(any(HttpRequest.class));
}

@Test
public void testUnsuccessfulResponseHandlerSetsAttributesAndCallsOriginal() throws IOException {
HttpUnsuccessfulResponseHandler originalHandler = mock(HttpUnsuccessfulResponseHandler.class);
when(originalHandler.handleResponse(
any(HttpRequest.class), any(HttpResponse.class), anyBoolean()))
.thenReturn(false);
HttpRequestInitializer delegateInitializer =
request -> request.setUnsuccessfulResponseHandler(originalHandler);
HttpTracingRequestInitializer tracingInitializer =
new HttpTracingRequestInitializer(delegateInitializer, tracer);
String responseContent = "{\"error\": \"not found\"}";
HttpTransport transport = createTransport(404, responseContent);
HttpContent requestContent =
ByteArrayContent.fromString("application/json", "{\"test\": \"data\"}");
HttpRequest request = buildPostRequest(transport, tracingInitializer, BASE_URL, requestContent);

try {
request.execute();
} catch (HttpResponseException e) {
// Expected
}

verify(originalHandler, times(1))
.handleResponse(any(HttpRequest.class), any(HttpResponse.class), anyBoolean());
closeAndVerifySpanData(404, "POST", 16, responseContent.length());
}

@Test
public void testUnsuccessfulResponseHandlerSetsErrorIfNoOriginal() throws IOException {
HttpTracingRequestInitializer tracingInitializer =
new HttpTracingRequestInitializer(null, tracer);
HttpTransport transport = createTransport(401);
HttpRequest request = buildGetRequest(transport, tracingInitializer, BASE_URL);

try {
request.execute();
} catch (HttpResponseException e) {
// Expected
}

closeAndVerifySpanData(401, "GET", -1, -1);
}

@Test
public void testAddRequestBodySizeToSpan_ExceptionHandled() throws IOException {
HttpContent content = mock(HttpContent.class);
when(content.getLength()).thenThrow(new IOException("test"));
HttpTransport transport = createTransport();
HttpRequest request = buildPostRequest(transport, null, BASE_URL, content);

HttpTracingRequestInitializer.addRequestBodySizeToSpan(request, parentSpan);

spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
}

@Test
public void testAddRequestBodySizeToSpan_NullBody() throws IOException {
HttpTransport transport = createTransport();
HttpRequest request = buildPostRequest(transport, null, BASE_URL, null);

HttpTracingRequestInitializer.addRequestBodySizeToSpan(request, parentSpan);

spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
}

@Test
public void testAddRequestBodySizeToSpan_WithEncoding() throws IOException {
HttpTransport transport = createTransport();
HttpContent content = ByteArrayContent.fromString("application/json", "{\"test\": \"data\"}");
HttpRequest request = buildPostRequest(transport, null, BASE_URL, content);
request.setEncoding(mock(HttpEncoding.class));

HttpTracingRequestInitializer.addRequestBodySizeToSpan(request, parentSpan);

spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
}

@Test
public void testAddRequestBodySizeToSpan() throws IOException {
HttpTransport transport = createTransport();
HttpContent content = ByteArrayContent.fromString("application/json", "{\"test\": \"data\"}");
HttpRequest request = buildPostRequest(transport, null, BASE_URL, content);

HttpTracingRequestInitializer.addRequestBodySizeToSpan(request, parentSpan);

spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertEquals(
content.getLength(),
span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
}

@Test
public void testAddResponseBodySizeToSpan_NullLength() throws IOException {
HttpTransport transport =
createTransport(200, null); // Null response content means null Content-Length header
HttpRequest request = buildGetRequest(transport, null, BASE_URL);
HttpResponse response = request.execute();

HttpTracingRequestInitializer.addResponseBodySizeToSpan(response, parentSpan);

spanScope.close();
parentSpan.end();

List<SpanData> spans = spanExporter.getFinishedSpanItems();
assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_RESPONSE_BODY_SIZE));
}

private static HttpTransport createTransport() {
return createTransport(200, null);
}

private static HttpTransport createTransport(int statusCode) {
return createTransport(statusCode, null);
}

private static HttpTransport createTransport(int statusCode, String responseContent) {
return new MockHttpTransport() {
@Override
public LowLevelHttpRequest buildRequest(String method, String url) {
return new MockLowLevelHttpRequest() {
@Override
public LowLevelHttpResponse execute() {
return new MockLowLevelHttpResponse();
MockLowLevelHttpResponse response = new MockLowLevelHttpResponse();
response.setStatusCode(statusCode);
if (responseContent != null) {
response.setContent(responseContent);
response.addHeader("Content-Length", String.valueOf(responseContent.length()));
}
return response;
}
};
}
Expand All @@ -173,7 +325,25 @@ private static HttpRequest buildGetRequest(
return requestFactory.buildGetRequest(new GenericUrl(url));
}

private void verifyGeneralSpanData(SpanData span) {
private static HttpRequest buildPostRequest(
HttpTransport transport,
HttpRequestInitializer requestInitializer,
String url,
HttpContent content)
throws IOException {
HttpRequestFactory requestFactory = transport.createRequestFactory(requestInitializer);
return requestFactory.buildPostRequest(new GenericUrl(url), content);
}

private void closeAndVerifySpanData(
long responseCode, String method, long requestBodySize, long responseBodySize) {
// close span so it is available for verification
spanScope.close();
parentSpan.end();
List<SpanData> spans = spanExporter.getFinishedSpanItems();

assertEquals(1, spans.size());
SpanData span = spans.get(0);
assertEquals(SPAN_NAME, span.getName());
assertEquals(BIGQUERY_DOMAIN, span.getAttributes().get(BigQueryTelemetryTracer.SERVER_ADDRESS));
assertEquals(443, span.getAttributes().get(BigQueryTelemetryTracer.SERVER_PORT));
Expand All @@ -192,5 +362,24 @@ private void verifyGeneralSpanData(SpanData span) {
assertEquals(
HttpTracingRequestInitializer.HTTP_RPC_SYSTEM_NAME,
span.getAttributes().get(BigQueryTelemetryTracer.RPC_SYSTEM_NAME));
assertEquals(
responseCode,
span.getAttributes().get(HttpTracingRequestInitializer.HTTP_RESPONSE_STATUS_CODE));

@blakeli0 blakeli0 Mar 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is existing behavior, we can do it as a separate PR. But we should consider test one behavior (attribute) at a time. See Test One Thing At A Time and Keep Tests Focused.

assertEquals(
method, span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_METHOD));
if (requestBodySize >= 0) {
assertEquals(
requestBodySize,
span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
} else {
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_REQUEST_BODY_SIZE));
}
if (responseBodySize >= 0) {
assertEquals(
responseBodySize,
span.getAttributes().get(HttpTracingRequestInitializer.HTTP_RESPONSE_BODY_SIZE));
} else {
assertNull(span.getAttributes().get(HttpTracingRequestInitializer.HTTP_RESPONSE_BODY_SIZE));
}
}
}
Loading