Repository navigation
feat(storage): add gcp.storage.client.response.body.size metric for read operations - #14747
nidhiii-27 wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request implements response body size tracking for the 'ReadObject' operation across both gRPC and JSON implementations of Google Cloud Storage, updating BaseStorageReadChannel, GrpcStorageImpl, StorageImpl, and StorageMetricsContext, along with adding corresponding unit tests. The review feedback suggests refactoring a long chain of excluded key checks in StorageMetricsContext into a static Set constant to improve maintainability, and replacing fully qualified class names with imports in the new test cases to enhance readability.
| baseAttributes.forEach( | ||
| (key, val) -> { | ||
| if (!key.equals(StorageClientMetrics.KEY_NETWORK_PATH) | ||
| && !key.equals(StorageClientMetrics.KEY_RPC_RESPONSE_STATUS_CODE) | ||
| && !key.equals(StorageClientMetrics.KEY_HTTP_RESPONSE_STATUS_CODE) | ||
| && !key.equals(StorageClientMetrics.KEY_ERROR_TYPE) | ||
| && !key.equals(StorageClientMetrics.KEY_GCP_STORAGE_OPERATION) | ||
| && !key.equals(StorageClientMetrics.KEY_GCP_CLIENT_METHOD)) { | ||
| @SuppressWarnings("unchecked") | ||
| AttributeKey<Object> objKey = (AttributeKey<Object>) key; | ||
| bodyAttrBuilder.put(objKey, val); | ||
| } | ||
| }); |
There was a problem hiding this comment.
To improve maintainability and readability, avoid duplicating the long chain of !key.equals(...) checks. Instead, define a private static final Set<AttributeKey<?>> EXCLUDED_KEYS constant containing the excluded keys, and use !EXCLUDED_KEYS.contains(key) here.
baseAttributes.forEach(
(key, val) -> {
if (!EXCLUDED_KEYS.contains(key)) {
@SuppressWarnings("unchecked")
AttributeKey<Object> objKey = (AttributeKey<Object>) key;
bodyAttrBuilder.put(objKey, val);
}
});| io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader reader = | ||
| io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader.create(); | ||
| io.opentelemetry.sdk.metrics.SdkMeterProvider provider = | ||
| io.opentelemetry.sdk.metrics.SdkMeterProvider.builder() | ||
| .registerMetricReader(reader) | ||
| .build(); | ||
| StorageClientMetrics metrics = StorageClientMetrics.create(provider, true, false); | ||
|
|
||
| StorageMetricsContext context = StorageMetricsContext.create("ReadObject"); | ||
| context.setResponseBytes(4096L); | ||
| context.recordOperation(metrics, null); | ||
|
|
||
| java.util.Collection<io.opentelemetry.sdk.metrics.data.MetricData> collected = | ||
| reader.collectAllMetrics(); | ||
| io.opentelemetry.sdk.metrics.data.MetricData bodySizeData = | ||
| collected.stream() | ||
| .filter( | ||
| m -> | ||
| m.getName() | ||
| .equals(StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_RESPONSE_BODY_SIZE)) | ||
| .findFirst() | ||
| .orElse(null); | ||
|
|
||
| assertThat(bodySizeData).isNotNull(); | ||
| assertThat(bodySizeData.getHistogramData().getPoints()).hasSize(1); | ||
| io.opentelemetry.sdk.metrics.data.HistogramPointData point = | ||
| bodySizeData.getHistogramData().getPoints().iterator().next(); |
There was a problem hiding this comment.
Avoid using fully qualified class names (such as io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader) when they can be imported. This unnecessarily reduces code readability and violates the project's general rules.
InMemoryMetricReader reader = InMemoryMetricReader.create();
SdkMeterProvider provider =
SdkMeterProvider.builder()
.registerMetricReader(reader)
.build();
StorageClientMetrics metrics = StorageClientMetrics.create(provider, true, false);
StorageMetricsContext context = StorageMetricsContext.create("ReadObject");
context.setResponseBytes(4096L);
context.recordOperation(metrics, null);
Collection<MetricData> collected = reader.collectAllMetrics();
MetricData bodySizeData =
collected.stream()
.filter(
m ->
m.getName()
.equals(StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_RESPONSE_BODY_SIZE))
.findFirst()
.orElse(null);
assertThat(bodySizeData).isNotNull();
assertThat(bodySizeData.getHistogramData().getPoints()).hasSize(1);
HistogramPointData point =
bodySizeData.getHistogramData().getPoints().iterator().next();References
- Do not use fully qualified class names if there is no class name conflict in the file and the class is already imported, as it unnecessarily reduces code readability.
There was a problem hiding this comment.
Code Review
This pull request introduces tracking and recording of response body size metrics for "ReadObject" operations across both GRPC and JSON/HTTP storage implementations. It updates BaseStorageReadChannel, GrpcStorageImpl, and StorageImpl to capture the read or downloaded bytes and set them in the StorageMetricsContext, which now records the response body size metric. Corresponding unit tests are also added to StorageMetricsContextTest. The reviewer suggested avoiding the use of fully qualified class names in the new test cases to improve code readability, recommending importing them instead.
| io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader reader = | ||
| io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader.create(); | ||
| io.opentelemetry.sdk.metrics.SdkMeterProvider provider = | ||
| io.opentelemetry.sdk.metrics.SdkMeterProvider.builder() | ||
| .registerMetricReader(reader) | ||
| .build(); | ||
| StorageClientMetrics metrics = StorageClientMetrics.create(provider, true, false); | ||
|
|
||
| StorageMetricsContext context = StorageMetricsContext.create("ReadObject"); | ||
| context.setResponseBytes(4096L); | ||
| context.recordOperation(metrics, null); | ||
|
|
||
| java.util.Collection<io.opentelemetry.sdk.metrics.data.MetricData> collected = | ||
| reader.collectAllMetrics(); | ||
| io.opentelemetry.sdk.metrics.data.MetricData bodySizeData = | ||
| collected.stream() | ||
| .filter( | ||
| m -> | ||
| m.getName() | ||
| .equals(StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_RESPONSE_BODY_SIZE)) | ||
| .findFirst() | ||
| .orElse(null); | ||
|
|
||
| assertThat(bodySizeData).isNotNull(); | ||
| assertThat(bodySizeData.getHistogramData().getPoints()).hasSize(1); | ||
| io.opentelemetry.sdk.metrics.data.HistogramPointData point = | ||
| bodySizeData.getHistogramData().getPoints().iterator().next(); | ||
| assertThat(point.getCount()).isEqualTo(1L); | ||
| assertThat(point.getSum()).isEqualTo(4096.0); | ||
| assertThat(point.getAttributes().get(StorageClientMetrics.KEY_RPC_METHOD)) | ||
| .isEqualTo("ReadObject"); |
There was a problem hiding this comment.
Avoid using fully qualified class names (such as io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader, io.opentelemetry.sdk.metrics.SdkMeterProvider, java.util.Collection, io.opentelemetry.sdk.metrics.data.MetricData, and io.opentelemetry.sdk.metrics.data.HistogramPointData) when there is no class name conflict in the file and the classes are already imported or can be imported. This unnecessarily reduces code readability. Please import these classes and use their simple names instead. This also applies to the other new tests in this file.
InMemoryMetricReader reader =
InMemoryMetricReader.create();
SdkMeterProvider provider =
SdkMeterProvider.builder()
.registerMetricReader(reader)
.build();
StorageClientMetrics metrics = StorageClientMetrics.create(provider, true, false);
StorageMetricsContext context = StorageMetricsContext.create("ReadObject");
context.setResponseBytes(4096L);
context.recordOperation(metrics, null);
Collection<MetricData> collected =
reader.collectAllMetrics();
MetricData bodySizeData =
collected.stream()
.filter(
m ->
m.getName()
.equals(StorageClientMetrics.METRIC_GCP_STORAGE_CLIENT_RESPONSE_BODY_SIZE))
.findFirst()
.orElse(null);
assertThat(bodySizeData).isNotNull();
assertThat(bodySizeData.getHistogramData().getPoints()).hasSize(1);
HistogramPointData point =
bodySizeData.getHistogramData().getPoints().iterator().next();
assertThat(point.getCount()).isEqualTo(1L);
assertThat(point.getSum()).isEqualTo(4096.0);
assertThat(point.getAttributes().get(StorageClientMetrics.KEY_RPC_METHOD))
.isEqualTo("ReadObject");References
- Do not use fully qualified class names (such as
java.time.Duration) if there is no class name conflict in the file and the class is already imported, as it unnecessarily reduces code readability.
Instruments read operations across HTTP and gRPC veneers to record
gcp.storage.client.response.body.sizeOpenTelemetry histogram metrics.StorageMetricsContext(addBytesReceived) and recordsgcp.storage.client.response.body.sizeon operation completion.BaseStorageReadChannel,StorageImpl, andGrpcStorageImplto track downloaded payload bytes across unary and streaming reads.gcp.storage.client.response.body.sizeinStorageClientMetricsand adds unit tests inStorageMetricsContextTest,StorageByteCountingTest, andStorageClientMetricsTest.Stacked on #14746.