This is an automated email from the ASF dual-hosted git repository.
hemant pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new 3467db1b1c HDDS-9200. [Snapshot] Added logs and metrics for snapshot
purge and set property APIs (#6453)
3467db1b1c is described below
commit 3467db1b1cc581a21caeb8648587fcbf35bbfdfa
Author: Hemant Kumar <[email protected]>
AuthorDate: Wed Apr 3 16:13:19 2024 -0700
HDDS-9200. [Snapshot] Added logs and metrics for snapshot purge and set
property APIs (#6453)
---
.../java/org/apache/hadoop/ozone/om/OMMetrics.java | 36 ++++++++++++++++
.../request/snapshot/OMSnapshotPurgeRequest.java | 10 +++++
.../snapshot/OMSnapshotSetPropertyRequest.java | 6 +++
.../TestOMSnapshotPurgeRequestAndResponse.java | 34 +++++++++++++++
...estOMSnapshotSetPropertyRequestAndResponse.java | 48 +++++++++++++++++++++-
5 files changed, 133 insertions(+), 1 deletion(-)
diff --git
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMetrics.java
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMetrics.java
index ed5efbefe5..faf0efd464 100644
---
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMetrics.java
+++
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMetrics.java
@@ -74,6 +74,8 @@ public class OMMetrics implements OmMetadataReaderMetrics {
private @Metric MutableCounterLong numSnapshotLists;
private @Metric MutableCounterLong numSnapshotDiffJobs;
private @Metric MutableCounterLong numSnapshotInfos;
+ private @Metric MutableCounterLong numSnapshotPurges;
+ private @Metric MutableCounterLong numSnapshotSetProperties;
private @Metric MutableCounterLong numGetFileStatus;
private @Metric MutableCounterLong numCreateDirectory;
@@ -136,6 +138,8 @@ public class OMMetrics implements OmMetadataReaderMetrics {
private @Metric MutableCounterLong numSnapshotListFails;
private @Metric MutableCounterLong numSnapshotDiffJobFails;
private @Metric MutableCounterLong numSnapshotInfoFails;
+ private @Metric MutableCounterLong numSnapshotPurgeFails;
+ private @Metric MutableCounterLong numSnapshotSetPropertyFails;
private @Metric MutableCounterLong numSnapshotActive;
private @Metric MutableCounterLong numSnapshotDeleted;
@@ -479,6 +483,14 @@ public class OMMetrics implements OmMetadataReaderMetrics {
numSnapshotInfos.incr();
}
+ public void incNumSnapshotPurges() {
+ numSnapshotPurges.incr();
+ }
+
+ public void incNumSnapshotSetProperties() {
+ numSnapshotSetProperties.incr();
+ }
+
public void incNumSnapshotDiffJobs() {
numSnapshotDiffJobs.incr();
}
@@ -494,6 +506,15 @@ public class OMMetrics implements OmMetadataReaderMetrics {
public void incNumSnapshotInfoFails() {
numSnapshotInfoFails.incr();
}
+
+ public void incNumSnapshotPurgeFails() {
+ numSnapshotPurgeFails.incr();
+ }
+
+ public void incNumSnapshotSetPropertyFails() {
+ numSnapshotSetPropertyFails.incr();
+ }
+
public void setNumSnapshotActive(long num) {
long currVal = numSnapshotActive.value();
numSnapshotActive.incr(num - currVal);
@@ -1290,6 +1311,14 @@ public class OMMetrics implements
OmMetadataReaderMetrics {
return numSnapshotDiffJobs.value();
}
+ public long getNumSnapshotPurges() {
+ return numSnapshotPurges.value();
+ }
+
+ public long getNumSnapshotSetProperties() {
+ return numSnapshotSetProperties.value();
+ }
+
public long getNumSnapshotCreateFails() {
return numSnapshotCreateFails.value();
}
@@ -1314,6 +1343,13 @@ public class OMMetrics implements
OmMetadataReaderMetrics {
return numSnapshotDeleted.value();
}
+ public long getNumSnapshotPurgeFails() {
+ return numSnapshotPurgeFails.value();
+ }
+
+ public long getNumSnapshotSetPropertyFails() {
+ return numSnapshotSetPropertyFails.value();
+ }
public void incNumTrashRenames() {
numTrashRenames.incr();
diff --git
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotPurgeRequest.java
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotPurgeRequest.java
index 7ac65b240e..29c7628e3c 100644
---
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotPurgeRequest.java
+++
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotPurgeRequest.java
@@ -21,6 +21,7 @@ package org.apache.hadoop.ozone.om.request.snapshot;
import org.apache.commons.lang3.tuple.Triple;
import org.apache.hadoop.ozone.om.OMMetadataManager;
+import org.apache.hadoop.ozone.om.OMMetrics;
import org.apache.hadoop.ozone.om.exceptions.OMException;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
@@ -66,6 +67,8 @@ public class OMSnapshotPurgeRequest extends OMClientRequest {
@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
TermIndex termIndex) {
+ OMMetrics omMetrics = ozoneManager.getMetrics();
+
final long trxnLogIndex = termIndex.getIndex();
OmSnapshotManager omSnapshotManager = ozoneManager.getOmSnapshotManager();
@@ -150,9 +153,16 @@ public class OMSnapshotPurgeRequest extends
OMClientRequest {
omClientResponse = new OMSnapshotPurgeResponse(omResponse.build(),
snapshotDbKeys, updatedSnapInfos,
updatedPathPreviousAndGlobalSnapshots);
+
+ omMetrics.incNumSnapshotPurges();
+ LOG.info("Successfully executed snapshotPurgeRequest: {{}} along with
updating deep clean flags for " +
+ "snapshots: {} and global and previous for snapshots:{}.",
+ snapshotPurgeRequest, updatedSnapInfos.keySet(),
updatedPathPreviousAndGlobalSnapshots.keySet());
} catch (IOException ex) {
omClientResponse = new OMSnapshotPurgeResponse(
createErrorOMResponse(omResponse, ex));
+ omMetrics.incNumSnapshotPurgeFails();
+ LOG.error("Failed to execute snapshotPurgeRequest:{{}}.",
snapshotPurgeRequest, ex);
}
return omClientResponse;
diff --git
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotSetPropertyRequest.java
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotSetPropertyRequest.java
index 9f1ff24a6d..c4ca3dc99e 100644
---
a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotSetPropertyRequest.java
+++
b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/snapshot/OMSnapshotSetPropertyRequest.java
@@ -17,6 +17,7 @@
*/
package org.apache.hadoop.ozone.om.request.snapshot;
+import org.apache.hadoop.ozone.om.OMMetrics;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
@@ -52,6 +53,7 @@ public class OMSnapshotSetPropertyRequest extends
OMClientRequest {
@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager,
TermIndex termIndex) {
+ OMMetrics omMetrics = ozoneManager.getMetrics();
OMClientResponse omClientResponse = null;
OMMetadataManager metadataManager = ozoneManager.getMetadataManager();
@@ -117,9 +119,13 @@ public class OMSnapshotSetPropertyRequest extends
OMClientRequest {
CacheValue.get(termIndex.getIndex(), updatedSnapInfo));
omClientResponse = new OMSnapshotSetPropertyResponse(
omResponse.build(), updatedSnapInfo);
+ omMetrics.incNumSnapshotSetProperties();
+ LOG.info("Successfully executed snapshotSetPropertyRequest: {{}}.",
setSnapshotPropertyRequest);
} catch (IOException ex) {
omClientResponse = new OMSnapshotSetPropertyResponse(
createErrorOMResponse(omResponse, ex));
+ omMetrics.incNumSnapshotSetPropertyFails();
+ LOG.error("Failed to execute snapshotSetPropertyRequest: {{}}.",
setSnapshotPropertyRequest, ex);
} finally {
if (acquiredSnapshotLock) {
mergeOmLockDetails(metadataManager.getLock()
diff --git
a/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotPurgeRequestAndResponse.java
b/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotPurgeRequestAndResponse.java
index 7c0a5c4ff8..8edd096e76 100644
---
a/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotPurgeRequestAndResponse.java
+++
b/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotPurgeRequestAndResponse.java
@@ -22,6 +22,7 @@ package org.apache.hadoop.ozone.om.request.snapshot;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.utils.db.BatchOperation;
import org.apache.hadoop.hdds.utils.db.RDBStore;
+import org.apache.hadoop.hdds.utils.db.Table;
import org.apache.hadoop.ozone.OzoneConfigKeys;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.om.IOmMetadataReader;
@@ -63,6 +64,7 @@ import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.Stream;
+import static
org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Status.INTERNAL_ERROR;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
@@ -233,6 +235,8 @@ public class TestOMSnapshotPurgeRequestAndResponse {
@Test
public void testValidateAndUpdateCache() throws Exception {
+ long initialSnapshotPurgeCount = omMetrics.getNumSnapshotPurges();
+ long initialSnapshotPurgeFailCount = omMetrics.getNumSnapshotPurgeFails();
List<String> snapshotDbKeysToPurge = createSnapshots(10);
assertFalse(omMetadataManager.getSnapshotInfoTable().isEmpty());
@@ -260,6 +264,36 @@ public class TestOMSnapshotPurgeRequestAndResponse {
for (Path checkpoint : checkpointPaths) {
assertFalse(Files.exists(checkpoint));
}
+ assertEquals(initialSnapshotPurgeCount + 1,
omMetrics.getNumSnapshotPurges());
+ assertEquals(initialSnapshotPurgeFailCount,
omMetrics.getNumSnapshotPurgeFails());
+ }
+
+ /**
+ * This test is mainly to validate metrics and error code.
+ */
+ @Test
+ public void testValidateAndUpdateCacheFailure() throws Exception {
+ long initialSnapshotPurgeCount = omMetrics.getNumSnapshotPurges();
+ long initialSnapshotPurgeFailCount = omMetrics.getNumSnapshotPurgeFails();
+
+ List<String> snapshotDbKeysToPurge = createSnapshots(10);
+
+ OmMetadataManagerImpl mockedMetadataManager =
mock(OmMetadataManagerImpl.class);
+ Table<String, SnapshotInfo> mockedSnapshotInfoTable = mock(Table.class);
+
+ when(mockedSnapshotInfoTable.get(anyString())).thenThrow(new
IOException("Injected fault error."));
+
when(mockedMetadataManager.getSnapshotInfoTable()).thenReturn(mockedSnapshotInfoTable);
+ when(ozoneManager.getMetadataManager()).thenReturn(mockedMetadataManager);
+
+ OMRequest snapshotPurgeRequest =
createPurgeKeysRequest(snapshotDbKeysToPurge);
+ OMSnapshotPurgeRequest omSnapshotPurgeRequest =
preExecute(snapshotPurgeRequest);
+
+ OMSnapshotPurgeResponse omSnapshotPurgeResponse = (OMSnapshotPurgeResponse)
+ omSnapshotPurgeRequest.validateAndUpdateCache(ozoneManager, 200L);
+
+ assertEquals(INTERNAL_ERROR,
omSnapshotPurgeResponse.getOMResponse().getStatus());
+ assertEquals(initialSnapshotPurgeCount, omMetrics.getNumSnapshotPurges());
+ assertEquals(initialSnapshotPurgeFailCount + 1,
omMetrics.getNumSnapshotPurgeFails());
}
// TODO: clean up: Do we this test after
diff --git
a/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotSetPropertyRequestAndResponse.java
b/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotSetPropertyRequestAndResponse.java
index 3856a5b62f..b5bfc2714b 100644
---
a/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotSetPropertyRequestAndResponse.java
+++
b/hadoop-ozone/ozone-manager/src/test/java/org/apache/hadoop/ozone/om/request/snapshot/TestOMSnapshotSetPropertyRequestAndResponse.java
@@ -27,6 +27,7 @@ import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
import org.apache.hadoop.ozone.OzoneConfigKeys;
import org.apache.hadoop.ozone.om.OMConfigKeys;
import org.apache.hadoop.ozone.om.OMMetadataManager;
+import org.apache.hadoop.ozone.om.OMMetrics;
import org.apache.hadoop.ozone.om.OmMetadataManagerImpl;
import org.apache.hadoop.ozone.om.OzoneManager;
import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
@@ -48,6 +49,7 @@ import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
+import static
org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Status.INTERNAL_ERROR;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.Mockito.anyString;
@@ -62,7 +64,7 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
private BatchOperation batchOperation;
private OzoneManager ozoneManager;
private OMMetadataManager omMetadataManager;
-
+ private OMMetrics omMetrics;
private String volumeName;
private String bucketName;
private String snapName;
@@ -71,6 +73,7 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
@BeforeEach
void setup(@TempDir File testDir) throws Exception {
+ omMetrics = OMMetrics.create();
ozoneManager = mock(OzoneManager.class);
OMLayoutVersionManager lvm = mock(OMLayoutVersionManager.class);
when(lvm.isAllowed(anyString())).thenReturn(true);
@@ -84,6 +87,7 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
omMetadataManager = new OmMetadataManagerImpl(ozoneConfiguration,
ozoneManager);
when(ozoneManager.getMetadataManager()).thenReturn(omMetadataManager);
+ when(ozoneManager.getMetrics()).thenReturn(omMetrics);
volumeName = UUID.randomUUID().toString();
bucketName = UUID.randomUUID().toString();
@@ -94,6 +98,9 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
@Test
public void testValidateAndUpdateCache() throws IOException {
+ long initialSnapshotSetPropertyCount =
omMetrics.getNumSnapshotSetProperties();
+ long initialSnapshotSetPropertyFailCount =
omMetrics.getNumSnapshotSetPropertyFails();
+
createSnapshotDataForTest();
assertFalse(omMetadataManager.getSnapshotInfoTable().isEmpty());
List<OMRequest> snapshotUpdateSizeRequests =
@@ -120,6 +127,9 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
omMetadataManager.getStore().commitBatchOperation(batchOperation);
}
+ assertEquals(initialSnapshotSetPropertyCount +
snapshotUpdateSizeRequests.size(),
+ omMetrics.getNumSnapshotSetProperties());
+ assertEquals(initialSnapshotSetPropertyFailCount,
omMetrics.getNumSnapshotSetPropertyFails());
// Check if the exclusive size is set.
try (TableIterator<String, ? extends Table.KeyValue<String, SnapshotInfo>>
iterator = omMetadataManager.getSnapshotInfoTable().iterator()) {
@@ -134,6 +144,42 @@ public class TestOMSnapshotSetPropertyRequestAndResponse {
}
}
+ /**
+ * This test is mainly to validate metrics and error code.
+ */
+ @Test
+ public void testValidateAndUpdateCacheFailure() throws IOException {
+ long initialSnapshotSetPropertyCount =
omMetrics.getNumSnapshotSetProperties();
+ long initialSnapshotSetPropertyFailCount =
omMetrics.getNumSnapshotSetPropertyFails();
+
+ createSnapshotDataForTest();
+ assertFalse(omMetadataManager.getSnapshotInfoTable().isEmpty());
+ List<OMRequest> snapshotUpdateSizeRequests =
createSnapshotUpdateSizeRequest();
+
+ OmMetadataManagerImpl mockedMetadataManager =
mock(OmMetadataManagerImpl.class);
+ Table<String, SnapshotInfo> mockedSnapshotInfoTable = mock(Table.class);
+
+ when(mockedSnapshotInfoTable.get(anyString())).thenThrow(new
IOException("Injected fault error."));
+
when(mockedMetadataManager.getSnapshotInfoTable()).thenReturn(mockedSnapshotInfoTable);
+ when(ozoneManager.getMetadataManager()).thenReturn(mockedMetadataManager);
+
+ for (OMRequest omRequest: snapshotUpdateSizeRequests) {
+ OMSnapshotSetPropertyRequest omSnapshotSetPropertyRequest = new
OMSnapshotSetPropertyRequest(omRequest);
+ OMRequest modifiedOmRequest =
omSnapshotSetPropertyRequest.preExecute(ozoneManager);
+ omSnapshotSetPropertyRequest = new
OMSnapshotSetPropertyRequest(modifiedOmRequest);
+
+ // Validate and Update Cache
+ OMSnapshotSetPropertyResponse omSnapshotSetPropertyResponse =
(OMSnapshotSetPropertyResponse)
+ omSnapshotSetPropertyRequest.validateAndUpdateCache(ozoneManager,
200L);
+
+ assertEquals(INTERNAL_ERROR,
omSnapshotSetPropertyResponse.getOMResponse().getStatus());
+ }
+
+ assertEquals(initialSnapshotSetPropertyCount,
omMetrics.getNumSnapshotSetProperties());
+ assertEquals(initialSnapshotSetPropertyFailCount +
snapshotUpdateSizeRequests.size(),
+ omMetrics.getNumSnapshotSetPropertyFails());
+ }
+
private void assertCacheValues(String dbKey) {
CacheValue<SnapshotInfo> cacheValue = omMetadataManager
.getSnapshotInfoTable()
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
