Restore repo_name label to repository metrics (#117114)

elastic · Nov 22, 2024 · d87a1a2 · d87a1a2
1 parent eff0c42
commit d87a1a2
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 11 deletions.
diff --git a/...rTest/java/org/elasticsearch/repositories/azure/AzureBlobStoreRepositoryMetricsTests.java b/...rTest/java/org/elasticsearch/repositories/azure/AzureBlobStoreRepositoryMetricsTests.java
@@ -112,7 +112,7 @@ public void testThrottleResponsesAreCountedInMetrics() throws IOException {
         blobContainer.blobExists(purpose, blobName);
 
         // Correct metrics are recorded
-        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB_PROPERTIES).expectMetrics()
+        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB_PROPERTIES, repository).expectMetrics()
             .withRequests(numThrottles + 1)
             .withThrottles(numThrottles)
             .withExceptions(numThrottles)
@@ -137,7 +137,7 @@ public void testRangeNotSatisfiedAreCountedInMetrics() throws IOException {
         assertThrows(RequestedRangeNotSatisfiedException.class, () -> blobContainer.readBlob(purpose, blobName));
 
         // Correct metrics are recorded
-        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB).expectMetrics()
+        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB, repository).expectMetrics()
             .withRequests(1)
             .withThrottles(0)
             .withExceptions(1)
@@ -170,7 +170,7 @@ public void testErrorResponsesAreCountedInMetrics() throws IOException {
         blobContainer.blobExists(purpose, blobName);
 
         // Correct metrics are recorded
-        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB_PROPERTIES).expectMetrics()
+        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.GET_BLOB_PROPERTIES, repository).expectMetrics()
             .withRequests(numErrors + 1)
             .withThrottles(throttles.get())
             .withExceptions(numErrors)
@@ -191,7 +191,7 @@ public void testRequestFailuresAreCountedInMetrics() {
         assertThrows(IOException.class, () -> blobContainer.listBlobs(purpose));
 
         // Correct metrics are recorded
-        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.LIST_BLOBS).expectMetrics()
+        metricsAsserter(dataNodeName, purpose, AzureBlobStore.Operation.LIST_BLOBS, repository).expectMetrics()
             .withRequests(4)
             .withThrottles(0)
             .withExceptions(4)
@@ -322,14 +322,20 @@ private void clearMetrics(String discoveryNode) {
             .forEach(TestTelemetryPlugin::resetMeter);
     }
 
-    private MetricsAsserter metricsAsserter(String dataNodeName, OperationPurpose operationPurpose, AzureBlobStore.Operation operation) {
-        return new MetricsAsserter(dataNodeName, operationPurpose, operation);
+    private MetricsAsserter metricsAsserter(
+        String dataNodeName,
+        OperationPurpose operationPurpose,
+        AzureBlobStore.Operation operation,
+        String repository
+    ) {
+        return new MetricsAsserter(dataNodeName, operationPurpose, operation, repository);
     }
 
     private class MetricsAsserter {
         private final String dataNodeName;
         private final OperationPurpose purpose;
         private final AzureBlobStore.Operation operation;
+        private final String repository;
 
         enum Result {
             Success,
@@ -355,10 +361,11 @@ List<Measurement> getMeasurements(TestTelemetryPlugin testTelemetryPlugin, Strin
             abstract List<Measurement> getMeasurements(TestTelemetryPlugin testTelemetryPlugin, String name);
         }
 
-        private MetricsAsserter(String dataNodeName, OperationPurpose purpose, AzureBlobStore.Operation operation) {
+        private MetricsAsserter(String dataNodeName, OperationPurpose purpose, AzureBlobStore.Operation operation, String repository) {
             this.dataNodeName = dataNodeName;
             this.purpose = purpose;
             this.operation = operation;
+            this.repository = repository;
         }
 
         private class Expectations {
@@ -451,6 +458,7 @@ private void assertMatchingMetricRecorded(MetricType metricType, String metricNa
                 .filter(
                     m -> m.attributes().get("operation").equals(operation.getKey())
                         && m.attributes().get("purpose").equals(purpose.getKey())
+                        && m.attributes().get("repo_name").equals(repository)
                         && m.attributes().get("repo_type").equals("azure")
                 )
                 .findFirst()
@@ -462,6 +470,8 @@ private void assertMatchingMetricRecorded(MetricType metricType, String metricNa
                             + operation.getKey()
                             + " and purpose="
                             + purpose.getKey()
+                            + " and repo_name="
+                            + repository
                             + " in "
                             + measurements
                     )

diff --git a/...lClusterTest/java/org/elasticsearch/repositories/azure/AzureBlobStoreRepositoryTests.java b/...lClusterTest/java/org/elasticsearch/repositories/azure/AzureBlobStoreRepositoryTests.java
@@ -402,7 +402,10 @@ public void testMetrics() throws Exception {
                 )
             );
             metrics.forEach(metric -> {
-                assertThat(metric.attributes(), allOf(hasEntry("repo_type", AzureRepository.TYPE), hasKey("operation"), hasKey("purpose")));
+                assertThat(
+                    metric.attributes(),
+                    allOf(hasEntry("repo_type", AzureRepository.TYPE), hasKey("repo_name"), hasKey("operation"), hasKey("purpose"))
+                );
                 final AzureBlobStore.Operation operation = AzureBlobStore.Operation.fromKey((String) metric.attributes().get("operation"));
                 final AzureBlobStore.StatsKey statsKey = new AzureBlobStore.StatsKey(
                     operation,

diff --git a/...nternalClusterTest/java/org/elasticsearch/repositories/s3/S3BlobStoreRepositoryTests.java b/...nternalClusterTest/java/org/elasticsearch/repositories/s3/S3BlobStoreRepositoryTests.java
@@ -300,7 +300,10 @@ public void testMetrics() throws Exception {
                 )
             );
             metrics.forEach(metric -> {
-                assertThat(metric.attributes(), allOf(hasEntry("repo_type", S3Repository.TYPE), hasKey("operation"), hasKey("purpose")));
+                assertThat(
+                    metric.attributes(),
+                    allOf(hasEntry("repo_type", S3Repository.TYPE), hasKey("repo_name"), hasKey("operation"), hasKey("purpose"))
+                );
                 final S3BlobStore.Operation operation = S3BlobStore.Operation.parse((String) metric.attributes().get("operation"));
                 final S3BlobStore.StatsKey statsKey = new S3BlobStore.StatsKey(
                     operation,

diff --git a/.../repository-s3/src/main/java/org/elasticsearch/repositories/s3/S3RetryingInputStream.java b/.../repository-s3/src/main/java/org/elasticsearch/repositories/s3/S3RetryingInputStream.java
@@ -327,6 +327,8 @@ private Map<String, Object> metricAttributes(String action) {
         return Map.of(
             "repo_type",
             S3Repository.TYPE,
+            "repo_name",
+            blobStore.getRepositoryMetadata().name(),
             "operation",
             Operation.GET_OBJECT.getKey(),
             "purpose",

diff --git a/...itory-s3/src/test/java/org/elasticsearch/repositories/s3/S3BlobContainerRetriesTests.java b/...itory-s3/src/test/java/org/elasticsearch/repositories/s3/S3BlobContainerRetriesTests.java
@@ -1106,7 +1106,7 @@ private List<Measurement> getRetryHistogramMeasurements() {
     }
 
     private Map<String, Object> metricAttributes(String action) {
-        return Map.of("repo_type", "s3", "operation", "GetObject", "purpose", "Indices", "action", action);
+        return Map.of("repo_type", "s3", "repo_name", "repository", "operation", "GetObject", "purpose", "Indices", "action", action);
     }
 
     /**

diff --git a/server/src/main/java/org/elasticsearch/repositories/RepositoriesMetrics.java b/server/src/main/java/org/elasticsearch/repositories/RepositoriesMetrics.java
@@ -127,7 +127,16 @@ public static Map<String, Object> createAttributesMap(
         OperationPurpose purpose,
         String operation
     ) {
-        return Map.of("repo_type", repositoryMetadata.type(), "operation", operation, "purpose", purpose.getKey());
+        return Map.of(
+            "repo_type",
+            repositoryMetadata.type(),
+            "repo_name",
+            repositoryMetadata.name(),
+            "operation",
+            operation,
+            "purpose",
+            purpose.getKey()
+        );
     }
 
 }
-Original file line number
+Diff line change
@@ Expand Up @@
         }
         private Map<String, Object> metricAttributes(String action) {
-            return Map.of("repo_type", "s3", "operation", "GetObject", "purpose", "Indices", "action", action);
+            return Map.of("repo_type", "s3", "repo_name", "repository", "operation", "GetObject", "purpose", "Indices", "action", action);
         }
         /**
@@ Expand Down @@