Repository navigation
feat(storage): OpenTelemetry client metrics instrument registry and views - #14398
Open
nidhiii-27 wants to merge 8 commits into
Open
nidhiii-27 wants to merge 8 commits into
nidhiii-27 wants to merge 8 commits into
Conversation
…nfiguration - Add configuration options to StorageOptions, GrpcStorageOptions, and HttpStorageOptions (enableOtelMetrics, enableOtelDebugMetrics, meterProvider, metricInterval). - Add development gate checking system properties and environment variables in StorageMetricsConfig. - Implement package-private instrument registry in StorageClientMetrics. - Update OpenTelemetryBootstrappingUtils to register client views with custom histogram boundaries and create client meter provider. - Add comprehensive unit tests in StorageOptionsTest, StorageClientMetricsTest, and OpenTelemetryBootstrappingUtilsTest.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces OpenTelemetry client metrics support for Google Cloud Storage, allowing standard and debug metrics to be configured and recorded for both HTTP and gRPC transports. It adds configuration options to StorageOptions, GrpcStorageOptions, and HttpStorageOptions for enabling metrics, setting custom meter providers, and defining export intervals, supported by a new StorageMetricsConfig utility and StorageClientMetrics registry. Feedback on the changes suggests importing java.time.Duration to avoid using fully qualified class names throughout GrpcStorageOptions.java and OpenTelemetryBootstrappingUtils.java, which will improve code readability and consistency.
Apply spotify fmt-maven-plugin formatting to StorageMetricsConfig, StorageClientMetrics, StorageOptionsTest, and StorageClientMetricsTest. [Generated-by: AI]
Use simple class name Duration instead of fully qualified java.time.Duration in GrpcStorageOptions and OpenTelemetryBootstrappingUtils. [Generated-by: AI]
…trappingUtils Apply spotify fmt-maven-plugin formatting to OpenTelemetryBootstrappingUtils. [Generated-by: AI]
nidhiii-27
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
…nd views [Generated-by: AI]
nidhiii-27
changed the title
nidhiii-27
added this pull request to stack #14485
September 23, 2026 10:36
… metrics Refactor addClientHistogramView in OpenTelemetryBootstrappingUtils to remove unit selector and custom view description, preserving instrument default descriptions. Remove deferred Phase 2 connection metrics (dnsLookupDuration, tcpConnectDuration, tlsHandshakeDuration) from StorageClientMetrics, CLIENT_LATENCY_HISTOGRAMS, and StorageClientMetricsTest. Ensure clean Duration imports. [Generated-by: AI]
…rProvider Default api parameter to "grpc" instead of "storage" in createClientMeterProvider, allow specifying "json" / "http" transport protocols for Cloud Monitoring monitored resource storage.googleapis.com/Client, and add unit test coverage in OpenTelemetryBootstrappingUtilsTest. [Generated-by: AI]
nidhiii-27
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
cpriti-os
requested changes
Oct 7, 2026
Contributor
There was a problem hiding this comment.
Requesting changes mainly for the metric types/names and for accuracy of the recorded data (see inline comments).
One question on the overall design: createMeterProvider is only reached from enableGrpcMetrics(). Please state in the PR description how metrics are exported for HttpStorageOptions when metrics are enabled and no MeterProvider is supplied; both transports are expected to export through the same SDK-owned provider.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR implements Phase 1 (Core Metrics Registry & Views) of the OpenTelemetry Client Metrics feature in the Java Cloud Storage SDK (
google-cloud-storage).Following review feedback and architectural alignment with other Storage SDKs, this PR focuses strictly on the package-private instrument registry and OpenTelemetry view/histogram boundary bootstrapping, decoupling it from public options and configuration APIs (split into companion follow-up PR #14484).
Key Changes
Instrument Registry (
StorageClientMetrics)rpc.client.call.duration(s)http.client.request.duration(s)gcp.client.request.duration(s)gcp.storage.client.operations(1)gcp.storage.client.attempts(1)gcp.storage.client.errors(1)gcp.storage.client.operation.ttfb(s)gcp.storage.client.request.body.size(By)gcp.storage.client.response.body.size(By)gcp.storage.client.request.active(1)gcp.storage.client.gfe.duration(s)gcp.storage.client.gfe.header_missing(1)gcp.storage.client.stall.duration(s)gcp.storage.client.network.bytes.sent(By)gcp.storage.client.network.bytes.received(By)gcp.storage.client.auth.credential_refresh.duration(s)dns.lookup.duration,tcp.connect.duration,tls.handshake.duration) as deferred placeholders.OpenTelemetry Bootstrapping (
OpenTelemetryBootstrappingUtils)CLIENT_LATENCY_HISTOGRAMSusing 2ms-resolution exponential buckets.CLIENT_SIZE_HISTOGRAMSusing 128KiB to 16GiB buckets.createClientMeterProviderwithstorage.googleapis.com/Clientmonitored resource.Testing
opentelemetry-sdk-testingtopom.xml.StorageClientMetricsTestverifying instrument registration and custom view boundaries viaInMemoryMetricReader.OpenTelemetryBootstrappingUtilsTest.[Generated-by: AI]