You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by GitBox <gi...@apache.org> on 2021/02/02 21:12:27 UTC
[GitHub] [ozone] hanishakoneru commented on a change in pull request #1511: HDDS-4123. Integrate OM Open Key Cleanup Service Into Existing Code
hanishakoneru commented on a change in pull request #1511:
URL: https://github.com/apache/ozone/pull/1511#discussion_r568237488
##########
File path: hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestSecureOzoneManager.java
##########
@@ -82,8 +82,7 @@ public void init() throws Exception {
scmId = UUID.randomUUID().toString();
omId = UUID.randomUUID().toString();
conf.setBoolean(OZONE_ACL_ENABLED, true);
- conf.setBoolean(OZONE_SECURITY_ENABLED_KEY, true);
- conf.setInt(OZONE_OPEN_KEY_EXPIRE_THRESHOLD_SECONDS, 2);
+ conf.setTimeDuration(OZONE_OPEN_KEY_EXPIRE_THRESHOLD, 2, TimeUnit.SECONDS);
Review comment:
Was OZONE_SECURITY_ENABLED_KEY set call removed by mistake?
##########
File path: hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/TestMiniOzoneHACluster.java
##########
@@ -73,14 +74,15 @@ public void init() throws Exception {
conf.setBoolean(OZONE_ACL_ENABLED, true);
conf.set(OzoneConfigKeys.OZONE_ADMINISTRATORS,
OZONE_ADMINISTRATORS_WILDCARD);
- conf.setInt(OZONE_OPEN_KEY_EXPIRE_THRESHOLD_SECONDS, 2);
+ conf.setTimeDuration(OZONE_OPEN_KEY_EXPIRE_THRESHOLD, 2, TimeUnit.SECONDS);
cluster = (MiniOzoneHAClusterImpl) MiniOzoneCluster.newHABuilder(conf)
.setClusterId(clusterId)
.setScmId(scmId)
.setOMServiceId(omServiceId)
.setNumOfOzoneManagers(numOfOMs)
.build();
cluster.waitForClusterToBeReady();
+ cluster.restartOzoneManager();
Review comment:
Why do we need OM restart in init?
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
Review comment:
I don't think this override should be here. Instead of adding this override here for unit tests, the tests can pass a Mock OzoneManager object which returns true for isLeaderReady check.
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
+ }
+ return ozoneManager.isLeaderReady();
+ }
+
+ private boolean isRatisEnabled() {
+ if (ozoneManager == null) {
+ return false;
+ }
+ return ozoneManager.isRatisEnabled();
+ }
+ private class OpenKeyCleanupTask implements BackgroundTask {
@Override
public int getPriority() {
return 0;
}
@Override
public BackgroundTaskResult call() throws Exception {
- // This method is currently never used. It will be implemented in
- // HDDS-4122, and integrated into the rest of the code base in HDDS-4123.
+ // Check if this is the Leader OM. If not leader, no need to execute this
+ // task.
+ if (shouldRun()) {
+ runCount.incrementAndGet();
+
+ try {
+ long startTime = Time.monotonicNow();
+ List<String> expiredOpenKeys = keyManager.getExpiredOpenKeys(
+ expireThreshold, cleanupLimitPerTask);
+
+ if (expiredOpenKeys != null && !expiredOpenKeys.isEmpty()) {
+ OMRequest omRequest = buildOpenKeyDeleteRequest(expiredOpenKeys);
+ if (isRatisEnabled()) {
+ submitRatisRequest(ozoneManager, omRequest);
+ } else {
+ ozoneManager.getOmServerProtocol().submitRequest(null, omRequest);
+ }
+
+ LOG.debug("Number of expired keys submitted for deletion: {}, " +
+ "elapsed time: {}ms",
+ expiredOpenKeys.size(), Time.monotonicNow() - startTime);
+ submittedOpenKeyCount.addAndGet(expiredOpenKeys.size());
+ }
+ } catch (IOException e) {
+ LOG.error("Error while running delete keys background task. Will " +
+ "retry at next run.", e);
Review comment:
Can we change "delete keys background task" to "open keys cleanup task" to avoid confusion.
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OmMetadataManagerImpl.java
##########
@@ -1023,28 +1015,28 @@ private PersistedUserVolumeInfo getVolumesByUser(String userNameKey)
}
@Override
- public List<String> getExpiredOpenKeys(int count) throws IOException {
+ public List<String> getExpiredOpenKeys(TimeDuration expireThreshold,
+ int count) throws IOException {
Review comment:
NIT: Since all the time comparisons are in milliseconds, would it better to just send expireThresholdMs long value instead of expireThreshold TimeDuration?
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManagerImpl.java
##########
@@ -245,6 +250,19 @@ public void start(OzoneConfiguration configuration) {
serviceTimeout, configuration);
keyDeletingService.start();
}
+
+ if (openKeyCleanupService == null) {
+ long serviceInterval = configuration.getTimeDuration(
+ OZONE_OPEN_KEY_CLEANUP_SERVICE_INTERVAL,
+ OZONE_OPEN_KEY_CLEANUP_SERVICE_INTERVAL_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
Review comment:
If user sets this config to an integer value (without giving the unit suffix), then the serviceInterval will take it as milliseconds. For example if user wants to set to 48 hours and sets it to value 48, the service interval will be calculated as 48 milliseconds.
To provide one layer of protection against this, we can use `getTimeDuration(String name, long defaultValue, TimeUnit defaultUnit, TimeUnit returnUnit)` instead.
Also, we should add "Unit could be defined with... " to the description in ozone-default.xml (similar to how it is in `ozone.block.deleting.service.interval`).
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
+ }
+ return ozoneManager.isLeaderReady();
+ }
+
+ private boolean isRatisEnabled() {
+ if (ozoneManager == null) {
+ return false;
+ }
+ return ozoneManager.isRatisEnabled();
+ }
+ private class OpenKeyCleanupTask implements BackgroundTask {
@Override
public int getPriority() {
return 0;
}
@Override
public BackgroundTaskResult call() throws Exception {
- // This method is currently never used. It will be implemented in
- // HDDS-4122, and integrated into the rest of the code base in HDDS-4123.
+ // Check if this is the Leader OM. If not leader, no need to execute this
+ // task.
+ if (shouldRun()) {
+ runCount.incrementAndGet();
+
+ try {
+ long startTime = Time.monotonicNow();
+ List<String> expiredOpenKeys = keyManager.getExpiredOpenKeys(
+ expireThreshold, cleanupLimitPerTask);
+
+ if (expiredOpenKeys != null && !expiredOpenKeys.isEmpty()) {
+ OMRequest omRequest = buildOpenKeyDeleteRequest(expiredOpenKeys);
+ if (isRatisEnabled()) {
+ submitRatisRequest(ozoneManager, omRequest);
+ } else {
+ ozoneManager.getOmServerProtocol().submitRequest(null, omRequest);
+ }
+
+ LOG.debug("Number of expired keys submitted for deletion: {}, " +
+ "elapsed time: {}ms",
+ expiredOpenKeys.size(), Time.monotonicNow() - startTime);
+ submittedOpenKeyCount.addAndGet(expiredOpenKeys.size());
+ }
+ } catch (IOException e) {
+ LOG.error("Error while running delete keys background task. Will " +
+ "retry at next run.", e);
+ }
+ }
+ // By design, no one cares about the results of this call back.
+ return EmptyTaskResult.newResult();
+ }
+
+ /**
+ * Builds a Ratis request to move the keys in {@code expiredOpenKeys}
+ * out of the open key table and into the delete table.
+ */
+ private OMRequest buildOpenKeyDeleteRequest(
+ List<String> expiredOpenKeys) {
+ Map<Pair<String, String>, List<OpenKey>> openKeysPerBucket =
+ new HashMap<>();
+
+ for (String keyName: expiredOpenKeys) {
+ // Separate volume, bucket, key name, and client ID, and add to the
+ // bucket grouping map.
+ addToMap(openKeysPerBucket, keyName);
+ LOG.debug("Open Key {} has been marked as expired and is being " +
+ "submitted for deletion", keyName);
+ }
+
+ DeleteOpenKeysRequest.Builder requestBuilder =
+ DeleteOpenKeysRequest.newBuilder();
+
+ // Add keys to open key delete request by bucket.
+ for (Map.Entry<Pair<String, String>, List<OpenKey>> entry:
+ openKeysPerBucket.entrySet()) {
+
+ Pair<String, String> volumeBucketPair = entry.getKey();
+ OpenKeyBucket openKeyBucket = OpenKeyBucket.newBuilder()
+ .setVolumeName(volumeBucketPair.getLeft())
+ .setBucketName(volumeBucketPair.getRight())
+ .addAllKeys(entry.getValue())
+ .build();
+ requestBuilder.addOpenKeysPerBucket(openKeyBucket);
+ }
+
+ return OMRequest.newBuilder()
+ .setCmdType(Type.DeleteOpenKeys)
+ .setDeleteOpenKeysRequest(requestBuilder)
+ .setClientId(clientId.toString())
+ .build();
+ }
+
+ private void submitRatisRequest(OzoneManager om, OMRequest omRequest) {
+ try {
+ OzoneManagerRatisServer server = om.getOmRatisServer();
+ RaftClientRequest raftClientRequest = RaftClientRequest.newBuilder()
+ .setClientId(ClientId.randomId())
+ .setServerId(server.getRaftPeerId())
+ .setGroupId(server.getRaftGroupId())
+ .setCallId(0)
Review comment:
Can we set the callId to runCount?
##########
File path: hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/OMConfigKeys.java
##########
@@ -87,6 +87,21 @@ private OMConfigKeys() {
"ozone.key.deleting.limit.per.task";
public static final int OZONE_KEY_DELETING_LIMIT_PER_TASK_DEFAULT = 1000;
+ public static final String OZONE_OPEN_KEY_CLEANUP_SERVICE_INTERVAL =
Review comment:
Can you update the config variable name OZONE_OPEN_KEY_CLEANUP_SERVICE_INTERVAL also to include "OM".
The convention for variable names is to have the exact words as is in the config key.
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
+ }
+ return ozoneManager.isLeaderReady();
+ }
+
+ private boolean isRatisEnabled() {
+ if (ozoneManager == null) {
+ return false;
+ }
+ return ozoneManager.isRatisEnabled();
+ }
+ private class OpenKeyCleanupTask implements BackgroundTask {
@Override
public int getPriority() {
return 0;
}
@Override
public BackgroundTaskResult call() throws Exception {
- // This method is currently never used. It will be implemented in
- // HDDS-4122, and integrated into the rest of the code base in HDDS-4123.
+ // Check if this is the Leader OM. If not leader, no need to execute this
+ // task.
+ if (shouldRun()) {
+ runCount.incrementAndGet();
+
+ try {
+ long startTime = Time.monotonicNow();
+ List<String> expiredOpenKeys = keyManager.getExpiredOpenKeys(
+ expireThreshold, cleanupLimitPerTask);
+
+ if (expiredOpenKeys != null && !expiredOpenKeys.isEmpty()) {
+ OMRequest omRequest = buildOpenKeyDeleteRequest(expiredOpenKeys);
+ if (isRatisEnabled()) {
+ submitRatisRequest(ozoneManager, omRequest);
+ } else {
+ ozoneManager.getOmServerProtocol().submitRequest(null, omRequest);
+ }
+
+ LOG.debug("Number of expired keys submitted for deletion: {}, " +
+ "elapsed time: {}ms",
+ expiredOpenKeys.size(), Time.monotonicNow() - startTime);
+ submittedOpenKeyCount.addAndGet(expiredOpenKeys.size());
+ }
+ } catch (IOException e) {
+ LOG.error("Error while running delete keys background task. Will " +
+ "retry at next run.", e);
+ }
+ }
+ // By design, no one cares about the results of this call back.
+ return EmptyTaskResult.newResult();
+ }
+
+ /**
+ * Builds a Ratis request to move the keys in {@code expiredOpenKeys}
+ * out of the open key table and into the delete table.
+ */
+ private OMRequest buildOpenKeyDeleteRequest(
+ List<String> expiredOpenKeys) {
+ Map<Pair<String, String>, List<OpenKey>> openKeysPerBucket =
+ new HashMap<>();
+
+ for (String keyName: expiredOpenKeys) {
+ // Separate volume, bucket, key name, and client ID, and add to the
+ // bucket grouping map.
+ addToMap(openKeysPerBucket, keyName);
+ LOG.debug("Open Key {} has been marked as expired and is being " +
+ "submitted for deletion", keyName);
+ }
+
+ DeleteOpenKeysRequest.Builder requestBuilder =
+ DeleteOpenKeysRequest.newBuilder();
+
+ // Add keys to open key delete request by bucket.
+ for (Map.Entry<Pair<String, String>, List<OpenKey>> entry:
+ openKeysPerBucket.entrySet()) {
+
+ Pair<String, String> volumeBucketPair = entry.getKey();
+ OpenKeyBucket openKeyBucket = OpenKeyBucket.newBuilder()
+ .setVolumeName(volumeBucketPair.getLeft())
+ .setBucketName(volumeBucketPair.getRight())
+ .addAllKeys(entry.getValue())
+ .build();
+ requestBuilder.addOpenKeysPerBucket(openKeyBucket);
+ }
+
+ return OMRequest.newBuilder()
+ .setCmdType(Type.DeleteOpenKeys)
+ .setDeleteOpenKeysRequest(requestBuilder)
+ .setClientId(clientId.toString())
+ .build();
+ }
+
+ private void submitRatisRequest(OzoneManager om, OMRequest omRequest) {
+ try {
+ OzoneManagerRatisServer server = om.getOmRatisServer();
+ RaftClientRequest raftClientRequest = RaftClientRequest.newBuilder()
+ .setClientId(ClientId.randomId())
+ .setServerId(server.getRaftPeerId())
+ .setGroupId(server.getRaftGroupId())
+ .setCallId(0)
+ .setMessage(
+ Message.valueOf(
+ OMRatisHelper.convertRequestToByteString(omRequest)))
+ .setType(RaftClientRequest.writeRequestType())
+ .build();
+
+ server.submitRequest(omRequest, raftClientRequest);
+ } catch (ServiceException ex) {
+ LOG.error("Open key delete request failed. Will retry at next run.",
+ ex);
+ }
+ }
+
+ /**
+ * Separates {@code openKeyName} into its volume, bucket, key, and client
+ * ID. Creates an {@link OpenKey} object from {@code openKeyName}'s key and
+ * client ID, and maps {@code openKeyName}'s volume and bucket to this
+ * {@link OpenKey}.
+ */
+ private void addToMap(Map<Pair<String, String>, List<OpenKey>>
+ openKeysPerBucket, String openKeyName) {
+ // First element of the split is an empty string since the key begins
+ // with the separator.
+ // Key may contain multiple instances of the separator as well,
+ // for example: /volume/bucket/dir1//dir2/dir3/file1////10000
+ String[] split = openKeyName.split(OM_KEY_PREFIX);
+ Preconditions.assertTrue(split.length >= 5,
+ "Unable to separate volume, bucket, key, and client ID from" +
+ " open key {}.", openKeyName);
+
+ Pair<String, String> volumeBucketPair = Pair.of(split[1], split[2]);
+ String key = String.join(OM_KEY_PREFIX,
+ Arrays.copyOfRange(split, 3, split.length - 1));
+ String clientID = split[split.length - 1];
+
+ if (!openKeysPerBucket.containsKey(volumeBucketPair)) {
+ openKeysPerBucket.put(volumeBucketPair, new ArrayList<>());
+ }
+
try {
- // The new API for deleting expired open keys in OM HA will differ
- // significantly from the old implementation.
- // The old implementation has been removed so the code compiles.
- keyManager.getExpiredOpenKeys(0);
- } catch (IOException e) {
- LOG.error("Unable to get hanging open keys, retry in"
- + " next interval", e);
+ OpenKey openKey = OpenKey.newBuilder()
+ .setName(key)
+ .setClientID(Long.parseLong(clientID))
+ .build();
+ openKeysPerBucket.get(volumeBucketPair).add(openKey);
+ } catch (NumberFormatException ex) {
+ // If the client ID cannot be parsed correctly, do not add the key to
+ // the map.
+ LOG.error("Failed to parse client ID {} as a long from open key {}.",
+ clientID, openKeyName, ex);
Review comment:
Can we add in the message that this happened during Open key cleanup to be more clear.
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
+ }
+ return ozoneManager.isLeaderReady();
+ }
+
+ private boolean isRatisEnabled() {
+ if (ozoneManager == null) {
+ return false;
+ }
+ return ozoneManager.isRatisEnabled();
+ }
+ private class OpenKeyCleanupTask implements BackgroundTask {
@Override
public int getPriority() {
return 0;
}
@Override
public BackgroundTaskResult call() throws Exception {
- // This method is currently never used. It will be implemented in
- // HDDS-4122, and integrated into the rest of the code base in HDDS-4123.
+ // Check if this is the Leader OM. If not leader, no need to execute this
+ // task.
+ if (shouldRun()) {
+ runCount.incrementAndGet();
Review comment:
A suggestion - It might be useful to expose a metric here to understand how many open keys have been cleaned up. It does not have to be part of this Jira.
##########
File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OpenKeyCleanupService.java
##########
@@ -1,88 +1,291 @@
/**
- * 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
+ * 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
+ * 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.om;
-import org.apache.hadoop.hdds.scm.protocol.ScmBlockLocationProtocol;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicLong;
+
+import com.google.protobuf.ServiceException;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.hadoop.hdds.conf.ConfigurationSource;
+import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
+import org.apache.hadoop.ozone.om.ratis.OzoneManagerRatisServer;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKey;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OpenKeyBucket;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.DeleteOpenKeysRequest;
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Type;
+import org.apache.hadoop.util.Time;
import org.apache.hadoop.hdds.utils.BackgroundService;
import org.apache.hadoop.hdds.utils.BackgroundTask;
import org.apache.hadoop.hdds.utils.BackgroundTaskQueue;
import org.apache.hadoop.hdds.utils.BackgroundTaskResult;
+import org.apache.hadoop.hdds.utils.BackgroundTaskResult.EmptyTaskResult;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
+
+import org.apache.ratis.protocol.ClientId;
+import org.apache.ratis.protocol.Message;
+import org.apache.ratis.protocol.RaftClientRequest;
+import org.apache.ratis.util.Preconditions;
+import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import java.io.IOException;
-import java.util.concurrent.TimeUnit;
-
/**
- * This is the background service to delete hanging open keys.
- * Scan the metadata of om periodically to get
- * the keys with prefix "#open#" and ask scm to
- * delete metadata accordingly, if scm returns
- * success for keys, then clean up those keys.
+ * Background service to move keys whose creation time is past a given
+ * threshold from the open key table to the deleted table, where they will
+ * later be purged by the {@link KeyDeletingService}.
*/
public class OpenKeyCleanupService extends BackgroundService {
-
private static final Logger LOG =
LoggerFactory.getLogger(OpenKeyCleanupService.class);
- private static final int OPEN_KEY_DELETING_CORE_POOL_SIZE = 2;
+ // Use only a single thread for open key deletion. Multiple threads would read
+ // from the same table and can send deletion requests for same key multiple
+ // times.
+ private static final int OPEN_KEY_CLEANUP_CORE_POOL_SIZE = 1;
+ private final OzoneManager ozoneManager;
private final KeyManager keyManager;
- private final ScmBlockLocationProtocol scmClient;
+ // Dummy client ID to use for response, since this is triggered by a
+ // service, not the client.
+ private final ClientId clientId = ClientId.randomId();
+ private final TimeDuration expireThreshold;
+ private final int cleanupLimitPerTask;
+ private final AtomicLong submittedOpenKeyCount;
+ private final AtomicLong runCount;
+
+ OpenKeyCleanupService(OzoneManager ozoneManager, KeyManager keyManager,
+ long serviceInterval, ConfigurationSource conf) {
- public OpenKeyCleanupService(ScmBlockLocationProtocol scmClient,
- KeyManager keyManager, int serviceInterval,
- long serviceTimeout) {
- super("OpenKeyCleanupService", serviceInterval, TimeUnit.SECONDS,
- OPEN_KEY_DELETING_CORE_POOL_SIZE, serviceTimeout);
+ super("OpenKeyCleanupService", serviceInterval, TimeUnit.MILLISECONDS,
+ OPEN_KEY_CLEANUP_CORE_POOL_SIZE);
+ this.ozoneManager = ozoneManager;
this.keyManager = keyManager;
- this.scmClient = scmClient;
+
+ long expireDuration = conf.getTimeDuration(
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD,
+ OMConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_DEFAULT.getDuration(),
+ TimeUnit.MILLISECONDS);
+
+ this.expireThreshold =
+ TimeDuration.valueOf(expireDuration, TimeUnit.MILLISECONDS);
+
+ this.cleanupLimitPerTask = conf.getInt(
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK,
+ OMConfigKeys.OZONE_OPEN_KEY_CLEANUP_LIMIT_PER_TASK_DEFAULT);
+
+ this.submittedOpenKeyCount = new AtomicLong(0);
+ this.runCount = new AtomicLong(0);
+ }
+
+ /**
+ * Returns the number of times this Background service has run.
+ *
+ * @return Long, run count.
+ */
+ @VisibleForTesting
+ public AtomicLong getRunCount() {
+ return runCount;
+ }
+
+ /**
+ * Returns the number of open keys that were submitted for deletion by this
+ * service. If these keys were committed from the open key table between
+ * being submitted for deletion and the actual delete operation, they will
+ * not be deleted.
+ *
+ * @return Long count.
+ */
+ @VisibleForTesting
+ public AtomicLong getSubmittedOpenKeyCount() {
+ return submittedOpenKeyCount;
}
@Override
public BackgroundTaskQueue getTasks() {
BackgroundTaskQueue queue = new BackgroundTaskQueue();
- queue.add(new OpenKeyDeletingTask());
+ queue.add(new OpenKeyCleanupTask());
return queue;
}
- private class OpenKeyDeletingTask implements BackgroundTask {
+ private boolean shouldRun() {
+ if (ozoneManager == null) {
+ // OzoneManager can be null for testing
+ return true;
+ }
+ return ozoneManager.isLeaderReady();
+ }
+
+ private boolean isRatisEnabled() {
+ if (ozoneManager == null) {
+ return false;
+ }
Review comment:
Same as above.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org