From 2590f0e9f249b715e04c782765bd04b77107eade Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Thu, 22 Oct 2026 07:39:50 +0000 Subject: [PATCH 1/8] feat: add http.client.request.duration metric for HTTP requests --- .../StorageHttpMetricsInterceptor.java | 226 +++++++++++ .../google/cloud/storage/StorageOptions.java | 11 + .../cloud/storage/spi/v1/HttpStorageRpc.java | 4 +- .../StorageHttpMetricsInterceptorTest.java | 374 ++++++++++++++++++ 4 files changed, 614 insertions(+), 1 deletion(-) create mode 100644 java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java create mode 100644 java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java new file mode 100644 index 000000000000..9c50c5d7448c --- /dev/null +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -0,0 +1,226 @@ +/* + * Copyright 2026 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.cloud.storage; + +import com.google.api.client.http.GenericUrl; +import com.google.api.client.http.HttpExecuteInterceptor; +import com.google.api.client.http.HttpIOExceptionHandler; +import com.google.api.client.http.HttpRequest; +import com.google.api.client.http.HttpRequestInitializer; +import com.google.api.client.http.HttpResponseInterceptor; +import com.google.api.core.ApiClock; +import io.opentelemetry.api.common.AttributesBuilder; +import io.opentelemetry.context.Context; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicLong; +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * HTTP request initializer that records HTTP client metrics such as http.client.request.duration. + */ +final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { + + @Nullable private final HttpRequestInitializer delegate; + private final StorageClientMetrics metrics; + private final ApiClock clock; + @Nullable private final String defaultServerAddress; + + StorageHttpMetricsInterceptor( + @Nullable HttpRequestInitializer delegate, + StorageClientMetrics metrics, + ApiClock clock, + @Nullable String host) { + this.delegate = delegate; + this.metrics = metrics; + this.clock = clock; + this.defaultServerAddress = StorageOptions.extractServerAddress(host); + } + + @Override + public void initialize(HttpRequest request) throws java.io.IOException { + if (delegate != null) { + delegate.initialize(request); + } + if (metrics == null || metrics.getHttpClientRequestDuration() == null) { + return; + } + + HttpExecuteInterceptor existingExec = request.getInterceptor(); + HttpResponseInterceptor existingResp = request.getResponseInterceptor(); + HttpIOExceptionHandler existingIoHandler = request.getIOExceptionHandler(); + + AtomicLong startTimeNanos = new AtomicLong(clock.nanoTime()); + AtomicBoolean recorded = new AtomicBoolean(false); + + request.setInterceptor( + req -> { + if (existingExec != null) { + existingExec.intercept(req); + } + startTimeNanos.set(clock.nanoTime()); + recorded.set(false); + }); + + request.setResponseInterceptor( + response -> { + if (existingResp != null) { + existingResp.interceptResponse(response); + } + if (recorded.compareAndSet(false, true) + && metrics.getHttpClientRequestDuration() != null) { + double durationSeconds = + Math.max(0.0, (clock.nanoTime() - startTimeNanos.get()) / 1_000_000_000.0); + int statusCode = response.getStatusCode(); + String method = + request.getRequestMethod() != null ? request.getRequestMethod() : "UNKNOWN"; + String urlTemplate = extractUrlTemplate(request.getUrl()); + String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); + + AttributesBuilder attrBuilder = + metrics + .clientAttributesBuilder() + .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) + .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, (long) statusCode) + .put( + StorageClientMetrics.KEY_NETWORK_PATH, + StorageClientMetrics.NETWORK_PATH_CLOUDPATH) + .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) + .put( + StorageClientMetrics.KEY_SERVER_ADDRESS, + serverAddress != null ? serverAddress : "") + .put( + StorageClientMetrics.KEY_ERROR_TYPE, + statusCode >= 400 + ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) + : StorageErrorTypeMapper.STATUS_OK); + + metrics + .getHttpClientRequestDuration() + .record(durationSeconds, attrBuilder.build(), Context.current()); + } + }); + + request.setIOExceptionHandler( + (req, supportsRetry) -> { + if (recorded.compareAndSet(false, true) + && metrics.getHttpClientRequestDuration() != null) { + double durationSeconds = + Math.max(0.0, (clock.nanoTime() - startTimeNanos.get()) / 1_000_000_000.0); + String method = req.getRequestMethod() != null ? req.getRequestMethod() : "UNKNOWN"; + String urlTemplate = extractUrlTemplate(req.getUrl()); + String serverAddress = resolveServerAddress(req.getUrl(), defaultServerAddress); + + AttributesBuilder attrBuilder = + metrics + .clientAttributesBuilder() + .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) + .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, 0L) + .put( + StorageClientMetrics.KEY_NETWORK_PATH, + StorageClientMetrics.NETWORK_PATH_CLOUDPATH) + .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) + .put( + StorageClientMetrics.KEY_SERVER_ADDRESS, + serverAddress != null ? serverAddress : "") + .put( + StorageClientMetrics.KEY_ERROR_TYPE, + StorageErrorTypeMapper.STATUS_CONNECTIVITY); + + metrics + .getHttpClientRequestDuration() + .record(durationSeconds, attrBuilder.build(), Context.current()); + } + return existingIoHandler != null + && existingIoHandler.handleIOException(req, supportsRetry); + }); + } + + static String resolveServerAddress( + @Nullable GenericUrl url, @Nullable String defaultServerAddress) { + String host = url != null ? url.getHost() : null; + return (host != null && !host.isEmpty()) ? host : defaultServerAddress; + } + + static String extractUrlTemplate(@Nullable GenericUrl url) { + if (url == null) { + return "/"; + } + if (url.getFirst("upload_id") != null) { + return "/upload/storage/v1/b/{bucket}/o"; + } + String path = url.getRawPath(); + if (path == null || path.isEmpty()) { + return "/"; + } + if (path.length() > 1 && path.endsWith("/")) { + path = path.substring(0, path.length() - 1); + } + if (path.startsWith("/upload/storage/v1/b/")) { + return "/upload/storage/v1/b/{bucket}/o"; + } + if (path.startsWith("/download/storage/v1/b/")) { + return "/download/storage/v1/b/{bucket}/o/{object}"; + } + if (path.startsWith("/batch/storage/v1")) { + return "/batch/storage/v1"; + } + if (path.startsWith("/storage/v1/")) { + String rest = path.substring("/storage/v1/".length()); + String[] segments = rest.split("/"); + if (segments.length >= 2 && "b".equals(segments[0])) { + segments[1] = "{bucket}"; + if (segments.length >= 4 && "o".equals(segments[2])) { + segments[3] = "{object}"; + if (segments.length >= 6) { + if ("acl".equals(segments[4])) { + segments[5] = "{entity}"; + } else if ("copyTo".equals(segments[4]) || "rewriteTo".equals(segments[4])) { + if (segments.length >= 7 && "b".equals(segments[5])) { + segments[6] = "{destinationBucket}"; + } + if (segments.length >= 9 && "o".equals(segments[7])) { + segments[8] = "{destinationObject}"; + } + } else if ("moveTo".equals(segments[4]) + && "o".equals(segments[5]) + && segments.length >= 7) { + segments[6] = "{destinationObject}"; + } + } + } else if (segments.length >= 4) { + if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { + segments[3] = "{entity}"; + } else if ("notifications".equals(segments[2])) { + segments[3] = "{notification}"; + } + } + } else if (segments.length >= 2 && "projects".equals(segments[0])) { + segments[1] = "{project}"; + if (segments.length >= 4 && "hmacKeys".equals(segments[2])) { + segments[3] = "{accessId}"; + } + } + return "/storage/v1/" + String.join("/", segments); + } + String trimmed = path.startsWith("/") ? path.substring(1) : path; + if (trimmed.isEmpty()) { + return "/"; + } + String[] parts = trimmed.split("/", 2); + return parts.length == 1 ? "/{bucket}" : "/{bucket}/{object}"; + } +} diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java index 330be593875f..9ad129f50f3e 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java @@ -18,6 +18,7 @@ import static com.google.common.base.Preconditions.checkArgument; +import com.google.api.client.http.HttpRequestInitializer; import com.google.api.core.BetaApi; import com.google.api.core.InternalApi; import com.google.cloud.NoCredentials; @@ -518,6 +519,16 @@ private Attributes buildBaseMetricsAttributes(StorageClientMetrics metrics) { return builder.build(); } + @InternalApi + @Nullable + public HttpRequestInitializer decorateWithMetrics(@Nullable HttpRequestInitializer initializer) { + StorageClientMetrics metrics = getStorageClientMetrics(); + if (metrics == null) { + return initializer; + } + return new StorageHttpMetricsInterceptor(initializer, metrics, getClock(), getHost()); + } + @Nullable static String extractServerAddress(@Nullable String host) { if (host == null || host.trim().isEmpty()) { diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/HttpStorageRpc.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/HttpStorageRpc.java index ec7d8e02e411..930388f78572 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/HttpStorageRpc.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/spi/v1/HttpStorageRpc.java @@ -157,7 +157,9 @@ public HttpStorageRpc(StorageOptions options, JsonFactory jsonFactory) { CensusHttpModule censusHttpModule = new CensusHttpModule(tracer, IS_RECORD_EVENTS); initializer = censusHttpModule.getHttpRequestInitializer(initializer); initializer = new InvocationIdInitializer(initializer, applicationName, tm); - batchRequestInitializer = censusHttpModule.getHttpRequestInitializer(null); + initializer = options.decorateWithMetrics(initializer); + batchRequestInitializer = + options.decorateWithMetrics(censusHttpModule.getHttpRequestInitializer(null)); storage = new Storage.Builder(transport, jsonFactory, initializer) .setRootUrl(options.getHost()) diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java new file mode 100644 index 000000000000..0ce3d3376225 --- /dev/null +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -0,0 +1,374 @@ +/* + * Copyright 2026 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.cloud.storage; + +import static com.google.common.truth.Truth.assertThat; +import static org.junit.Assert.assertThrows; + +import com.google.api.client.http.GenericUrl; +import com.google.api.client.http.HttpRequest; +import com.google.api.client.http.HttpTransport; +import com.google.api.client.http.LowLevelHttpRequest; +import com.google.api.client.http.LowLevelHttpResponse; +import com.google.api.client.testing.http.MockHttpTransport; +import com.google.api.client.testing.http.MockLowLevelHttpRequest; +import com.google.api.client.testing.http.MockLowLevelHttpResponse; +import com.google.api.core.ApiClock; +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.sdk.metrics.SdkMeterProvider; +import io.opentelemetry.sdk.metrics.data.HistogramPointData; +import io.opentelemetry.sdk.metrics.data.MetricData; +import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; +import java.io.IOException; +import java.util.Collection; +import java.util.concurrent.atomic.AtomicLong; +import org.junit.Before; +import org.junit.Test; + +public final class StorageHttpMetricsInterceptorTest { + + private InMemoryMetricReader reader; + private SdkMeterProvider meterProvider; + private FakeClock clock; + + @Before + public void setUp() { + reader = InMemoryMetricReader.create(); + meterProvider = SdkMeterProvider.builder().registerMetricReader(reader).build(); + clock = new FakeClock(); + } + + @Test + public void extractUrlTemplate_cases() { + assertThat(StorageHttpMetricsInterceptor.extractUrlTemplate(null)).isEqualTo("/"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/upload/storage/v1/b/my-b/o?upload_id=xyz"))) + .isEqualTo("/upload/storage/v1/b/{bucket}/o"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/upload/storage/v1/b/my-b/o"))) + .isEqualTo("/upload/storage/v1/b/{bucket}/o"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/download/storage/v1/b/my-b/o/my-obj"))) + .isEqualTo("/download/storage/v1/b/{bucket}/o/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/batch/storage/v1"))) + .isEqualTo("/batch/storage/v1"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"))) + .isEqualTo("/storage/v1/b/{bucket}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl/allUsers"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl/{entity}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/o/o1/copyTo/b/b2/o/o2"))) + .isEqualTo( + "/storage/v1/b/{bucket}/o/{object}/copyTo/b/{destinationBucket}/o/{destinationObject}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/o/o1/rewriteTo/b/b2/o/o2"))) + .isEqualTo( + "/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{destinationBucket}/o/{destinationObject}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/o/o1/moveTo/o/o2"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers"))) + .isEqualTo("/storage/v1/b/{bucket}/acl/{entity}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl/allUsers"))) + .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl/{entity}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/notifications/notif1"))) + .isEqualTo("/storage/v1/b/{bucket}/notifications/{notification}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/projects/my-p/hmacKeys/key1"))) + .isEqualTo("/storage/v1/projects/{project}/hmacKeys/{accessId}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/my-b"))) + .isEqualTo("/{bucket}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/my-b/my-obj"))) + .isEqualTo("/{bucket}/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/"))) + .isEqualTo("/"); + } + + @Test + public void initialize_200Ok_recordsDurationWithoutErrorType() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); + lowLevelResponse.setStatusCode(200); + HttpTransport transport = + new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); + request.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + assertThat(durationData.getHistogramData().getPoints()).hasSize(1); + HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD)).isEqualTo("GET"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(200L); + assertThat(attrs.get(StorageClientMetrics.KEY_NETWORK_PATH)) + .isEqualTo(StorageClientMetrics.NETWORK_PATH_CLOUDPATH); + assertThat(attrs.get(StorageClientMetrics.KEY_URL_TEMPLATE)) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("OK"); + } + + @Test + public void initialize_308ResumeIncomplete_recordsWithoutErrorType() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); + lowLevelResponse.setStatusCode(308); + HttpTransport transport = + new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildPutRequest( + new GenericUrl( + "https://storage.googleapis.com/upload/storage/v1/b/my-b/o?upload_id=123"), + null); + request.setThrowExceptionOnExecuteError(false); + request.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(308L); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("OK"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + } + + @Test + public void initialize_404NotFound_recordsErrorType() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); + lowLevelResponse.setStatusCode(404); + HttpTransport transport = + new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/missing-bucket")); + request.setThrowExceptionOnExecuteError(false); + request.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(404L); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("NOT_FOUND"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + } + + @Test + public void initialize_503ServiceUnavailable_recordsErrorType() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); + lowLevelResponse.setStatusCode(503); + HttpTransport transport = + new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); + request.setThrowExceptionOnExecuteError(false); + request.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(503L); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("UNAVAILABLE"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + } + + @Test + public void initialize_networkIOException_recordsErrorTypeWithoutStatusCode() { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = + new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(String method, String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() throws IOException { + throw new IOException("Connection reset by peer"); + } + }; + } + }; + + assertThrows( + IOException.class, + () -> { + HttpRequest req = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + req.execute(); + }); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("CONNECTIVITY"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(0L); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + } + + @Test + public void initialize_metricsDisabled_doesNotRecord() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, false, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); + lowLevelResponse.setStatusCode(200); + HttpTransport transport = + new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + request.execute(); + + assertThat(reader.collectAllMetrics()).isEmpty(); + } + + private static final class FakeClock implements ApiClock { + private final AtomicLong nanos = new AtomicLong(1_000_000_000L); + + @Override + public long nanoTime() { + return nanos.get(); + } + + @Override + public long millisTime() { + return nanos.get() / 1_000_000L; + } + + void advanceNanos(long amount) { + nanos.addAndGet(amount); + } + } +} From 510824ae4dda6ccdfe5032ce821f01b7d8a2b7c2 Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Tue, 3 Nov 2026 10:33:12 +0000 Subject: [PATCH 2/8] fix(storage): address PR #14744 review comments and align HTTP duration metrics [Generated-by: AI] --- .../StorageHttpMetricsInterceptor.java | 235 +++++++++++------- .../StorageHttpMetricsInterceptorTest.java | 193 ++++++++++++-- 2 files changed, 308 insertions(+), 120 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index 9c50c5d7448c..09670057bcb4 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -23,25 +23,29 @@ import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpResponseInterceptor; import com.google.api.core.ApiClock; -import io.opentelemetry.api.common.AttributesBuilder; +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.api.metrics.DoubleHistogram; import io.opentelemetry.context.Context; +import java.io.IOException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; -import org.checkerframework.checker.nullness.qual.Nullable; +import org.jspecify.annotations.NullMarked; +import org.jspecify.annotations.Nullable; /** * HTTP request initializer that records HTTP client metrics such as http.client.request.duration. */ +@NullMarked final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { @Nullable private final HttpRequestInitializer delegate; - private final StorageClientMetrics metrics; + @Nullable private final StorageClientMetrics metrics; private final ApiClock clock; @Nullable private final String defaultServerAddress; StorageHttpMetricsInterceptor( @Nullable HttpRequestInitializer delegate, - StorageClientMetrics metrics, + @Nullable StorageClientMetrics metrics, ApiClock clock, @Nullable String host) { this.delegate = delegate; @@ -51,11 +55,15 @@ final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { } @Override - public void initialize(HttpRequest request) throws java.io.IOException { + public void initialize(HttpRequest request) throws IOException { if (delegate != null) { delegate.initialize(request); } - if (metrics == null || metrics.getHttpClientRequestDuration() == null) { + if (metrics == null) { + return; + } + DoubleHistogram durationHistogram = metrics.getHttpClientRequestDuration(); + if (durationHistogram == null) { return; } @@ -63,8 +71,8 @@ public void initialize(HttpRequest request) throws java.io.IOException { HttpResponseInterceptor existingResp = request.getResponseInterceptor(); HttpIOExceptionHandler existingIoHandler = request.getIOExceptionHandler(); - AtomicLong startTimeNanos = new AtomicLong(clock.nanoTime()); - AtomicBoolean recorded = new AtomicBoolean(false); + AtomicLong startTimeNanos = new AtomicLong(); + AtomicBoolean recorded = new AtomicBoolean(true); request.setInterceptor( req -> { @@ -80,79 +88,80 @@ public void initialize(HttpRequest request) throws java.io.IOException { if (existingResp != null) { existingResp.interceptResponse(response); } - if (recorded.compareAndSet(false, true) - && metrics.getHttpClientRequestDuration() != null) { - double durationSeconds = - Math.max(0.0, (clock.nanoTime() - startTimeNanos.get()) / 1_000_000_000.0); + if (recorded.compareAndSet(false, true)) { int statusCode = response.getStatusCode(); - String method = - request.getRequestMethod() != null ? request.getRequestMethod() : "UNKNOWN"; - String urlTemplate = extractUrlTemplate(request.getUrl()); - String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); - - AttributesBuilder attrBuilder = - metrics - .clientAttributesBuilder() - .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) - .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, (long) statusCode) - .put( - StorageClientMetrics.KEY_NETWORK_PATH, - StorageClientMetrics.NETWORK_PATH_CLOUDPATH) - .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) - .put( - StorageClientMetrics.KEY_SERVER_ADDRESS, - serverAddress != null ? serverAddress : "") - .put( - StorageClientMetrics.KEY_ERROR_TYPE, - statusCode >= 400 - ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) - : StorageErrorTypeMapper.STATUS_OK); - - metrics - .getHttpClientRequestDuration() - .record(durationSeconds, attrBuilder.build(), Context.current()); + String errorType = + statusCode >= 400 + ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) + : StorageErrorTypeMapper.STATUS_OK; + recordDuration(durationHistogram, request, startTimeNanos.get(), statusCode, errorType); } }); + // HttpIOExceptionHandler does not receive the thrown IOException instance from + // google-http-client, so transport-level IOExceptions default to STATUS_CONNECTIVITY here + // (specific subtypes like TIMEOUT, DNS_FAILURE, and TLS_FAILURE are mapped in Retrying). request.setIOExceptionHandler( (req, supportsRetry) -> { - if (recorded.compareAndSet(false, true) - && metrics.getHttpClientRequestDuration() != null) { - double durationSeconds = - Math.max(0.0, (clock.nanoTime() - startTimeNanos.get()) / 1_000_000_000.0); - String method = req.getRequestMethod() != null ? req.getRequestMethod() : "UNKNOWN"; - String urlTemplate = extractUrlTemplate(req.getUrl()); - String serverAddress = resolveServerAddress(req.getUrl(), defaultServerAddress); - - AttributesBuilder attrBuilder = - metrics - .clientAttributesBuilder() - .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) - .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, 0L) - .put( - StorageClientMetrics.KEY_NETWORK_PATH, - StorageClientMetrics.NETWORK_PATH_CLOUDPATH) - .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) - .put( - StorageClientMetrics.KEY_SERVER_ADDRESS, - serverAddress != null ? serverAddress : "") - .put( - StorageClientMetrics.KEY_ERROR_TYPE, - StorageErrorTypeMapper.STATUS_CONNECTIVITY); - - metrics - .getHttpClientRequestDuration() - .record(durationSeconds, attrBuilder.build(), Context.current()); + if (recorded.compareAndSet(false, true)) { + recordDuration( + durationHistogram, + req, + startTimeNanos.get(), + 0L, + StorageErrorTypeMapper.STATUS_CONNECTIVITY); } return existingIoHandler != null && existingIoHandler.handleIOException(req, supportsRetry); }); } + private void recordDuration( + DoubleHistogram durationHistogram, + HttpRequest request, + long startNanos, + long statusCode, + String errorType) { + if (metrics == null) { + return; + } + double durationSeconds = Math.max(0.0, (clock.nanoTime() - startNanos) / 1_000_000_000.0); + String method = request.getRequestMethod() != null ? request.getRequestMethod() : "UNKNOWN"; + String urlTemplate = extractUrlTemplate(request.getUrl()); + String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); + + Attributes attributes = + metrics + .clientAttributesBuilder() + .put(StorageClientMetrics.KEY_RPC_SYSTEM_NAME, "http") + .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) + .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, statusCode) + .put(StorageClientMetrics.KEY_NETWORK_PATH, StorageClientMetrics.NETWORK_PATH_CLOUDPATH) + .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) + .put( + StorageClientMetrics.KEY_SERVER_ADDRESS, serverAddress != null ? serverAddress : "") + .put(StorageClientMetrics.KEY_ERROR_TYPE, errorType) + .build(); + + durationHistogram.record(durationSeconds, attributes, Context.current()); + } + + @Nullable static String resolveServerAddress( @Nullable GenericUrl url, @Nullable String defaultServerAddress) { String host = url != null ? url.getHost() : null; - return (host != null && !host.isEmpty()) ? host : defaultServerAddress; + if (host == null || host.isEmpty()) { + return defaultServerAddress; + } + if (host.endsWith(".storage.googleapis.com") && !host.equals("storage.googleapis.com")) { + return "storage.googleapis.com"; + } + if (defaultServerAddress != null + && !defaultServerAddress.isEmpty() + && host.endsWith("." + defaultServerAddress)) { + return defaultServerAddress; + } + return host; } static String extractUrlTemplate(@Nullable GenericUrl url) { @@ -166,6 +175,12 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { if (path == null || path.isEmpty()) { return "/"; } + String host = url.getHost(); + if (host != null + && host.endsWith(".storage.googleapis.com") + && !host.equals("storage.googleapis.com")) { + return "/".equals(path) ? "/" : "/{object}"; + } if (path.length() > 1 && path.endsWith("/")) { path = path.substring(0, path.length() - 1); } @@ -182,39 +197,73 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { String rest = path.substring("/storage/v1/".length()); String[] segments = rest.split("/"); if (segments.length >= 2 && "b".equals(segments[0])) { - segments[1] = "{bucket}"; - if (segments.length >= 4 && "o".equals(segments[2])) { - segments[3] = "{object}"; - if (segments.length >= 6) { - if ("acl".equals(segments[4])) { - segments[5] = "{entity}"; - } else if ("copyTo".equals(segments[4]) || "rewriteTo".equals(segments[4])) { - if (segments.length >= 7 && "b".equals(segments[5])) { - segments[6] = "{destinationBucket}"; - } - if (segments.length >= 9 && "o".equals(segments[7])) { - segments[8] = "{destinationObject}"; - } - } else if ("moveTo".equals(segments[4]) - && "o".equals(segments[5]) - && segments.length >= 7) { - segments[6] = "{destinationObject}"; - } + if (segments.length == 2) { + return "/storage/v1/b/{bucket}"; + } + if ("o".equals(segments[2])) { + if (segments.length == 3) { + return "/storage/v1/b/{bucket}/o"; + } + if (segments.length == 4) { + return "/storage/v1/b/{bucket}/o/{object}"; + } + String action = segments[4]; + if (segments.length == 5 + && ("compose".equals(action) + || "restore".equals(action) + || "watchAll".equals(action))) { + return "/storage/v1/b/{bucket}/o/{object}/" + action; + } + if ("acl".equals(action)) { + return segments.length == 5 + ? "/storage/v1/b/{bucket}/o/{object}/acl" + : "/storage/v1/b/{bucket}/o/{object}/acl/{entity}"; + } + if (("copyTo".equals(action) || "rewriteTo".equals(action)) + && segments.length >= 8 + && "b".equals(segments[5]) + && "o".equals(segments[7])) { + return "/storage/v1/b/{bucket}/o/{object}/" + + action + + "/b/{destinationBucket}/o/{destinationObject}"; } - } else if (segments.length >= 4) { - if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { - segments[3] = "{entity}"; - } else if ("notifications".equals(segments[2])) { - segments[3] = "{notification}"; + if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { + return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"; } + return "/storage/v1/b/{bucket}/o/{object}"; } + String subResource = segments[2]; + if ("acl".equals(subResource) || "defaultObjectAcl".equals(subResource)) { + return segments.length == 3 + ? "/storage/v1/b/{bucket}/" + subResource + : "/storage/v1/b/{bucket}/" + subResource + "/{entity}"; + } + if ("notifications".equals(subResource) || "notificationConfigs".equals(subResource)) { + return segments.length == 3 + ? "/storage/v1/b/{bucket}/" + subResource + : "/storage/v1/b/{bucket}/" + subResource + "/{notification}"; + } + if (segments.length == 3) { + return "/storage/v1/b/{bucket}/" + subResource; + } + if (segments.length == 4 + && "iam".equals(subResource) + && "testPermissions".equals(segments[3])) { + return "/storage/v1/b/{bucket}/iam/testPermissions"; + } + return "/storage/v1/b/{bucket}"; } else if (segments.length >= 2 && "projects".equals(segments[0])) { - segments[1] = "{project}"; - if (segments.length >= 4 && "hmacKeys".equals(segments[2])) { - segments[3] = "{accessId}"; + if (segments.length >= 3 && "hmacKeys".equals(segments[2])) { + return segments.length == 3 + ? "/storage/v1/projects/{project}/hmacKeys" + : "/storage/v1/projects/{project}/hmacKeys/{accessId}"; + } + if (segments.length >= 3 && "serviceAccount".equals(segments[2])) { + return "/storage/v1/projects/{project}/serviceAccount"; } + return "/storage/v1/projects/{project}"; } - return "/storage/v1/" + String.join("/", segments); + return "/storage/v1"; } String trimmed = path.startsWith("/") ? path.substring(1) : path; if (trimmed.isEmpty()) { diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java index 0ce3d3376225..d10200a71222 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -21,6 +21,7 @@ import com.google.api.client.http.GenericUrl; import com.google.api.client.http.HttpRequest; +import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpTransport; import com.google.api.client.http.LowLevelHttpRequest; import com.google.api.client.http.LowLevelHttpResponse; @@ -35,6 +36,7 @@ import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; import java.io.IOException; import java.util.Collection; +import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import org.junit.Before; import org.junit.Test; @@ -77,10 +79,34 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"))) .isEqualTo("/storage/v1/b/{bucket}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o"))) + .isEqualTo("/storage/v1/b/{bucket}/o"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj"))) .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/my-b/o/dir/sub/file.txt"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/compose"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/compose"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/restore"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/restore"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/watchAll"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/watchAll"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( @@ -116,11 +142,25 @@ public void extractUrlTemplate_cases() { new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/notifications/notif1"))) .isEqualTo("/storage/v1/b/{bucket}/notifications/{notification}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/iam"))) + .isEqualTo("/storage/v1/b/{bucket}/iam"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/iam/testPermissions"))) + .isEqualTo("/storage/v1/b/{bucket}/iam/testPermissions"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/projects/my-p/hmacKeys/key1"))) .isEqualTo("/storage/v1/projects/{project}/hmacKeys/{accessId}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/projects/my-p/serviceAccount"))) + .isEqualTo("/storage/v1/projects/{project}/serviceAccount"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/my-b"))) @@ -133,6 +173,34 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/"))) .isEqualTo("/"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://my-bucket.storage.googleapis.com/"))) + .isEqualTo("/"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://my-bucket.storage.googleapis.com/my-obj"))) + .isEqualTo("/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://my-bucket.storage.googleapis.com/dir/my-obj"))) + .isEqualTo("/{object}"); + } + + @Test + public void resolveServerAddress_stripsVirtualHostedBucketPrefix() { + assertThat( + StorageHttpMetricsInterceptor.resolveServerAddress( + new GenericUrl("https://my-bucket.storage.googleapis.com/my-obj"), + "storage.googleapis.com")) + .isEqualTo("storage.googleapis.com"); + assertThat( + StorageHttpMetricsInterceptor.resolveServerAddress( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"), + "storage.googleapis.com")) + .isEqualTo("storage.googleapis.com"); + assertThat(StorageHttpMetricsInterceptor.resolveServerAddress(null, "storage.googleapis.com")) + .isEqualTo("storage.googleapis.com"); } @Test @@ -141,10 +209,7 @@ public void initialize_200Ok_recordsDurationWithoutErrorType() throws IOExceptio StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); - lowLevelResponse.setStatusCode(200); - HttpTransport transport = - new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + HttpTransport transport = createAdvancingTransport(200, 250_000_000L); HttpRequest request = transport @@ -164,8 +229,10 @@ public void initialize_200Ok_recordsDurationWithoutErrorType() throws IOExceptio assertThat(durationData).isNotNull(); assertThat(durationData.getHistogramData().getPoints()).hasSize(1); HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + assertThat(point.getSum()).isWithin(1e-6).of(0.25); Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD)).isEqualTo("GET"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(200L); assertThat(attrs.get(StorageClientMetrics.KEY_NETWORK_PATH)) @@ -183,10 +250,7 @@ public void initialize_308ResumeIncomplete_recordsWithoutErrorType() throws IOEx StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); - lowLevelResponse.setStatusCode(308); - HttpTransport transport = - new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + HttpTransport transport = createAdvancingTransport(308, 120_000_000L); HttpRequest request = transport @@ -208,7 +272,9 @@ public void initialize_308ResumeIncomplete_recordsWithoutErrorType() throws IOEx assertThat(durationData).isNotNull(); HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + assertThat(point.getSum()).isWithin(1e-6).of(0.12); Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(308L); assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("OK"); assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) @@ -221,10 +287,7 @@ public void initialize_404NotFound_recordsErrorType() throws IOException { StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); - lowLevelResponse.setStatusCode(404); - HttpTransport transport = - new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + HttpTransport transport = createAdvancingTransport(404, 80_000_000L); HttpRequest request = transport @@ -244,7 +307,9 @@ public void initialize_404NotFound_recordsErrorType() throws IOException { assertThat(durationData).isNotNull(); HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + assertThat(point.getSum()).isWithin(1e-6).of(0.08); Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(404L); assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("NOT_FOUND"); assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) @@ -257,10 +322,7 @@ public void initialize_503ServiceUnavailable_recordsErrorType() throws IOExcepti StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); - lowLevelResponse.setStatusCode(503); - HttpTransport transport = - new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + HttpTransport transport = createAdvancingTransport(503, 400_000_000L); HttpRequest request = transport @@ -280,7 +342,9 @@ public void initialize_503ServiceUnavailable_recordsErrorType() throws IOExcepti assertThat(durationData).isNotNull(); HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + assertThat(point.getSum()).isWithin(1e-6).of(0.40); Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(503L); assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("UNAVAILABLE"); assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) @@ -288,7 +352,7 @@ public void initialize_503ServiceUnavailable_recordsErrorType() throws IOExcepti } @Test - public void initialize_networkIOException_recordsErrorTypeWithoutStatusCode() { + public void initialize_networkIOException_recordsErrorTypeWithoutStatusCode() throws IOException { StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); @@ -300,22 +364,19 @@ public LowLevelHttpRequest buildRequest(String method, String url) { return new MockLowLevelHttpRequest() { @Override public LowLevelHttpResponse execute() throws IOException { + clock.advanceNanos(150_000_000L); throw new IOException("Connection reset by peer"); } }; } }; - assertThrows( - IOException.class, - () -> { - HttpRequest req = - transport - .createRequestFactory(interceptor) - .buildGetRequest( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); - req.execute(); - }); + HttpRequest req = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + + assertThrows(IOException.class, req::execute); Collection metricData = reader.collectAllMetrics(); MetricData durationData = @@ -327,13 +388,74 @@ public LowLevelHttpResponse execute() throws IOException { assertThat(durationData).isNotNull(); HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); + assertThat(point.getSum()).isWithin(1e-6).of(0.15); Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("CONNECTIVITY"); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(0L); assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) .isEqualTo("storage.googleapis.com"); } + @Test + public void initialize_ioExceptionBeforeExecuteInterceptorRuns_doesNotRecordMetric() + throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = new MockHttpTransport(); + HttpRequest req = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + + clock.advanceNanos(500_000_000L); + boolean handled = req.getIOExceptionHandler().handleIOException(req, false); + + assertThat(handled).isFalse(); + assertThat(reader.collectAllMetrics()).isEmpty(); + } + + @Test + public void initialize_chainsExistingDelegateAndInterceptors() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + AtomicBoolean delegateCalled = new AtomicBoolean(false); + AtomicBoolean execCalled = new AtomicBoolean(false); + AtomicBoolean respCalled = new AtomicBoolean(false); + AtomicBoolean ioHandlerCalled = new AtomicBoolean(false); + + HttpRequestInitializer delegate = + request -> { + delegateCalled.set(true); + request.setInterceptor(req -> execCalled.set(true)); + request.setResponseInterceptor(resp -> respCalled.set(true)); + request.setIOExceptionHandler( + (req, supportsRetry) -> { + ioHandlerCalled.set(true); + return false; + }); + }; + + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor( + delegate, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = createAdvancingTransport(200, 100_000_000L); + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + request.execute(); + + assertThat(delegateCalled.get()).isTrue(); + assertThat(execCalled.get()).isTrue(); + assertThat(respCalled.get()).isTrue(); + + request.getIOExceptionHandler().handleIOException(request, false); + assertThat(ioHandlerCalled.get()).isTrue(); + } + @Test public void initialize_metricsDisabled_doesNotRecord() throws IOException { StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, false, false); @@ -354,6 +476,23 @@ public void initialize_metricsDisabled_doesNotRecord() throws IOException { assertThat(reader.collectAllMetrics()).isEmpty(); } + private HttpTransport createAdvancingTransport(int statusCode, long advanceNanos) { + return new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(String method, String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() { + clock.advanceNanos(advanceNanos); + MockLowLevelHttpResponse response = new MockLowLevelHttpResponse(); + response.setStatusCode(statusCode); + return response; + } + }; + } + }; + } + private static final class FakeClock implements ApiClock { private final AtomicLong nanos = new AtomicLong(1_000_000_000L); From df4a503f1656ca96e9fdffd58e7554590d2bbc14 Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Thu, 5 Nov 2026 09:51:06 +0000 Subject: [PATCH 3/8] refactor(storage): simplify extractUrlTemplate and move recordHttpRequestDuration to StorageMetricsContext [Generated-by: AI] --- .../StorageHttpMetricsInterceptor.java | 174 +++++++----------- .../cloud/storage/StorageMetricsContext.java | 26 +++ 2 files changed, 92 insertions(+), 108 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index c1dc4c023315..b032ff77529e 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -23,9 +23,7 @@ import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpResponseInterceptor; import com.google.api.core.ApiClock; -import io.opentelemetry.api.common.Attributes; -import io.opentelemetry.api.metrics.DoubleHistogram; -import io.opentelemetry.context.Context; +import com.google.common.collect.ImmutableSet; import java.io.IOException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; @@ -39,6 +37,9 @@ @NullMarked final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { + private static final ImmutableSet OBJECT_SUB_RESOURCES = + ImmutableSet.of("acl", "compose", "restore", "watchAll"); + @Nullable private final HttpRequestInitializer delegate; @Nullable private final StorageClientMetrics metrics; private final ApiClock clock; @@ -60,11 +61,7 @@ public void initialize(HttpRequest request) throws IOException { if (delegate != null) { delegate.initialize(request); } - if (metrics == null) { - return; - } - DoubleHistogram durationHistogram = metrics.getHttpClientRequestDuration(); - if (durationHistogram == null) { + if (metrics == null || metrics.getHttpClientRequestDuration() == null) { return; } @@ -95,12 +92,7 @@ public void initialize(HttpRequest request) throws IOException { statusCode >= 400 ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) : StorageErrorTypeMapper.STATUS_OK; - recordDuration( - durationHistogram, - request, - startTimeNanos.get(), - String.valueOf(statusCode), - errorType); + recordDuration(request, startTimeNanos.get(), String.valueOf(statusCode), errorType); } }); @@ -111,11 +103,7 @@ public void initialize(HttpRequest request) throws IOException { (req, supportsRetry) -> { if (recorded.compareAndSet(false, true)) { recordDuration( - durationHistogram, - req, - startTimeNanos.get(), - "0", - StorageErrorTypeMapper.STATUS_CONNECTIVITY); + req, startTimeNanos.get(), "0", StorageErrorTypeMapper.STATUS_CONNECTIVITY); } return existingIoHandler != null && existingIoHandler.handleIOException(req, supportsRetry); @@ -123,11 +111,7 @@ public void initialize(HttpRequest request) throws IOException { } private void recordDuration( - DoubleHistogram durationHistogram, - HttpRequest request, - long startNanos, - String statusCode, - String errorType) { + HttpRequest request, long startNanos, String statusCode, String errorType) { if (metrics == null) { return; } @@ -136,20 +120,8 @@ private void recordDuration( String urlTemplate = extractUrlTemplate(request.getUrl()); String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); - Attributes attributes = - metrics - .clientAttributesBuilder() - .put(StorageClientMetrics.KEY_RPC_SYSTEM_NAME, "http") - .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, method) - .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, statusCode) - .put(StorageClientMetrics.KEY_NETWORK_PATH, StorageClientMetrics.NETWORK_PATH_CLOUDPATH) - .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) - .put( - StorageClientMetrics.KEY_SERVER_ADDRESS, serverAddress != null ? serverAddress : "") - .put(StorageClientMetrics.KEY_ERROR_TYPE, errorType) - .build(); - - durationHistogram.record(durationSeconds, attributes, Context.current()); + StorageMetricsContext.recordHttpRequestDuration( + metrics, durationSeconds, method, statusCode, urlTemplate, serverAddress, errorType); } @Nullable @@ -200,76 +172,7 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { return "/batch/storage/v1"; } if (path.startsWith("/storage/v1/")) { - String rest = path.substring("/storage/v1/".length()); - String[] segments = rest.split("/"); - if (segments.length >= 2 && "b".equals(segments[0])) { - if (segments.length == 2) { - return "/storage/v1/b/{bucket}"; - } - if ("o".equals(segments[2])) { - if (segments.length == 3) { - return "/storage/v1/b/{bucket}/o"; - } - if (segments.length == 4) { - return "/storage/v1/b/{bucket}/o/{object}"; - } - String action = segments[4]; - if (segments.length == 5 - && ("compose".equals(action) - || "restore".equals(action) - || "watchAll".equals(action))) { - return "/storage/v1/b/{bucket}/o/{object}/" + action; - } - if ("acl".equals(action)) { - return segments.length == 5 - ? "/storage/v1/b/{bucket}/o/{object}/acl" - : "/storage/v1/b/{bucket}/o/{object}/acl/{entity}"; - } - if (("copyTo".equals(action) || "rewriteTo".equals(action)) - && segments.length >= 8 - && "b".equals(segments[5]) - && "o".equals(segments[7])) { - return "/storage/v1/b/{bucket}/o/{object}/" - + action - + "/b/{destinationBucket}/o/{destinationObject}"; - } - if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { - return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"; - } - return "/storage/v1/b/{bucket}/o/{object}"; - } - String subResource = segments[2]; - if ("acl".equals(subResource) || "defaultObjectAcl".equals(subResource)) { - return segments.length == 3 - ? "/storage/v1/b/{bucket}/" + subResource - : "/storage/v1/b/{bucket}/" + subResource + "/{entity}"; - } - if ("notifications".equals(subResource) || "notificationConfigs".equals(subResource)) { - return segments.length == 3 - ? "/storage/v1/b/{bucket}/" + subResource - : "/storage/v1/b/{bucket}/" + subResource + "/{notification}"; - } - if (segments.length == 3) { - return "/storage/v1/b/{bucket}/" + subResource; - } - if (segments.length == 4 - && "iam".equals(subResource) - && "testPermissions".equals(segments[3])) { - return "/storage/v1/b/{bucket}/iam/testPermissions"; - } - return "/storage/v1/b/{bucket}"; - } else if (segments.length >= 2 && "projects".equals(segments[0])) { - if (segments.length >= 3 && "hmacKeys".equals(segments[2])) { - return segments.length == 3 - ? "/storage/v1/projects/{project}/hmacKeys" - : "/storage/v1/projects/{project}/hmacKeys/{accessId}"; - } - if (segments.length >= 3 && "serviceAccount".equals(segments[2])) { - return "/storage/v1/projects/{project}/serviceAccount"; - } - return "/storage/v1/projects/{project}"; - } - return "/storage/v1"; + return extractV1UrlTemplate(path.substring("/storage/v1/".length())); } String trimmed = path.startsWith("/") ? path.substring(1) : path; if (trimmed.isEmpty()) { @@ -278,4 +181,59 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { String[] parts = trimmed.split("/", 2); return parts.length == 1 ? "/{bucket}" : "/{bucket}/{object}"; } + + private static String extractV1UrlTemplate(String rest) { + String[] segments = rest.split("/"); + if (segments.length >= 2 && "b".equals(segments[0])) { + segments[1] = "{bucket}"; + if (segments.length >= 3 && "o".equals(segments[2])) { + return extractObjectUrlTemplate(segments); + } + if (segments.length >= 4) { + if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { + segments[3] = "{entity}"; + } else if ("notifications".equals(segments[2]) + || "notificationConfigs".equals(segments[2])) { + segments[3] = "{notification}"; + } + } + return "/storage/v1/" + String.join("/", segments); + } + if (segments.length >= 2 && "projects".equals(segments[0])) { + segments[1] = "{project}"; + if (segments.length >= 4 && "hmacKeys".equals(segments[2])) { + segments[3] = "{accessId}"; + } + return "/storage/v1/" + String.join("/", segments); + } + return "/storage/v1"; + } + + private static String extractObjectUrlTemplate(String[] segments) { + if (segments.length == 3) { + return "/storage/v1/b/{bucket}/o"; + } + if (segments.length == 4) { + return "/storage/v1/b/{bucket}/o/{object}"; + } + String action = segments[4]; + if (segments.length == 5 && OBJECT_SUB_RESOURCES.contains(action)) { + return "/storage/v1/b/{bucket}/o/{object}/" + action; + } + if ("acl".equals(action)) { + return "/storage/v1/b/{bucket}/o/{object}/acl/{entity}"; + } + if (("copyTo".equals(action) || "rewriteTo".equals(action)) + && segments.length >= 8 + && "b".equals(segments[5]) + && "o".equals(segments[7])) { + return "/storage/v1/b/{bucket}/o/{object}/" + + action + + "/b/{destinationBucket}/o/{destinationObject}"; + } + if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { + return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"; + } + return "/storage/v1/b/{bucket}/o/{object}"; + } } diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java index 93715ad69c2e..9caf52d602cb 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java @@ -295,6 +295,32 @@ static void recordRpcCallDuration( metrics.getRpcClientCallDuration().record(durationSeconds, attributes, otelContext); } + static void recordHttpRequestDuration( + @Nullable StorageClientMetrics metrics, + double durationSeconds, + String httpMethod, + String statusCode, + String urlTemplate, + @Nullable String serverAddress, + String errorType) { + if (metrics == null || metrics.getHttpClientRequestDuration() == null) { + return; + } + Attributes attributes = + metrics + .clientAttributesBuilder() + .put(StorageClientMetrics.KEY_RPC_SYSTEM_NAME, "http") + .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, httpMethod) + .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, statusCode) + .put(StorageClientMetrics.KEY_NETWORK_PATH, StorageClientMetrics.NETWORK_PATH_CLOUDPATH) + .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) + .put( + StorageClientMetrics.KEY_SERVER_ADDRESS, serverAddress != null ? serverAddress : "") + .put(StorageClientMetrics.KEY_ERROR_TYPE, errorType) + .build(); + metrics.getHttpClientRequestDuration().record(durationSeconds, attributes, Context.current()); + } + private Attributes buildAttemptBaseAttributes(StorageClientMetrics metrics) { AttributesBuilder baseBuilder = Attributes.builder(); baseBuilder.putAll(metrics.getClientAttributes()); From 610bd868faa3cf87b8ee5963b43ca4824aa528e0 Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Sat, 7 Nov 2026 19:16:27 +0000 Subject: [PATCH 4/8] fix(storage): resolve PR #14744 review comments in StorageHttpMetricsInterceptor - Merge updated base branch feat/storage-rpc-call-duration (including #14694) - Update HttpIOExceptionHandler error type to StorageErrorTypeMapper.STATUS_CONNECTION_ERROR - Return "/storage/v1/b" in extractV1UrlTemplate when rest is "b" (CreateBucket / ListBuckets) [Generated-by: AI] --- .../cloud/storage/StorageHttpMetricsInterceptor.java | 7 +++++-- .../storage/StorageHttpMetricsInterceptorTest.java | 11 ++++++++++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index b032ff77529e..2345af4ada17 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -97,13 +97,13 @@ public void initialize(HttpRequest request) throws IOException { }); // HttpIOExceptionHandler does not receive the thrown IOException instance from - // google-http-client, so transport-level IOExceptions default to STATUS_CONNECTIVITY here + // google-http-client, so transport-level IOExceptions default to STATUS_CONNECTION_ERROR here // (specific subtypes like TIMEOUT, DNS_FAILURE, and TLS_FAILURE are mapped in Retrying). request.setIOExceptionHandler( (req, supportsRetry) -> { if (recorded.compareAndSet(false, true)) { recordDuration( - req, startTimeNanos.get(), "0", StorageErrorTypeMapper.STATUS_CONNECTIVITY); + req, startTimeNanos.get(), "0", StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); } return existingIoHandler != null && existingIoHandler.handleIOException(req, supportsRetry); @@ -183,6 +183,9 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { } private static String extractV1UrlTemplate(String rest) { + if ("b".equals(rest)) { + return "/storage/v1/b"; + } String[] segments = rest.split("/"); if (segments.length >= 2 && "b".equals(segments[0])) { segments[1] = "{bucket}"; diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java index 25cd88f605b9..576a0d1dd998 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -75,6 +75,14 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/batch/storage/v1"))) .isEqualTo("/batch/storage/v1"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b"))) + .isEqualTo("/storage/v1/b"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b?project=my-proj"))) + .isEqualTo("/storage/v1/b"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"))) @@ -391,7 +399,8 @@ public LowLevelHttpResponse execute() throws IOException { assertThat(point.getSum()).isWithin(1e-6).of(0.15); Attributes attrs = point.getAttributes(); assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("CONNECTIVITY"); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo("0"); assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) .isEqualTo("storage.googleapis.com"); From baa428350a34587f7aa0ee71d20ce8eae1df223b Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Sat, 7 Nov 2026 19:47:11 +0000 Subject: [PATCH 5/8] test(storage): align RetryingMetricsTest with DEADLINE_EXCEEDED error mapping After merging StorageErrorTypeMapper updates from #14694, Status.DEADLINE_EXCEEDED maps to DEADLINE_EXCEEDED while SocketTimeoutException maps to TIMEOUT. Update recordAttemptError_specificExceptions_mappedToCanonicalTypes to assert 1 count each for DEADLINE_EXCEEDED, TIMEOUT, and DNS_FAILURE. [Generated-by: AI] --- .../java/com/google/cloud/storage/RetryingMetricsTest.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/RetryingMetricsTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/RetryingMetricsTest.java index 719096ed405c..5fb160ec4a60 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/RetryingMetricsTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/RetryingMetricsTest.java @@ -25,6 +25,7 @@ import static com.google.cloud.storage.StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_ATTEMPTS; import static com.google.cloud.storage.StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_ERRORS; import static com.google.cloud.storage.StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_OPERATIONS; +import static com.google.cloud.storage.StorageErrorTypeMapper.STATUS_DEADLINE_EXCEEDED; import static com.google.cloud.storage.StorageErrorTypeMapper.STATUS_DNS_FAILURE; import static com.google.cloud.storage.StorageErrorTypeMapper.STATUS_NOT_FOUND; import static com.google.cloud.storage.StorageErrorTypeMapper.STATUS_OK; @@ -286,7 +287,8 @@ public void recordAttemptError_specificExceptions_mappedToCanonicalTypes() { assertThat(attemptCounter.get()).isEqualTo(3); assertThat(se).isNotNull(); assertOutcomeMetrics(STATUS_DNS_FAILURE, 3L, 3L); - assertAttr(METRIC_GCP_STORAGE_CLIENT_ERRORS, KEY_ERROR_TYPE, STATUS_TIMEOUT, 2L); + assertAttr(METRIC_GCP_STORAGE_CLIENT_ERRORS, KEY_ERROR_TYPE, STATUS_DEADLINE_EXCEEDED, 1L); + assertAttr(METRIC_GCP_STORAGE_CLIENT_ERRORS, KEY_ERROR_TYPE, STATUS_TIMEOUT, 1L); assertAttr(METRIC_GCP_STORAGE_CLIENT_ERRORS, KEY_ERROR_TYPE, STATUS_DNS_FAILURE, 1L); } From f71f98add1bdc84a7d54689c4fd3b93f779f4d14 Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Thu, 12 Nov 2026 07:41:37 +0000 Subject: [PATCH 6/8] fix(storage): address PR review feedback on HTTP request duration interceptor [Generated-by: AI] --- .../StorageHttpMetricsInterceptor.java | 63 +++--- .../StorageHttpMetricsInterceptorTest.java | 183 +++++++++++++++++- 2 files changed, 212 insertions(+), 34 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index 2608cee9f7a0..13ae2b28760b 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -22,6 +22,7 @@ import com.google.api.client.http.HttpRequest; import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpResponseInterceptor; +import com.google.api.client.http.HttpUnsuccessfulResponseHandler; import com.google.api.core.ApiClock; import com.google.common.collect.ImmutableSet; import java.io.IOException; @@ -33,6 +34,12 @@ /** * {@link HttpRequestInitializer} that instruments outgoing HTTP requests to record OpenTelemetry * client metrics. + * + *

Note: {@code google-http-client} invokes {@link HttpResponseInterceptor#interceptResponse} + * inside {@link HttpRequest#execute()} when the HTTP response headers arrive, before streaming + * download bodies are consumed by the caller (matching the Go SDK's {@code + * metricsRoundTripper.RoundTrip}). End-to-end download duration including body transfer is captured + * by {@code gcp.client.request.duration}. */ @NullMarked final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { @@ -67,6 +74,8 @@ public void initialize(HttpRequest request) throws IOException { HttpExecuteInterceptor existingExec = request.getInterceptor(); HttpResponseInterceptor existingResp = request.getResponseInterceptor(); + HttpUnsuccessfulResponseHandler existingUnsuccessfulHandler = + request.getUnsuccessfulResponseHandler(); HttpIOExceptionHandler existingIoHandler = request.getIOExceptionHandler(); AtomicLong startTimeNanos = new AtomicLong(); @@ -81,6 +90,23 @@ public void initialize(HttpRequest request) throws IOException { recorded.set(false); }); + if (existingUnsuccessfulHandler != null) { + request.setUnsuccessfulResponseHandler( + (req, response, supportsRetry) -> { + boolean handled = + existingUnsuccessfulHandler.handleResponse(req, response, supportsRetry); + if (handled && recorded.compareAndSet(false, true)) { + int statusCode = response.getStatusCode(); + String errorType = + statusCode >= 400 + ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) + : StorageErrorTypeMapper.STATUS_OK; + recordDuration(req, startTimeNanos.get(), (long) statusCode, errorType); + } + return handled; + }); + } + request.setResponseInterceptor( response -> { if (existingResp != null) { @@ -149,9 +175,6 @@ static String extractUrlTemplate(@Nullable GenericUrl url) { if (url == null) { return "/"; } - if (url.getFirst("upload_id") != null) { - return "/upload/storage/v1/b/{bucket}/o"; - } String path = url.getRawPath(); if (path == null || path.isEmpty()) { return "/"; @@ -191,24 +214,21 @@ private static String extractV1UrlTemplate(String rest) { } String[] segments = rest.split("/"); if (segments.length >= 2 && "b".equals(segments[0])) { - segments[1] = "{bucket}"; - if (segments.length >= 3 && "o".equals(segments[2])) { + if (segments.length == 2) { + return "/storage/v1/b/{bucket}"; + } + if ("o".equals(segments[2])) { return extractObjectUrlTemplate(segments); } - if (segments.length >= 4) { - if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { - segments[3] = "{entity}"; - } else if ("notifications".equals(segments[2]) - || "notificationConfigs".equals(segments[2])) { - segments[3] = "{notification}"; - } + if ("iam".equals(segments[2]) && segments.length > 3) { + return "/storage/v1/b/{bucket}/iam/" + segments[3]; } - return "/storage/v1/" + String.join("/", segments); + return "/storage/v1/b/{bucket}/" + segments[2]; } if (segments.length >= 2 && "projects".equals(segments[0])) { segments[1] = "{project}"; if (segments.length >= 4 && "hmacKeys".equals(segments[2])) { - segments[3] = "{accessId}"; + segments[3] = "{access_id}"; } return "/storage/v1/" + String.join("/", segments); } @@ -223,22 +243,17 @@ private static String extractObjectUrlTemplate(String[] segments) { return "/storage/v1/b/{bucket}/o/{object}"; } String action = segments[4]; - if (segments.length == 5 && OBJECT_SUB_RESOURCES.contains(action)) { - return "/storage/v1/b/{bucket}/o/{object}/" + action; - } - if ("acl".equals(action)) { - return "/storage/v1/b/{bucket}/o/{object}/acl/{entity}"; - } if (("copyTo".equals(action) || "rewriteTo".equals(action)) && segments.length >= 8 && "b".equals(segments[5]) && "o".equals(segments[7])) { - return "/storage/v1/b/{bucket}/o/{object}/" - + action - + "/b/{destinationBucket}/o/{destinationObject}"; + return "/storage/v1/b/{bucket}/o/{object}/" + action + "/b/{bucket}/o/{object}"; } if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { - return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"; + return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"; + } + if (OBJECT_SUB_RESOURCES.contains(action)) { + return "/storage/v1/b/{bucket}/o/{object}/" + action; } return "/storage/v1/b/{bucket}/o/{object}"; } diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java index 62524737ccfc..29e2198e3da2 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -119,37 +119,35 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl/{entity}"); + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/o/o1/copyTo/b/b2/o/o2"))) - .isEqualTo( - "/storage/v1/b/{bucket}/o/{object}/copyTo/b/{destinationBucket}/o/{destinationObject}"); + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/copyTo/b/{bucket}/o/{object}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/o/o1/rewriteTo/b/b2/o/o2"))) - .isEqualTo( - "/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{destinationBucket}/o/{destinationObject}"); + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{bucket}/o/{object}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/o/o1/moveTo/o/o2"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/moveTo/o/{destinationObject}"); + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/acl/{entity}"); + .isEqualTo("/storage/v1/b/{bucket}/acl"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl/{entity}"); + .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/notifications/notif1"))) - .isEqualTo("/storage/v1/b/{bucket}/notifications/{notification}"); + .isEqualTo("/storage/v1/b/{bucket}/notifications"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/iam"))) @@ -163,7 +161,7 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/projects/my-p/hmacKeys/key1"))) - .isEqualTo("/storage/v1/projects/{project}/hmacKeys/{accessId}"); + .isEqualTo("/storage/v1/projects/{project}/hmacKeys/{access_id}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( @@ -177,6 +175,10 @@ public void extractUrlTemplate_cases() { StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/my-b/my-obj"))) .isEqualTo("/{bucket}/{object}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/my-b/my-obj?upload_id=xyz"))) + .isEqualTo("/{bucket}/{object}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/"))) @@ -406,6 +408,167 @@ public LowLevelHttpResponse execute() throws IOException { .isEqualTo("storage.googleapis.com"); } + @Test + public void initialize_ioExceptionThenRetrySucceeds_recordsTwoPoints() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + AtomicBoolean firstAttempt = new AtomicBoolean(true); + HttpRequestInitializer retryDelegate = + request -> request.setIOExceptionHandler((req, supportsRetry) -> true); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor( + retryDelegate, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = + new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(String method, String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() throws IOException { + if (firstAttempt.compareAndSet(true, false)) { + clock.advanceNanos(100_000_000L); + throw new IOException("Connection reset by peer"); + } + clock.advanceNanos(200_000_000L); + MockLowLevelHttpResponse response = new MockLowLevelHttpResponse(); + response.setStatusCode(200); + return response; + } + }; + } + }; + + HttpRequest req = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + req.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + Collection points = durationData.getHistogramData().getPoints(); + assertThat(points).hasSize(2); + + HistogramPointData errorPoint = + points.stream() + .filter( + p -> + Long.valueOf(0L) + .equals( + p.getAttributes() + .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) + .findFirst() + .orElse(null); + assertThat(errorPoint).isNotNull(); + assertThat(errorPoint.getSum()).isWithin(1e-6).of(0.10); + assertThat(errorPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); + + HistogramPointData okPoint = + points.stream() + .filter( + p -> + Long.valueOf(200L) + .equals( + p.getAttributes() + .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) + .findFirst() + .orElse(null); + assertThat(okPoint).isNotNull(); + assertThat(okPoint.getSum()).isWithin(1e-6).of(0.20); + assertThat(okPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(StorageErrorTypeMapper.STATUS_OK); + } + + @Test + public void initialize_401RefreshRetryThen200_recordsBothAttempts() throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + AtomicBoolean firstAttempt = new AtomicBoolean(true); + HttpRequestInitializer refreshDelegate = + request -> + request.setUnsuccessfulResponseHandler( + (req, response, supportsRetry) -> response.getStatusCode() == 401); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor( + refreshDelegate, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = + new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(String method, String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() { + MockLowLevelHttpResponse response = new MockLowLevelHttpResponse(); + if (firstAttempt.compareAndSet(true, false)) { + clock.advanceNanos(90_000_000L); + response.setStatusCode(401); + } else { + clock.advanceNanos(180_000_000L); + response.setStatusCode(200); + } + return response; + } + }; + } + }; + + HttpRequest req = + transport + .createRequestFactory(interceptor) + .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + req.execute(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + Collection points = durationData.getHistogramData().getPoints(); + assertThat(points).hasSize(2); + + HistogramPointData unauthorizedPoint = + points.stream() + .filter( + p -> + Long.valueOf(401L) + .equals( + p.getAttributes() + .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) + .findFirst() + .orElse(null); + assertThat(unauthorizedPoint).isNotNull(); + assertThat(unauthorizedPoint.getSum()).isWithin(1e-6).of(0.09); + assertThat(unauthorizedPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo("UNAUTHENTICATED"); + + HistogramPointData okPoint = + points.stream() + .filter( + p -> + Long.valueOf(200L) + .equals( + p.getAttributes() + .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) + .findFirst() + .orElse(null); + assertThat(okPoint).isNotNull(); + assertThat(okPoint.getSum()).isWithin(1e-6).of(0.18); + assertThat(okPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(StorageErrorTypeMapper.STATUS_OK); + } + @Test public void initialize_ioExceptionBeforeExecuteInterceptorRuns_doesNotRecordMetric() throws IOException { From d36f02b5b6616e7ba2200379f54de5caf22e1431 Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Mon, 16 Nov 2026 12:27:08 +0000 Subject: [PATCH 7/8] fix(storage): address follow-up review comments on PR #14744 - Clarify StorageHttpMetricsInterceptor Javadoc on download header timing - Capture end timestamp before delegating to UnsuccessfulResponseHandler so 401 duration excludes token refresh - Restore {entity} and {notification} URL template placeholders on acl and notificationConfigs paths - Add unit tests for notificationConfigs and UnsuccessfulResponseHandler returning false on 404 [Generated-by: AI] --- .../StorageHttpMetricsInterceptor.java | 29 +++++-- .../StorageHttpMetricsInterceptorTest.java | 87 +++++++++++++++++-- 2 files changed, 104 insertions(+), 12 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index 13ae2b28760b..713a034510f6 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -36,10 +36,10 @@ * client metrics. * *

Note: {@code google-http-client} invokes {@link HttpResponseInterceptor#interceptResponse} - * inside {@link HttpRequest#execute()} when the HTTP response headers arrive, before streaming - * download bodies are consumed by the caller (matching the Go SDK's {@code - * metricsRoundTripper.RoundTrip}). End-to-end download duration including body transfer is captured - * by {@code gcp.client.request.duration}. + * inside {@link HttpRequest#execute()} when the HTTP response headers arrive, so download durations + * recorded here end at response headers and exclude streaming body transfer (a follow-up is tracked + * for recording when the response body is closed). End-to-end download duration including body + * transfer is captured by {@code gcp.client.request.duration}. */ @NullMarked final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { @@ -93,6 +93,7 @@ public void initialize(HttpRequest request) throws IOException { if (existingUnsuccessfulHandler != null) { request.setUnsuccessfulResponseHandler( (req, response, supportsRetry) -> { + long endNanos = clock.nanoTime(); boolean handled = existingUnsuccessfulHandler.handleResponse(req, response, supportsRetry); if (handled && recorded.compareAndSet(false, true)) { @@ -101,7 +102,7 @@ public void initialize(HttpRequest request) throws IOException { statusCode >= 400 ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) : StorageErrorTypeMapper.STATUS_OK; - recordDuration(req, startTimeNanos.get(), (long) statusCode, errorType); + recordDuration(req, startTimeNanos.get(), endNanos, (long) statusCode, errorType); } return handled; }); @@ -141,10 +142,15 @@ public void initialize(HttpRequest request) throws IOException { private void recordDuration( HttpRequest request, long startNanos, long statusCode, String errorType) { + recordDuration(request, startNanos, clock.nanoTime(), statusCode, errorType); + } + + private void recordDuration( + HttpRequest request, long startNanos, long endNanos, long statusCode, String errorType) { if (metrics == null) { return; } - double durationSeconds = Math.max(0.0, (clock.nanoTime() - startNanos) / 1_000_000_000.0); + double durationSeconds = Math.max(0.0, (endNanos - startNanos) / 1_000_000_000.0); String method = request.getRequestMethod() != null ? request.getRequestMethod() : "UNKNOWN"; String urlTemplate = extractUrlTemplate(request.getUrl()); String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); @@ -223,6 +229,14 @@ private static String extractV1UrlTemplate(String rest) { if ("iam".equals(segments[2]) && segments.length > 3) { return "/storage/v1/b/{bucket}/iam/" + segments[3]; } + if (segments.length >= 4) { + if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { + return "/storage/v1/b/{bucket}/" + segments[2] + "/{entity}"; + } + if ("notificationConfigs".equals(segments[2]) || "notifications".equals(segments[2])) { + return "/storage/v1/b/{bucket}/" + segments[2] + "/{notification}"; + } + } return "/storage/v1/b/{bucket}/" + segments[2]; } if (segments.length >= 2 && "projects".equals(segments[0])) { @@ -252,6 +266,9 @@ private static String extractObjectUrlTemplate(String[] segments) { if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"; } + if ("acl".equals(action) && segments.length >= 6) { + return "/storage/v1/b/{bucket}/o/{object}/acl/{entity}"; + } if (OBJECT_SUB_RESOURCES.contains(action)) { return "/storage/v1/b/{bucket}/o/{object}/" + action; } diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java index 29e2198e3da2..93eac115adfb 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -115,11 +115,15 @@ public void extractUrlTemplate_cases() { new GenericUrl( "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/watchAll"))) .isEqualTo("/storage/v1/b/{bucket}/o/{object}/watchAll"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl"))) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl"); + .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl/{entity}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( @@ -136,18 +140,31 @@ public void extractUrlTemplate_cases() { .isEqualTo("/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers"))) + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl"))) .isEqualTo("/storage/v1/b/{bucket}/acl"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers"))) + .isEqualTo("/storage/v1/b/{bucket}/acl/{entity}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl"))) + .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl"); + .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl/{entity}"); + assertThat( + StorageHttpMetricsInterceptor.extractUrlTemplate( + new GenericUrl( + "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs"))) + .isEqualTo("/storage/v1/b/{bucket}/notificationConfigs"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/notifications/notif1"))) - .isEqualTo("/storage/v1/b/{bucket}/notifications"); + "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs/notif1"))) + .isEqualTo("/storage/v1/b/{bucket}/notificationConfigs/{notification}"); assertThat( StorageHttpMetricsInterceptor.extractUrlTemplate( new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/iam"))) @@ -326,6 +343,56 @@ public void initialize_404NotFound_recordsErrorType() throws IOException { .isEqualTo("storage.googleapis.com"); } + @Test + public void initialize_unsuccessfulResponseHandlerReturnsFalseOn404_recordsOnce() + throws IOException { + StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); + AtomicBoolean handlerCalled = new AtomicBoolean(false); + HttpRequestInitializer delegate = + request -> + request.setUnsuccessfulResponseHandler( + (req, response, supportsRetry) -> { + handlerCalled.set(true); + return false; + }); + StorageHttpMetricsInterceptor interceptor = + new StorageHttpMetricsInterceptor( + delegate, metrics, clock, "https://storage.googleapis.com"); + + HttpTransport transport = createAdvancingTransport(404, 80_000_000L); + + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/missing-bucket")); + request.setThrowExceptionOnExecuteError(false); + request.execute(); + + assertThat(handlerCalled.get()).isTrue(); + + Collection metricData = reader.collectAllMetrics(); + MetricData durationData = + metricData.stream() + .filter( + m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .orElse(null); + + assertThat(durationData).isNotNull(); + Collection points = durationData.getHistogramData().getPoints(); + assertThat(points).hasSize(1); + HistogramPointData point = points.iterator().next(); + assertThat(point.getCount()).isEqualTo(1L); + assertThat(point.getSum()).isWithin(1e-6).of(0.08); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(404L); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("NOT_FOUND"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + } + @Test public void initialize_503ServiceUnavailable_recordsErrorType() throws IOException { StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); @@ -494,7 +561,15 @@ public void initialize_401RefreshRetryThen200_recordsBothAttempts() throws IOExc HttpRequestInitializer refreshDelegate = request -> request.setUnsuccessfulResponseHandler( - (req, response, supportsRetry) -> response.getStatusCode() == 401); + (req, response, supportsRetry) -> { + if (response.getStatusCode() == 401) { + // Simulate token refresh latency inside the UnsuccessfulResponseHandler; + // the 401 request duration must be captured before this handler runs. + clock.advanceNanos(200_000_000L); + return true; + } + return false; + }); StorageHttpMetricsInterceptor interceptor = new StorageHttpMetricsInterceptor( refreshDelegate, metrics, clock, "https://storage.googleapis.com"); From 572ea3339d963b31057060b08f1ada7a3584ae0f Mon Sep 17 00:00:00 2001 From: Nidhi Nandwani Date: Wed, 18 Nov 2026 09:19:24 +0000 Subject: [PATCH 8/8] fix(storage): address review comments on HTTP request duration metrics - Move recordHttpRequestDuration onto StorageClientMetrics building from baseAttributes and drop resolveServerAddress/host - Guard UnsuccessfulResponseHandler against BatchUnparsedResponse fake responses via response.getRequest() == req - Remove unreachable null/Math.max/UNKNOWN guards and unissued notifications/copyTo/watchAll URL template branches - Unify recordResponse helper sampling endNanos first across response hooks - Consolidate StorageHttpMetricsInterceptorTest into table-driven tests and add real BatchRequest 401 part retry test [Generated-by: AI] --- .../cloud/storage/StorageClientMetrics.java | 20 + .../StorageHttpMetricsInterceptor.java | 97 +-- .../cloud/storage/StorageMetricsContext.java | 28 +- .../google/cloud/storage/StorageOptions.java | 2 +- .../StorageHttpMetricsInterceptorTest.java | 814 +++++++----------- 5 files changed, 351 insertions(+), 610 deletions(-) diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClientMetrics.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClientMetrics.java index efcb506b4be1..2f8c326b909d 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClientMetrics.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageClientMetrics.java @@ -469,6 +469,26 @@ void recordRpcCallDuration( rpcClientCallDuration.record(durationSeconds, attributes, otelContext); } + void recordHttpRequestDuration( + double durationSeconds, + String httpMethod, + long statusCode, + String urlTemplate, + String errorType) { + if (httpClientRequestDuration == null) { + return; + } + Attributes attributes = + baseAttributes.toBuilder() + .put(KEY_HTTP_REQUEST_METHOD, httpMethod) + .put(KEY_HTTP_RESPONSE_STATUS_CODE, statusCode) + .put(KEY_NETWORK_PATH, NETWORK_PATH_CLOUDPATH) + .put(KEY_URL_TEMPLATE, urlTemplate) + .put(KEY_ERROR_TYPE, errorType) + .build(); + httpClientRequestDuration.record(durationSeconds, attributes, Context.current()); + } + @Nullable static StorageMetricsContext createContext( @Nullable StorageClientMetrics metrics, String operationName) { diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java index 713a034510f6..9aed94d4bb48 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageHttpMetricsInterceptor.java @@ -16,6 +16,8 @@ package com.google.cloud.storage; +import static java.util.Objects.requireNonNull; + import com.google.api.client.http.GenericUrl; import com.google.api.client.http.HttpExecuteInterceptor; import com.google.api.client.http.HttpIOExceptionHandler; @@ -45,22 +47,17 @@ final class StorageHttpMetricsInterceptor implements HttpRequestInitializer { private static final ImmutableSet OBJECT_SUB_RESOURCES = - ImmutableSet.of("acl", "compose", "restore", "watchAll"); + ImmutableSet.of("acl", "compose", "restore"); @Nullable private final HttpRequestInitializer delegate; - @Nullable private final StorageClientMetrics metrics; + private final StorageClientMetrics metrics; private final ApiClock clock; - @Nullable private final String defaultServerAddress; StorageHttpMetricsInterceptor( - @Nullable HttpRequestInitializer delegate, - @Nullable StorageClientMetrics metrics, - ApiClock clock, - @Nullable String host) { + @Nullable HttpRequestInitializer delegate, StorageClientMetrics metrics, ApiClock clock) { this.delegate = delegate; - this.metrics = metrics; - this.clock = clock; - this.defaultServerAddress = OpenTelemetryBootstrappingUtils.extractServerAddress(host); + this.metrics = requireNonNull(metrics, "metrics cannot be null"); + this.clock = requireNonNull(clock, "clock cannot be null"); } @Override @@ -68,9 +65,6 @@ public void initialize(HttpRequest request) throws IOException { if (delegate != null) { delegate.initialize(request); } - if (metrics == null || metrics.getHttpClientRequestDuration() == null) { - return; - } HttpExecuteInterceptor existingExec = request.getInterceptor(); HttpResponseInterceptor existingResp = request.getResponseInterceptor(); @@ -96,13 +90,8 @@ public void initialize(HttpRequest request) throws IOException { long endNanos = clock.nanoTime(); boolean handled = existingUnsuccessfulHandler.handleResponse(req, response, supportsRetry); - if (handled && recorded.compareAndSet(false, true)) { - int statusCode = response.getStatusCode(); - String errorType = - statusCode >= 400 - ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) - : StorageErrorTypeMapper.STATUS_OK; - recordDuration(req, startTimeNanos.get(), endNanos, (long) statusCode, errorType); + if (handled && response.getRequest() == req && recorded.compareAndSet(false, true)) { + recordResponse(req, startTimeNanos.get(), endNanos, response.getStatusCode()); } return handled; }); @@ -110,16 +99,12 @@ public void initialize(HttpRequest request) throws IOException { request.setResponseInterceptor( response -> { + long endNanos = clock.nanoTime(); if (existingResp != null) { existingResp.interceptResponse(response); } if (recorded.compareAndSet(false, true)) { - int statusCode = response.getStatusCode(); - String errorType = - statusCode >= 400 - ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) - : StorageErrorTypeMapper.STATUS_OK; - recordDuration(request, startTimeNanos.get(), (long) statusCode, errorType); + recordResponse(request, startTimeNanos.get(), endNanos, response.getStatusCode()); } }); @@ -132,7 +117,8 @@ public void initialize(HttpRequest request) throws IOException { recordDuration( req, startTimeNanos.get(), - StorageMetricsContext.HTTP_STATUS_UNSET, + clock.nanoTime(), + 0L, StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); } return existingIoHandler != null @@ -140,47 +126,26 @@ public void initialize(HttpRequest request) throws IOException { }); } - private void recordDuration( - HttpRequest request, long startNanos, long statusCode, String errorType) { - recordDuration(request, startNanos, clock.nanoTime(), statusCode, errorType); + private void recordResponse(HttpRequest request, long startNanos, long endNanos, int statusCode) { + String errorType = + statusCode >= 400 + ? StorageErrorTypeMapper.mapHttpResponseCode(statusCode) + : StorageErrorTypeMapper.STATUS_OK; + recordDuration(request, startNanos, endNanos, statusCode, errorType); } private void recordDuration( HttpRequest request, long startNanos, long endNanos, long statusCode, String errorType) { - if (metrics == null) { - return; - } - double durationSeconds = Math.max(0.0, (endNanos - startNanos) / 1_000_000_000.0); - String method = request.getRequestMethod() != null ? request.getRequestMethod() : "UNKNOWN"; - String urlTemplate = extractUrlTemplate(request.getUrl()); - String serverAddress = resolveServerAddress(request.getUrl(), defaultServerAddress); - - StorageMetricsContext.recordHttpRequestDuration( - metrics, durationSeconds, method, statusCode, urlTemplate, serverAddress, errorType); - } - - @Nullable - static String resolveServerAddress( - @Nullable GenericUrl url, @Nullable String defaultServerAddress) { - String host = url != null ? url.getHost() : null; - if (host == null || host.isEmpty()) { - return defaultServerAddress; - } - if (host.endsWith(".storage.googleapis.com") && !host.equals("storage.googleapis.com")) { - return "storage.googleapis.com"; - } - if (defaultServerAddress != null - && !defaultServerAddress.isEmpty() - && host.endsWith("." + defaultServerAddress)) { - return defaultServerAddress; - } - return host; + double durationSeconds = (endNanos - startNanos) / 1_000_000_000.0; + metrics.recordHttpRequestDuration( + durationSeconds, + request.getRequestMethod(), + statusCode, + extractUrlTemplate(request.getUrl()), + errorType); } - static String extractUrlTemplate(@Nullable GenericUrl url) { - if (url == null) { - return "/"; - } + static String extractUrlTemplate(GenericUrl url) { String path = url.getRawPath(); if (path == null || path.isEmpty()) { return "/"; @@ -233,8 +198,8 @@ private static String extractV1UrlTemplate(String rest) { if ("acl".equals(segments[2]) || "defaultObjectAcl".equals(segments[2])) { return "/storage/v1/b/{bucket}/" + segments[2] + "/{entity}"; } - if ("notificationConfigs".equals(segments[2]) || "notifications".equals(segments[2])) { - return "/storage/v1/b/{bucket}/" + segments[2] + "/{notification}"; + if ("notificationConfigs".equals(segments[2])) { + return "/storage/v1/b/{bucket}/notificationConfigs/{notification}"; } } return "/storage/v1/b/{bucket}/" + segments[2]; @@ -257,11 +222,11 @@ private static String extractObjectUrlTemplate(String[] segments) { return "/storage/v1/b/{bucket}/o/{object}"; } String action = segments[4]; - if (("copyTo".equals(action) || "rewriteTo".equals(action)) + if ("rewriteTo".equals(action) && segments.length >= 8 && "b".equals(segments[5]) && "o".equals(segments[7])) { - return "/storage/v1/b/{bucket}/o/{object}/" + action + "/b/{bucket}/o/{object}"; + return "/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{bucket}/o/{object}"; } if ("moveTo".equals(action) && segments.length >= 7 && "o".equals(segments[5])) { return "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"; diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java index b9ec159af610..37d97629ab94 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageMetricsContext.java @@ -44,7 +44,7 @@ final class StorageMetricsContext { CallOptions.Key.create("storage-metrics-context"); private static final long HTTP_STATUS_OK = 200L; - static final long HTTP_STATUS_UNSET = 0L; + private static final long HTTP_STATUS_UNSET = 0L; @Nullable private final StorageClientMetrics metrics; private final String operationName; @@ -273,32 +273,6 @@ void setNetworkPath(String networkPath) { this.networkPath = networkPath; } - static void recordHttpRequestDuration( - @Nullable StorageClientMetrics metrics, - double durationSeconds, - String httpMethod, - long statusCode, - String urlTemplate, - @Nullable String serverAddress, - String errorType) { - if (metrics == null || metrics.getHttpClientRequestDuration() == null) { - return; - } - Attributes attributes = - metrics - .clientAttributesBuilder() - .put(StorageClientMetrics.KEY_RPC_SYSTEM_NAME, "http") - .put(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD, httpMethod) - .put(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE, statusCode) - .put(StorageClientMetrics.KEY_NETWORK_PATH, StorageClientMetrics.NETWORK_PATH_CLOUDPATH) - .put(StorageClientMetrics.KEY_URL_TEMPLATE, urlTemplate) - .put( - StorageClientMetrics.KEY_SERVER_ADDRESS, serverAddress != null ? serverAddress : "") - .put(StorageClientMetrics.KEY_ERROR_TYPE, errorType) - .build(); - metrics.getHttpClientRequestDuration().record(durationSeconds, attributes, Context.current()); - } - /** * Populates both {@code rpc.response.status_code} and {@code http.response.status_code} on * attempt metrics so every {@code gcp.storage.client.attempts} data point emits a consistent set diff --git a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java index b1fa3a5ec16e..ffbe17f71bc3 100644 --- a/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java +++ b/java-storage/google-cloud-storage/src/main/java/com/google/cloud/storage/StorageOptions.java @@ -410,7 +410,7 @@ public HttpRequestInitializer decorateWithMetrics(@Nullable HttpRequestInitializ if (metrics == null) { return initializer; } - return new StorageHttpMetricsInterceptor(initializer, metrics, getClock(), getHost()); + return new StorageHttpMetricsInterceptor(initializer, metrics, getClock()); } /** diff --git a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java index 93eac115adfb..9499e9874dfa 100644 --- a/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java +++ b/java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/StorageHttpMetricsInterceptorTest.java @@ -17,9 +17,12 @@ package com.google.cloud.storage; import static com.google.common.truth.Truth.assertThat; -import static org.junit.Assert.assertThrows; +import static com.google.common.truth.Truth.assertWithMessage; +import com.google.api.client.googleapis.batch.BatchCallback; +import com.google.api.client.googleapis.batch.BatchRequest; import com.google.api.client.http.GenericUrl; +import com.google.api.client.http.HttpHeaders; import com.google.api.client.http.HttpRequest; import com.google.api.client.http.HttpRequestInitializer; import com.google.api.client.http.HttpTransport; @@ -29,13 +32,17 @@ import com.google.api.client.testing.http.MockLowLevelHttpRequest; import com.google.api.client.testing.http.MockLowLevelHttpResponse; import com.google.api.core.ApiClock; +import com.google.cloud.NoCredentials; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; import io.opentelemetry.api.common.Attributes; import io.opentelemetry.sdk.metrics.SdkMeterProvider; import io.opentelemetry.sdk.metrics.data.HistogramPointData; -import io.opentelemetry.sdk.metrics.data.MetricData; import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; import java.io.IOException; -import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Objects; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import org.junit.Before; @@ -44,309 +51,200 @@ public final class StorageHttpMetricsInterceptorTest { private InMemoryMetricReader reader; - private SdkMeterProvider meterProvider; private FakeClock clock; + private HttpStorageOptions httpOptions; + private StorageClientMetrics metrics; @Before public void setUp() { reader = InMemoryMetricReader.create(); - meterProvider = SdkMeterProvider.builder().registerMetricReader(reader).build(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(reader).build(); clock = new FakeClock(); + httpOptions = + StorageOptions.http() + .setProjectId("test-project") + .setCredentials(NoCredentials.getInstance()) + .setClock(clock) + .setEnableOtelMetrics(true) + .setMeterProvider(meterProvider) + .build(); + metrics = httpOptions.getStorageClientMetrics(); } @Test public void extractUrlTemplate_cases() { - assertThat(StorageHttpMetricsInterceptor.extractUrlTemplate(null)).isEqualTo("/"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/upload/storage/v1/b/my-b/o?upload_id=xyz"))) - .isEqualTo("/upload/storage/v1/b/{bucket}/o"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/upload/storage/v1/b/my-b/o"))) - .isEqualTo("/upload/storage/v1/b/{bucket}/o"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/download/storage/v1/b/my-b/o/my-obj"))) - .isEqualTo("/download/storage/v1/b/{bucket}/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/batch/storage/v1"))) - .isEqualTo("/batch/storage/v1"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b"))) - .isEqualTo("/storage/v1/b"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b?project=my-proj"))) - .isEqualTo("/storage/v1/b"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"))) - .isEqualTo("/storage/v1/b/{bucket}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o"))) - .isEqualTo("/storage/v1/b/{bucket}/o"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/my-b/o/dir/sub/file.txt"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/compose"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/compose"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/restore"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/restore"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/watchAll"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/watchAll"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/acl/{entity}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/o/o1/copyTo/b/b2/o/o2"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/copyTo/b/{bucket}/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/o/o1/rewriteTo/b/b2/o/o2"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{bucket}/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/o/o1/moveTo/o/o2"))) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl"))) - .isEqualTo("/storage/v1/b/{bucket}/acl"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/acl/{entity}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl"))) - .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl/allUsers"))) - .isEqualTo("/storage/v1/b/{bucket}/defaultObjectAcl/{entity}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs"))) - .isEqualTo("/storage/v1/b/{bucket}/notificationConfigs"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs/notif1"))) - .isEqualTo("/storage/v1/b/{bucket}/notificationConfigs/{notification}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/b1/iam"))) - .isEqualTo("/storage/v1/b/{bucket}/iam"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/b/b1/iam/testPermissions"))) - .isEqualTo("/storage/v1/b/{bucket}/iam/testPermissions"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/projects/my-p/hmacKeys/key1"))) - .isEqualTo("/storage/v1/projects/{project}/hmacKeys/{access_id}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl( - "https://storage.googleapis.com/storage/v1/projects/my-p/serviceAccount"))) - .isEqualTo("/storage/v1/projects/{project}/serviceAccount"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/my-b"))) - .isEqualTo("/{bucket}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/my-b/my-obj"))) - .isEqualTo("/{bucket}/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/my-b/my-obj?upload_id=xyz"))) - .isEqualTo("/{bucket}/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://storage.googleapis.com/"))) - .isEqualTo("/"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://my-bucket.storage.googleapis.com/"))) - .isEqualTo("/"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://my-bucket.storage.googleapis.com/my-obj"))) - .isEqualTo("/{object}"); - assertThat( - StorageHttpMetricsInterceptor.extractUrlTemplate( - new GenericUrl("https://my-bucket.storage.googleapis.com/dir/my-obj"))) - .isEqualTo("/{object}"); - } - - @Test - public void resolveServerAddress_stripsVirtualHostedBucketPrefix() { - assertThat( - StorageHttpMetricsInterceptor.resolveServerAddress( - new GenericUrl("https://my-bucket.storage.googleapis.com/my-obj"), - "storage.googleapis.com")) - .isEqualTo("storage.googleapis.com"); - assertThat( - StorageHttpMetricsInterceptor.resolveServerAddress( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b"), - "storage.googleapis.com")) - .isEqualTo("storage.googleapis.com"); - assertThat(StorageHttpMetricsInterceptor.resolveServerAddress(null, "storage.googleapis.com")) - .isEqualTo("storage.googleapis.com"); - } - - @Test - public void initialize_200Ok_recordsDurationWithoutErrorType() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = createAdvancingTransport(200, 250_000_000L); - - HttpRequest request = - transport - .createRequestFactory(interceptor) - .buildGetRequest( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); - request.execute(); - - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - assertThat(durationData.getHistogramData().getPoints()).hasSize(1); - HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); - assertThat(point.getSum()).isWithin(1e-6).of(0.25); - - Attributes attrs = point.getAttributes(); - assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD)).isEqualTo("GET"); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(200L); - assertThat(attrs.get(StorageClientMetrics.KEY_NETWORK_PATH)) - .isEqualTo(StorageClientMetrics.NETWORK_PATH_CLOUDPATH); - assertThat(attrs.get(StorageClientMetrics.KEY_URL_TEMPLATE)) - .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); - assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) - .isEqualTo("storage.googleapis.com"); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("OK"); - } - - @Test - public void initialize_308ResumeIncomplete_recordsWithoutErrorType() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = createAdvancingTransport(308, 120_000_000L); - - HttpRequest request = - transport - .createRequestFactory(interceptor) - .buildPutRequest( - new GenericUrl( - "https://storage.googleapis.com/upload/storage/v1/b/my-b/o?upload_id=123"), - null); - request.setThrowExceptionOnExecuteError(false); - request.execute(); + String[][] cases = { + {"https://storage.googleapis.com", "/"}, + {"https://storage.googleapis.com/", "/"}, + { + "https://storage.googleapis.com/upload/storage/v1/b/my-b/o", + "/upload/storage/v1/b/{bucket}/o" + }, + { + "https://storage.googleapis.com/download/storage/v1/b/my-b/o/my-obj", + "/download/storage/v1/b/{bucket}/o/{object}" + }, + {"https://storage.googleapis.com/batch/storage/v1", "/batch/storage/v1"}, + {"https://storage.googleapis.com/storage/v1/b", "/storage/v1/b"}, + {"https://storage.googleapis.com/storage/v1/b/my-b", "/storage/v1/b/{bucket}"}, + {"https://storage.googleapis.com/storage/v1/b/my-b/o", "/storage/v1/b/{bucket}/o"}, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj", + "/storage/v1/b/{bucket}/o/{object}" + }, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/dir/sub/file.txt", + "/storage/v1/b/{bucket}/o/{object}" + }, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/compose", + "/storage/v1/b/{bucket}/o/{object}/compose" + }, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/restore", + "/storage/v1/b/{bucket}/o/{object}/restore" + }, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl", + "/storage/v1/b/{bucket}/o/{object}/acl" + }, + { + "https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj/acl/allUsers", + "/storage/v1/b/{bucket}/o/{object}/acl/{entity}" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/o/o1/rewriteTo/b/b2/o/o2", + "/storage/v1/b/{bucket}/o/{object}/rewriteTo/b/{bucket}/o/{object}" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/o/o1/moveTo/o/o2", + "/storage/v1/b/{bucket}/o/{object}/moveTo/o/{object}" + }, + {"https://storage.googleapis.com/storage/v1/b/b1/acl", "/storage/v1/b/{bucket}/acl"}, + { + "https://storage.googleapis.com/storage/v1/b/b1/acl/allUsers", + "/storage/v1/b/{bucket}/acl/{entity}" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl", + "/storage/v1/b/{bucket}/defaultObjectAcl" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/defaultObjectAcl/allUsers", + "/storage/v1/b/{bucket}/defaultObjectAcl/{entity}" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs", + "/storage/v1/b/{bucket}/notificationConfigs" + }, + { + "https://storage.googleapis.com/storage/v1/b/b1/notificationConfigs/notif1", + "/storage/v1/b/{bucket}/notificationConfigs/{notification}" + }, + {"https://storage.googleapis.com/storage/v1/b/b1/iam", "/storage/v1/b/{bucket}/iam"}, + { + "https://storage.googleapis.com/storage/v1/b/b1/iam/testPermissions", + "/storage/v1/b/{bucket}/iam/testPermissions" + }, + { + "https://storage.googleapis.com/storage/v1/projects/my-p/hmacKeys/key1", + "/storage/v1/projects/{project}/hmacKeys/{access_id}" + }, + { + "https://storage.googleapis.com/storage/v1/projects/my-p/serviceAccount", + "/storage/v1/projects/{project}/serviceAccount" + }, + {"https://storage.googleapis.com/my-b", "/{bucket}"}, + {"https://storage.googleapis.com/my-b/my-obj", "/{bucket}/{object}"}, + {"https://my-bucket.storage.googleapis.com/", "/"}, + {"https://my-bucket.storage.googleapis.com/my-obj", "/{object}"}, + {"https://my-bucket.storage.googleapis.com/dir/my-obj", "/{object}"}, + }; - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); - assertThat(point.getSum()).isWithin(1e-6).of(0.12); - Attributes attrs = point.getAttributes(); - assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(308L); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("OK"); - assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) - .isEqualTo("storage.googleapis.com"); + for (String[] testCase : cases) { + String url = testCase[0]; + String expectedTemplate = testCase[1]; + assertWithMessage(url) + .that(StorageHttpMetricsInterceptor.extractUrlTemplate(new GenericUrl(url))) + .isEqualTo(expectedTemplate); + } } @Test - public void initialize_404NotFound_recordsErrorType() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = createAdvancingTransport(404, 80_000_000L); - - HttpRequest request = - transport - .createRequestFactory(interceptor) - .buildGetRequest( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/missing-bucket")); - request.setThrowExceptionOnExecuteError(false); - request.execute(); + public void initialize_statusCodes_recordsDurationAndErrorType() throws IOException { + Map cases = + ImmutableMap.of( + 200, "OK", + 308, "OK", + 503, "UNAVAILABLE"); + + for (int statusCode : cases.keySet()) { + AtomicBoolean delegateCalled = new AtomicBoolean(false); + AtomicBoolean execCalled = new AtomicBoolean(false); + AtomicBoolean respCalled = new AtomicBoolean(false); + HttpRequestInitializer delegate = + request -> { + delegateCalled.set(true); + request.setInterceptor(req -> execCalled.set(true)); + request.setResponseInterceptor( + resp -> { + clock.advanceNanos(50_000_000L); + respCalled.set(true); + }); + }; + HttpRequestInitializer interceptor = httpOptions.decorateWithMetrics(delegate); + + HttpTransport transport = createAdvancingTransport(statusCode, 250_000_000L); + HttpRequest request = + transport + .createRequestFactory(interceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); + if (statusCode != 200) { + request.setThrowExceptionOnExecuteError(false); + } + request.execute(); - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); + assertWithMessage("status=%s", statusCode).that(delegateCalled.get()).isTrue(); + assertWithMessage("status=%s", statusCode).that(execCalled.get()).isTrue(); + assertWithMessage("status=%s", statusCode).that(respCalled.get()).isTrue(); + } - assertThat(durationData).isNotNull(); - HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); - assertThat(point.getSum()).isWithin(1e-6).of(0.08); - Attributes attrs = point.getAttributes(); - assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(404L); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("NOT_FOUND"); - assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) - .isEqualTo("storage.googleapis.com"); + List points = durationPoints(); + assertThat(points).hasSize(cases.size()); + for (Map.Entry entry : cases.entrySet()) { + long statusCode = entry.getKey(); + HistogramPointData point = findPointByStatus(points, statusCode); + assertWithMessage("status=%s", statusCode).that(point.getCount()).isEqualTo(1L); + assertWithMessage("status=%s", statusCode).that(point.getSum()).isWithin(1e-6).of(0.25); + + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_GCP_CLIENT_SERVICE)) + .isEqualTo(StorageClientMetrics.SERVICE_STORAGE); + assertThat(attrs.get(StorageClientMetrics.KEY_GCP_CLIENT_VERSION)) + .isEqualTo(StorageOptions.version()); + assertThat(attrs.get(StorageClientMetrics.KEY_GCP_CLIENT_ARTIFACT)) + .isEqualTo(StorageClientMetrics.ARTIFACT_STORAGE); + assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD)).isEqualTo("GET"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)) + .isEqualTo(statusCode); + assertThat(attrs.get(StorageClientMetrics.KEY_NETWORK_PATH)) + .isEqualTo(StorageClientMetrics.NETWORK_PATH_CLOUDPATH); + assertThat(attrs.get(StorageClientMetrics.KEY_URL_TEMPLATE)) + .isEqualTo("/storage/v1/b/{bucket}/o/{object}"); + assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); + assertWithMessage("status=%s", statusCode) + .that(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(entry.getValue()); + } } @Test public void initialize_unsuccessfulResponseHandlerReturnsFalseOn404_recordsOnce() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); AtomicBoolean handlerCalled = new AtomicBoolean(false); HttpRequestInitializer delegate = request -> @@ -356,11 +254,9 @@ public void initialize_unsuccessfulResponseHandlerReturnsFalseOn404_recordsOnce( return false; }); StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor( - delegate, metrics, clock, "https://storage.googleapis.com"); + new StorageHttpMetricsInterceptor(delegate, metrics, clock); HttpTransport transport = createAdvancingTransport(404, 80_000_000L); - HttpRequest request = transport .createRequestFactory(interceptor) @@ -371,18 +267,9 @@ public void initialize_unsuccessfulResponseHandlerReturnsFalseOn404_recordsOnce( assertThat(handlerCalled.get()).isTrue(); - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - Collection points = durationData.getHistogramData().getPoints(); + List points = durationPoints(); assertThat(points).hasSize(1); - HistogramPointData point = points.iterator().next(); + HistogramPointData point = points.get(0); assertThat(point.getCount()).isEqualTo(1L); assertThat(point.getSum()).isWithin(1e-6).of(0.08); Attributes attrs = point.getAttributes(); @@ -393,97 +280,13 @@ public void initialize_unsuccessfulResponseHandlerReturnsFalseOn404_recordsOnce( .isEqualTo("storage.googleapis.com"); } - @Test - public void initialize_503ServiceUnavailable_recordsErrorType() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = createAdvancingTransport(503, 400_000_000L); - - HttpRequest request = - transport - .createRequestFactory(interceptor) - .buildGetRequest( - new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); - request.setThrowExceptionOnExecuteError(false); - request.execute(); - - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); - assertThat(point.getSum()).isWithin(1e-6).of(0.40); - Attributes attrs = point.getAttributes(); - assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(503L); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)).isEqualTo("UNAVAILABLE"); - assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) - .isEqualTo("storage.googleapis.com"); - } - - @Test - public void initialize_networkIOException_recordsErrorTypeWithoutStatusCode() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = - new MockHttpTransport() { - @Override - public LowLevelHttpRequest buildRequest(String method, String url) { - return new MockLowLevelHttpRequest() { - @Override - public LowLevelHttpResponse execute() throws IOException { - clock.advanceNanos(150_000_000L); - throw new IOException("Connection reset by peer"); - } - }; - } - }; - - HttpRequest req = - transport - .createRequestFactory(interceptor) - .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); - - assertThrows(IOException.class, req::execute); - - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - HistogramPointData point = durationData.getHistogramData().getPoints().iterator().next(); - assertThat(point.getSum()).isWithin(1e-6).of(0.15); - Attributes attrs = point.getAttributes(); - assertThat(attrs.get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)).isEqualTo("http"); - assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)) - .isEqualTo(StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); - assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(0L); - assertThat(attrs.get(StorageClientMetrics.KEY_SERVER_ADDRESS)) - .isEqualTo("storage.googleapis.com"); - } - @Test public void initialize_ioExceptionThenRetrySucceeds_recordsTwoPoints() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); AtomicBoolean firstAttempt = new AtomicBoolean(true); HttpRequestInitializer retryDelegate = request -> request.setIOExceptionHandler((req, supportsRetry) -> true); StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor( - retryDelegate, metrics, clock, "https://storage.googleapis.com"); + new StorageHttpMetricsInterceptor(retryDelegate, metrics, clock); HttpTransport transport = new MockHttpTransport() { @@ -511,44 +314,19 @@ public LowLevelHttpResponse execute() throws IOException { .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); req.execute(); - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - Collection points = durationData.getHistogramData().getPoints(); + List points = durationPoints(); assertThat(points).hasSize(2); - HistogramPointData errorPoint = - points.stream() - .filter( - p -> - Long.valueOf(0L) - .equals( - p.getAttributes() - .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) - .findFirst() - .orElse(null); - assertThat(errorPoint).isNotNull(); + HistogramPointData errorPoint = findPointByStatus(points, 0L); assertThat(errorPoint.getSum()).isWithin(1e-6).of(0.10); + assertThat(errorPoint.getAttributes().get(StorageClientMetrics.KEY_RPC_SYSTEM_NAME)) + .isEqualTo("http"); + assertThat(errorPoint.getAttributes().get(StorageClientMetrics.KEY_SERVER_ADDRESS)) + .isEqualTo("storage.googleapis.com"); assertThat(errorPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) .isEqualTo(StorageErrorTypeMapper.STATUS_CONNECTION_ERROR); - HistogramPointData okPoint = - points.stream() - .filter( - p -> - Long.valueOf(200L) - .equals( - p.getAttributes() - .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) - .findFirst() - .orElse(null); - assertThat(okPoint).isNotNull(); + HistogramPointData okPoint = findPointByStatus(points, 200L); assertThat(okPoint.getSum()).isWithin(1e-6).of(0.20); assertThat(okPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) .isEqualTo(StorageErrorTypeMapper.STATUS_OK); @@ -556,7 +334,6 @@ public LowLevelHttpResponse execute() throws IOException { @Test public void initialize_401RefreshRetryThen200_recordsBothAttempts() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); AtomicBoolean firstAttempt = new AtomicBoolean(true); HttpRequestInitializer refreshDelegate = request -> @@ -571,8 +348,7 @@ public void initialize_401RefreshRetryThen200_recordsBothAttempts() throws IOExc return false; }); StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor( - refreshDelegate, metrics, clock, "https://storage.googleapis.com"); + new StorageHttpMetricsInterceptor(refreshDelegate, metrics, clock); HttpTransport transport = new MockHttpTransport() { @@ -601,126 +377,132 @@ public LowLevelHttpResponse execute() { .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); req.execute(); - Collection metricData = reader.collectAllMetrics(); - MetricData durationData = - metricData.stream() - .filter( - m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) - .findFirst() - .orElse(null); - - assertThat(durationData).isNotNull(); - Collection points = durationData.getHistogramData().getPoints(); + List points = durationPoints(); assertThat(points).hasSize(2); - HistogramPointData unauthorizedPoint = - points.stream() - .filter( - p -> - Long.valueOf(401L) - .equals( - p.getAttributes() - .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) - .findFirst() - .orElse(null); - assertThat(unauthorizedPoint).isNotNull(); + HistogramPointData unauthorizedPoint = findPointByStatus(points, 401L); assertThat(unauthorizedPoint.getSum()).isWithin(1e-6).of(0.09); assertThat(unauthorizedPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) .isEqualTo("UNAUTHENTICATED"); - HistogramPointData okPoint = - points.stream() - .filter( - p -> - Long.valueOf(200L) - .equals( - p.getAttributes() - .get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE))) - .findFirst() - .orElse(null); - assertThat(okPoint).isNotNull(); + HistogramPointData okPoint = findPointByStatus(points, 200L); assertThat(okPoint.getSum()).isWithin(1e-6).of(0.18); assertThat(okPoint.getAttributes().get(StorageClientMetrics.KEY_ERROR_TYPE)) .isEqualTo(StorageErrorTypeMapper.STATUS_OK); } @Test - public void initialize_ioExceptionBeforeExecuteInterceptorRuns_doesNotRecordMetric() - throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = new MockHttpTransport(); - HttpRequest req = - transport - .createRequestFactory(interceptor) - .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); + public void initialize_batchPart401_doesNotRecordPartDuration() throws IOException { + AtomicBoolean refreshHandlerCalled = new AtomicBoolean(false); + AtomicBoolean partSucceeded = new AtomicBoolean(false); + AtomicBoolean firstBatch = new AtomicBoolean(true); - clock.advanceNanos(500_000_000L); - boolean handled = req.getIOExceptionHandler().handleIOException(req, false); - - assertThat(handled).isFalse(); - assertThat(reader.collectAllMetrics()).isEmpty(); - } - - @Test - public void initialize_chainsExistingDelegateAndInterceptors() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, true, false); - AtomicBoolean delegateCalled = new AtomicBoolean(false); - AtomicBoolean execCalled = new AtomicBoolean(false); - AtomicBoolean respCalled = new AtomicBoolean(false); - AtomicBoolean ioHandlerCalled = new AtomicBoolean(false); + HttpRequestInitializer refreshDelegate = + request -> + request.setUnsuccessfulResponseHandler( + (req, response, supportsRetry) -> { + if (response.getStatusCode() == 401) { + refreshHandlerCalled.set(true); + return true; + } + return false; + }); + StorageHttpMetricsInterceptor partInterceptor = + new StorageHttpMetricsInterceptor(refreshDelegate, metrics, clock); + StorageHttpMetricsInterceptor batchInterceptor = + new StorageHttpMetricsInterceptor(null, metrics, clock); - HttpRequestInitializer delegate = - request -> { - delegateCalled.set(true); - request.setInterceptor(req -> execCalled.set(true)); - request.setResponseInterceptor(resp -> respCalled.set(true)); - request.setIOExceptionHandler( - (req, supportsRetry) -> { - ioHandlerCalled.set(true); - return false; - }); + HttpTransport transport = + new MockHttpTransport() { + @Override + public LowLevelHttpRequest buildRequest(String method, String url) { + return new MockLowLevelHttpRequest() { + @Override + public LowLevelHttpResponse execute() { + clock.advanceNanos(100_000_000L); + String partStatusLine = + firstBatch.compareAndSet(true, false) + ? "HTTP/1.1 401 Unauthorized" + : "HTTP/1.1 200 OK"; + String body = + "--batch_boundary\r\n" + + "Content-Type: application/http\r\n" + + "\r\n" + + partStatusLine + + "\r\n" + + "\r\n" + + "--batch_boundary--\r\n"; + MockLowLevelHttpResponse response = new MockLowLevelHttpResponse(); + response.setStatusCode(200); + response.setContentType("multipart/mixed; boundary=batch_boundary"); + response.setContent(body); + return response; + } + }; + } }; - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor( - delegate, metrics, clock, "https://storage.googleapis.com"); - - HttpTransport transport = createAdvancingTransport(200, 100_000_000L); - HttpRequest request = + HttpRequest partRequest = transport - .createRequestFactory(interceptor) - .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); - request.execute(); + .createRequestFactory(partInterceptor) + .buildGetRequest( + new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b/o/my-obj")); - assertThat(delegateCalled.get()).isTrue(); - assertThat(execCalled.get()).isTrue(); - assertThat(respCalled.get()).isTrue(); + BatchRequest batchRequest = new BatchRequest(transport, batchInterceptor); + batchRequest.setBatchUrl(new GenericUrl("https://storage.googleapis.com/batch/storage/v1")); + batchRequest.setSleeper(millis -> {}); + batchRequest.queue( + partRequest, + Void.class, + Void.class, + new BatchCallback() { + @Override + public void onSuccess(Void t, HttpHeaders responseHeaders) { + partSucceeded.set(true); + } - request.getIOExceptionHandler().handleIOException(request, false); - assertThat(ioHandlerCalled.get()).isTrue(); - } + @Override + public void onFailure(Void e, HttpHeaders responseHeaders) { + throw new AssertionError("Expected retried batch part to succeed"); + } + }); - @Test - public void initialize_metricsDisabled_doesNotRecord() throws IOException { - StorageClientMetrics metrics = StorageClientMetrics.create(meterProvider, false, false); - StorageHttpMetricsInterceptor interceptor = - new StorageHttpMetricsInterceptor(null, metrics, clock, "https://storage.googleapis.com"); + batchRequest.execute(); - MockLowLevelHttpResponse lowLevelResponse = new MockLowLevelHttpResponse(); - lowLevelResponse.setStatusCode(200); - HttpTransport transport = - new MockHttpTransport.Builder().setLowLevelHttpResponse(lowLevelResponse).build(); + assertThat(refreshHandlerCalled.get()).isTrue(); + assertThat(partSucceeded.get()).isTrue(); - HttpRequest request = - transport - .createRequestFactory(interceptor) - .buildGetRequest(new GenericUrl("https://storage.googleapis.com/storage/v1/b/my-b")); - request.execute(); + List points = durationPoints(); + assertThat(points).hasSize(1); + HistogramPointData point = points.get(0); + assertThat(point.getCount()).isEqualTo(2L); + assertThat(point.getSum()).isWithin(1e-6).of(0.20); + Attributes attrs = point.getAttributes(); + assertThat(attrs.get(StorageClientMetrics.KEY_URL_TEMPLATE)).isEqualTo("/batch/storage/v1"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_REQUEST_METHOD)).isEqualTo("POST"); + assertThat(attrs.get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE)).isEqualTo(200L); + assertThat(attrs.get(StorageClientMetrics.KEY_ERROR_TYPE)) + .isEqualTo(StorageErrorTypeMapper.STATUS_OK); + } + + private List durationPoints() { + return reader.collectAllMetrics().stream() + .filter(m -> m.getName().equals(StorageClientMetrics.METRIC_HTTP_CLIENT_REQUEST_DURATION)) + .findFirst() + .map(m -> ImmutableList.copyOf(m.getHistogramData().getPoints())) + .orElse(ImmutableList.of()); + } - assertThat(reader.collectAllMetrics()).isEmpty(); + private static HistogramPointData findPointByStatus( + List points, long statusCode) { + return points.stream() + .filter( + p -> + Objects.equals( + p.getAttributes().get(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE), + statusCode)) + .findFirst() + .orElseThrow(() -> new AssertionError("No point for status " + statusCode)); } private HttpTransport createAdvancingTransport(int statusCode, long advanceNanos) {