This is an automated email from the ASF dual-hosted git repository.
wchevreuil pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/master by this push:
new bc0f7a41b38 HBASE-28209: Create a jmx metrics to expose the oldWALs
directory size (#5528)
bc0f7a41b38 is described below
commit bc0f7a41b38de453bf3cc188d54d227e0b7f3ba9
Author: vinayak hegde <vinayakph...@gmail.com>
AuthorDate: Mon Dec 4 16:33:34 2023 +0530
HBASE-28209: Create a jmx metrics to expose the oldWALs directory size
(#5528)
Signed-off-by: Wellington Chevreuil <wchevre...@apache.org>
---
.../java/org/apache/hadoop/hbase/HConstants.java | 7 ++
hbase-common/src/main/resources/hbase-default.xml | 6 ++
.../hadoop/hbase/master/MetricsMasterSource.java | 2 +
.../hbase/master/MetricsMasterSourceImpl.java | 4 +-
.../hadoop/hbase/master/MetricsMasterWrapper.java | 5 ++
.../org/apache/hadoop/hbase/master/HMaster.java | 6 ++
.../hadoop/hbase/master/MasterWalManager.java | 12 +++
.../hbase/master/MetricsMasterWrapperImpl.java | 8 ++
.../hadoop/hbase/master/OldWALsDirSizeChore.java | 53 +++++++++++++
.../hadoop/hbase/master/TestMasterMetrics.java | 2 +
.../hbase/master/TestMasterMetricsWrapper.java | 1 +
.../hbase/master/TestOldWALsDirSizeChore.java | 90 ++++++++++++++++++++++
src/main/asciidoc/_chapters/hbase-default.adoc | 11 +++
13 files changed, 206 insertions(+), 1 deletion(-)
diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/HConstants.java
b/hbase-common/src/main/java/org/apache/hadoop/hbase/HConstants.java
index 2aa9ecf69ec..5b53d2b2c0d 100644
--- a/hbase-common/src/main/java/org/apache/hadoop/hbase/HConstants.java
+++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/HConstants.java
@@ -153,6 +153,13 @@ public final class HConstants {
/** Default value for the balancer period */
public static final int DEFAULT_HBASE_BALANCER_PERIOD = 300000;
+ /** Config for the oldWALs directory size updater period */
+ public static final String HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD =
+ "hbase.master.oldwals.dir.updater.period";
+
+ /** Default value for the oldWALs directory size updater period */
+ public static final int DEFAULT_HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD =
300000;
+
/**
* Config key for enable/disable automatically separate child regions to
different region servers
* in the procedure of split regions. One child will be kept to the server
where parent region is
diff --git a/hbase-common/src/main/resources/hbase-default.xml
b/hbase-common/src/main/resources/hbase-default.xml
index 17a9853d2ad..1bf63b136e0 100644
--- a/hbase-common/src/main/resources/hbase-default.xml
+++ b/hbase-common/src/main/resources/hbase-default.xml
@@ -606,6 +606,12 @@ possible configurations would overwhelm and obscure the
important.
<description>Period at which the region balancer runs in the Master, in
milliseconds.</description>
</property>
+ <property>
+ <name>hbase.master.oldwals.dir.updater.period</name>
+ <value>300000</value>
+ <description>Period at which the oldWALs directory size calculator/updater
will run in the
+ Master, in milliseconds.</description>
+ </property>
<property>
<name>hbase.regions.slop</name>
<value>0.2</value>
diff --git
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSource.java
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSource.java
index 4a5b97ae66b..d606ed63088 100644
---
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSource.java
+++
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSource.java
@@ -70,6 +70,7 @@ public interface MetricsMasterSource extends BaseSource {
String CLUSTER_REQUESTS_NAME = "clusterRequests";
String CLUSTER_READ_REQUESTS_NAME = "clusterReadRequests";
String CLUSTER_WRITE_REQUESTS_NAME = "clusterWriteRequests";
+ String OLD_WAL_DIR_SIZE_NAME = "oldWALsDirSize";
String MASTER_ACTIVE_TIME_DESC = "Master Active Time";
String MASTER_START_TIME_DESC = "Master Start Time";
String MASTER_FINISHED_INITIALIZATION_TIME_DESC =
@@ -91,6 +92,7 @@ public interface MetricsMasterSource extends BaseSource {
String OFFLINE_REGION_COUNT_DESC = "Number of Offline Regions";
String SERVER_CRASH_METRIC_PREFIX = "serverCrash";
+ String OLD_WAL_DIR_SIZE_DESC = "size of old WALs directory in bytes";
/**
* Increment the number of requests the cluster has seen.
diff --git
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSourceImpl.java
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSourceImpl.java
index e0abf77bea4..011e66312aa 100644
---
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSourceImpl.java
+++
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterSourceImpl.java
@@ -129,7 +129,9 @@ public class MetricsMasterSourceImpl extends BaseSourceImpl
implements MetricsMa
.tag(Interns.info(SERVER_NAME_NAME, SERVER_NAME_DESC),
masterWrapper.getServerName())
.tag(Interns.info(CLUSTER_ID_NAME, CLUSTER_ID_DESC),
masterWrapper.getClusterId())
.tag(Interns.info(IS_ACTIVE_MASTER_NAME, IS_ACTIVE_MASTER_DESC),
- String.valueOf(masterWrapper.getIsActiveMaster()));
+ String.valueOf(masterWrapper.getIsActiveMaster()))
+ .addGauge(Interns.info(OLD_WAL_DIR_SIZE_NAME, OLD_WAL_DIR_SIZE_DESC),
+ masterWrapper.getOldWALsDirSize());
}
metricsRegistry.snapshot(metricsRecordBuilder, all);
diff --git
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapper.java
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapper.java
index a900edf115e..83419e2d550 100644
---
a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapper.java
+++
b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapper.java
@@ -153,4 +153,9 @@ public interface MetricsMasterWrapper {
* @return pair of count for online regions and offline regions
*/
PairOfSameType<Integer> getRegionCounts();
+
+ /**
+ * Get the size of old WALs directory in bytes.
+ */
+ long getOldWALsDirSize();
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java
index 0dca3a0111e..b492b177e42 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/HMaster.java
@@ -458,6 +458,7 @@ public class HMaster extends
HBaseServerBase<MasterRpcServices> implements Maste
private SpaceQuotaSnapshotNotifier spaceQuotaSnapshotNotifier;
private QuotaObserverChore quotaObserverChore;
private SnapshotQuotaObserverChore snapshotQuotaChore;
+ private OldWALsDirSizeChore oldWALsDirSizeChore;
private ProcedureExecutor<MasterProcedureEnv> procedureExecutor;
private ProcedureStore procedureStore;
@@ -1362,6 +1363,10 @@ public class HMaster extends
HBaseServerBase<MasterRpcServices> implements Maste
this.rollingUpgradeChore = new RollingUpgradeChore(this);
getChoreService().scheduleChore(rollingUpgradeChore);
+
+ this.oldWALsDirSizeChore = new OldWALsDirSizeChore(this);
+ getChoreService().scheduleChore(this.oldWALsDirSizeChore);
+
status.markComplete("Progress after master initialized complete");
}
@@ -1894,6 +1899,7 @@ public class HMaster extends
HBaseServerBase<MasterRpcServices> implements Maste
shutdownChore(hbckChore);
shutdownChore(regionsRecoveryChore);
shutdownChore(rollingUpgradeChore);
+ shutdownChore(oldWALsDirSizeChore);
}
/** Returns Get remote side's InetAddress */
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MasterWalManager.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MasterWalManager.java
index aca04a8ac83..a2c929cb79d 100644
---
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MasterWalManager.java
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MasterWalManager.java
@@ -89,6 +89,9 @@ public class MasterWalManager {
// create the split log lock
private final Lock splitLogLock = new ReentrantLock();
+ // old WALs directory size in bytes
+ private long oldWALsDirSize;
+
/**
* Superceded by {@link SplitWALManager}; i.e. procedure-based WAL splitting
rather than 'classic'
* zk-coordinated WAL splitting.
@@ -114,6 +117,7 @@ public class MasterWalManager {
this.services = services;
this.splitLogManager = new SplitLogManager(services, conf);
this.oldLogDir = new Path(rootDir, HConstants.HREGION_OLDLOGDIR_NAME);
+ this.oldWALsDirSize = 0;
}
public void stop() {
@@ -134,6 +138,14 @@ public class MasterWalManager {
return this.oldLogDir;
}
+ public void updateOldWALsDirSize() throws IOException {
+ this.oldWALsDirSize = fs.getContentSummary(this.oldLogDir).getLength();
+ }
+
+ public long getOldWALsDirSize() {
+ return this.oldWALsDirSize;
+ }
+
public FileSystem getFileSystem() {
return this.fs;
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapperImpl.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapperImpl.java
index 923c663807f..ff6f5b8e5df 100644
---
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapperImpl.java
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MetricsMasterWrapperImpl.java
@@ -238,4 +238,12 @@ public class MetricsMasterWrapperImpl implements
MetricsMasterWrapper {
return new PairOfSameType<>(0, 0);
}
}
+
+ @Override
+ public long getOldWALsDirSize() {
+ if (master == null || !master.isInitialized()) {
+ return 0;
+ }
+ return master.getMasterWalManager().getOldWALsDirSize();
+ }
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/master/OldWALsDirSizeChore.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/OldWALsDirSizeChore.java
new file mode 100644
index 00000000000..b2f0622b7d2
--- /dev/null
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/master/OldWALsDirSizeChore.java
@@ -0,0 +1,53 @@
+/*
+ * 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.hbase.master;
+
+import java.io.IOException;
+import org.apache.hadoop.hbase.HConstants;
+import org.apache.hadoop.hbase.ScheduledChore;
+import org.apache.yetus.audience.InterfaceAudience;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This chore is used to update the 'oldWALsDirSize' variable in {@link
MasterWalManager} through
+ * the {@link MasterWalManager#updateOldWALsDirSize()} method.
+ */
+@InterfaceAudience.Private
+public class OldWALsDirSizeChore extends ScheduledChore {
+ private static final Logger LOG =
LoggerFactory.getLogger(OldWALsDirSizeChore.class);
+
+ private final MasterServices master;
+
+ public OldWALsDirSizeChore(MasterServices master) {
+ super(master.getServerName() + "-OldWALsDirSizeChore", master,
+
master.getConfiguration().getInt(HConstants.HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD,
+ HConstants.DEFAULT_HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD));
+ this.master = master;
+ }
+
+ @Override
+ protected void chore() {
+ try {
+ this.master.getMasterWalManager().updateOldWALsDirSize();
+ } catch (IOException e) {
+ LOG.error("Got exception while trying to update the old WALs Directory
size counter: "
+ + e.getMessage(), e);
+ }
+ }
+}
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetrics.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetrics.java
index 3966b1f6bec..09618b3d899 100644
---
a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetrics.java
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetrics.java
@@ -183,6 +183,8 @@ public class TestMasterMetrics {
metricsHelper.assertCounter(MetricsMasterSource.SERVER_CRASH_METRIC_PREFIX
+ "SubmittedCount",
0, masterSource);
+ metricsHelper.assertGauge("oldWALsDirSize",
master.getMasterWalManager().getOldWALsDirSize(),
+ masterSource);
}
@Test
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetricsWrapper.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetricsWrapper.java
index f73ebde89c1..d1389ee68e9 100644
---
a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetricsWrapper.java
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterMetricsWrapper.java
@@ -85,6 +85,7 @@ public class TestMasterMetricsWrapper {
assertEquals(master.getMasterCoprocessors().length,
info.getCoprocessors().length);
assertEquals(master.getServerManager().getOnlineServersList().size(),
info.getNumRegionServers());
+ assertEquals(master.getMasterWalManager().getOldWALsDirSize(),
info.getOldWALsDirSize());
int regionServerCount = NUM_RS;
assertEquals(regionServerCount, info.getNumRegionServers());
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestOldWALsDirSizeChore.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestOldWALsDirSizeChore.java
new file mode 100644
index 00000000000..7bd4ec5a1c2
--- /dev/null
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestOldWALsDirSizeChore.java
@@ -0,0 +1,90 @@
+/*
+ * 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.hbase.master;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.IOException;
+import org.apache.hadoop.fs.FSDataOutputStream;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.hbase.HBaseClassTestRule;
+import org.apache.hadoop.hbase.HBaseTestingUtil;
+import org.apache.hadoop.hbase.master.assignment.MockMasterServices;
+import org.apache.hadoop.hbase.testclassification.MasterTests;
+import org.apache.hadoop.hbase.testclassification.SmallTests;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Tests for OldWALsDirSizeChore Here we are using the {@link
MockMasterServices} to mock the Hbase
+ * Master. Chore's won't be running automatically; we need to run every time.
+ */
+@Category({ MasterTests.class, SmallTests.class })
+public class TestOldWALsDirSizeChore {
+ @ClassRule
+ public static final HBaseClassTestRule CLASS_RULE =
+ HBaseClassTestRule.forClass(TestOldWALsDirSizeChore.class);
+
+ private static final Logger LOG =
LoggerFactory.getLogger(TestOldWALsDirSizeChore.class);
+
+ private MockMasterServices master;
+
+ private static final HBaseTestingUtil HBASE_TESTING_UTILITY = new
HBaseTestingUtil();
+
+ @Before
+ public void setUp() throws Exception {
+ master = new MockMasterServices(HBASE_TESTING_UTILITY.getConfiguration());
+ master.start(10, null);
+ }
+
+ @After
+ public void tearDown() throws Exception {
+ master.stop("tearDown");
+ }
+
+ @Test
+ public void testOldWALsDirSizeChore() throws IOException {
+ // Assume the OldWALs directory size is initially zero as the chore hasn't
run yet
+ long currentOldWALsDirSize =
master.getMasterWalManager().getOldWALsDirSize();
+ assertEquals("Initial OldWALs directory size should be zero before running
the chore", 0,
+ currentOldWALsDirSize);
+
+ int dummyFileSize = 50 * 1024 * 1024; // 50MB
+ byte[] dummyData = new byte[dummyFileSize];
+
+ // Create a dummy file in the OldWALs directory
+ Path dummyFileInOldWALsDir = new
Path(master.getMasterWalManager().getOldLogDir(), "dummy.txt");
+ try (FSDataOutputStream outputStream =
+
master.getMasterWalManager().getFileSystem().create(dummyFileInOldWALsDir)) {
+ outputStream.write(dummyData);
+ }
+
+ // Run the OldWALsDirSizeChore to update the directory size
+ OldWALsDirSizeChore oldWALsDirSizeChore = new OldWALsDirSizeChore(master);
+ oldWALsDirSizeChore.chore();
+
+ // Verify that the OldWALs directory size has increased by the file size
+ assertEquals("OldWALs directory size after chore should be as expected",
dummyFileSize,
+ master.getMasterWalManager().getOldWALsDirSize());
+ }
+}
diff --git a/src/main/asciidoc/_chapters/hbase-default.adoc
b/src/main/asciidoc/_chapters/hbase-default.adoc
index 69fb4a0eae6..03391cc38b1 100644
--- a/src/main/asciidoc/_chapters/hbase-default.adoc
+++ b/src/main/asciidoc/_chapters/hbase-default.adoc
@@ -761,6 +761,17 @@ Period at which the region balancer runs in the Master.
`300000`
+[[hbase.master.oldwals.dir.updater.period]]
+*`hbase.master.oldwals.dir.updater.period`*::
++
+.Description
+Period at which the oldWALs directory size calculator/updater will run in the
Master.
+
++
+.Default
+`300000`
+
+
[[hbase.regions.slop]]
*`hbase.regions.slop`*::
+
