HDDS-7120. Prometheus displays only one volume_io_stats per datanode (#3682)
diff --git a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/HddsVolume.java b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/HddsVolume.java
index 5bec415..3354671 100644
--- a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/HddsVolume.java
+++ b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/HddsVolume.java
@@ -108,7 +108,8 @@
if (!b.getFailedVolume()) {
this.setState(VolumeState.NOT_INITIALIZED);
- this.volumeIOStats = new VolumeIOStats(b.getVolumeRootStr());
+ this.volumeIOStats = new VolumeIOStats(b.getVolumeRootStr(),
+ this.getStorageDir().toString());
this.volumeInfoMetrics =
new VolumeInfoMetrics(b.getVolumeRootStr(), this);
this.committedBytes = new AtomicLong(0);
diff --git a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/VolumeIOStats.java b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/VolumeIOStats.java
index c5533cd..e22addd 100644
--- a/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/VolumeIOStats.java
+++ b/hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/container/common/volume/VolumeIOStats.java
@@ -28,7 +28,7 @@
*/
public class VolumeIOStats {
private String metricsSourceName = VolumeIOStats.class.getSimpleName();
-
+ private String storageDirectory;
private @Metric MutableCounterLong readBytes;
private @Metric MutableCounterLong readOpCount;
private @Metric MutableCounterLong writeBytes;
@@ -44,8 +44,9 @@
/**
* @param identifier Typically, path to volume root. e.g. /data/hdds
*/
- public VolumeIOStats(String identifier) {
+ public VolumeIOStats(String identifier, String storageDirectory) {
this.metricsSourceName += '-' + identifier;
+ this.storageDirectory = storageDirectory;
init();
}
@@ -157,5 +158,8 @@
return writeTime.value();
}
-
+ @Metric
+ public String getStorageDirectory() {
+ return storageDirectory;
+ }
}
diff --git a/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/volume/TestVolumeIOStatsWithPrometheusSink.java b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/volume/TestVolumeIOStatsWithPrometheusSink.java
new file mode 100644
index 0000000..8600de5
--- /dev/null
+++ b/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/volume/TestVolumeIOStatsWithPrometheusSink.java
@@ -0,0 +1,92 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.hadoop.ozone.container.common.volume;
+
+import org.apache.hadoop.hdds.server.http.PrometheusMetricsSink;
+import org.apache.hadoop.metrics2.MetricsSystem;
+import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+/**
+ * Test PrometheusMetricSink regarding VolumeIOStats.
+ */
+public class TestVolumeIOStatsWithPrometheusSink {
+ private MetricsSystem metrics;
+ private PrometheusMetricsSink sink;
+
+ @BeforeEach
+ public void init() {
+ metrics = DefaultMetricsSystem.instance();
+ metrics.init("test");
+ sink = new PrometheusMetricsSink();
+ metrics.register("Prometheus", "Prometheus", sink);
+ }
+
+ @AfterEach
+ public void tearDown() {
+ metrics.stop();
+ metrics.shutdown();
+ }
+
+ @Test
+ public void testMultipleVolumeIOMetricsExist() throws IOException {
+ //GIVEN
+ VolumeIOStats volumeIOStats1 = new VolumeIOStats("VolumeIOStat1",
+ "vol1/dir");
+ VolumeIOStats volumeIOStat2 = new VolumeIOStats("VolumeIOStat2",
+ "vol2/dir");
+
+ //WHEN
+ String writtenMetrics = publishMetricsAndGetOutput();
+
+ //THEN
+ Assertions.assertTrue(
+ writtenMetrics.contains("storagedirectory=\"" +
+ volumeIOStats1.getStorageDirectory() + "\""),
+ "The expected metric line is missing from prometheus" +
+ " metrics output"
+ );
+ Assertions.assertTrue(
+ writtenMetrics.contains("storagedirectory=\"" +
+ volumeIOStat2.getStorageDirectory() + "\""),
+ "The expected metric line is missing from prometheus" +
+ " metrics output"
+ );
+ }
+
+ private String publishMetricsAndGetOutput() throws IOException {
+ metrics.publishMetricsNow();
+
+ ByteArrayOutputStream stream = new ByteArrayOutputStream();
+ OutputStreamWriter writer = new OutputStreamWriter(stream, UTF_8);
+
+ sink.writeMetrics(writer);
+ writer.flush();
+
+ return stream.toString(UTF_8.name());
+ }
+}
