You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ozone.apache.org by si...@apache.org on 2021/02/20 09:43:14 UTC
[ozone] branch master updated: HDDS-4148. Add servlet to return SCM
DB checkpoint. (#1353)
This is an automated email from the ASF dual-hosted git repository.
siyao 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 dd61b17 HDDS-4148. Add servlet to return SCM DB checkpoint. (#1353)
dd61b17 is described below
commit dd61b1761016e5aa193db6f416ad8e21b98da662
Author: prashantpogde <pr...@gmail.com>
AuthorDate: Sat Feb 20 01:43:05 2021 -0800
HDDS-4148. Add servlet to return SCM DB checkpoint. (#1353)
---
.../java/org/apache/hadoop/ozone/OzoneConsts.java | 2 +
.../hadoop/hdds/utils/DBCheckpointMetrics.java | 95 +++++++++
.../hadoop/hdds/utils/DBCheckpointServlet.java | 113 ++++-------
.../hadoop/hdds/utils/db/RDBCheckpointManager.java | 2 +-
.../org/apache/hadoop/hdds/utils/db/RDBStore.java | 2 +-
.../container/placement/metrics/SCMMetrics.java | 8 +
.../hdds/scm/server/SCMDBCheckpointServlet.java | 64 ++++++
.../hdds/scm/server/StorageContainerManager.java | 19 +-
.../server/StorageContainerManagerHttpServer.java | 8 +-
.../scm/TestStorageContainerManagerHttpServer.java | 2 +-
.../scm/TestSCMDbCheckpointServlet.java} | 144 ++++---------
.../hadoop/ozone/om/TestOMDbCheckpointServlet.java | 54 +++--
.../hadoop/ozone/om/OMDBCheckpointServlet.java | 226 +--------------------
.../java/org/apache/hadoop/ozone/om/OMMetrics.java | 48 +----
14 files changed, 323 insertions(+), 464 deletions(-)
diff --git a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/OzoneConsts.java b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/OzoneConsts.java
index e860400..0651707 100644
--- a/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/OzoneConsts.java
+++ b/hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/OzoneConsts.java
@@ -230,6 +230,8 @@ public final class OzoneConsts {
// instance gets stored.
public static final String OM_CONTEXT_ATTRIBUTE = "ozone.om";
+ public static final String SCM_CONTEXT_ATTRIBUTE = "ozone.scm";
+
private OzoneConsts() {
// Never Constructed
}
diff --git a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointMetrics.java b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointMetrics.java
new file mode 100644
index 0000000..87dc882
--- /dev/null
+++ b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointMetrics.java
@@ -0,0 +1,95 @@
+/**
+ * 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.hdds.utils;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import org.apache.hadoop.hdds.annotation.InterfaceAudience;
+import org.apache.hadoop.metrics2.MetricsSystem;
+import org.apache.hadoop.metrics2.annotation.Metric;
+import org.apache.hadoop.metrics2.annotation.Metrics;
+import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
+import org.apache.hadoop.metrics2.lib.MutableCounterLong;
+import org.apache.hadoop.metrics2.lib.MutableGaugeLong;
+
+
+/**
+ * This interface is for maintaining DB checkpoint statistics.
+ */
+@InterfaceAudience.Private
+@Metrics(about="DB checkpoint Metrics", context="dfs")
+public class DBCheckpointMetrics {
+ private static final String SOURCE_NAME =
+ DBCheckpointMetrics.class.getSimpleName();
+
+ // Metrics to track checkpoint statistics from last run.
+ private @Metric MutableGaugeLong lastCheckpointCreationTimeTaken;
+ private @Metric MutableGaugeLong lastCheckpointStreamingTimeTaken;
+ private @Metric MutableCounterLong numCheckpoints;
+ private @Metric MutableCounterLong numCheckpointFails;
+
+ public DBCheckpointMetrics() {
+ }
+
+ public static DBCheckpointMetrics create(String parent) {
+ MetricsSystem ms = DefaultMetricsSystem.instance();
+ return ms.register(SOURCE_NAME,
+ parent,
+ new DBCheckpointMetrics());
+ }
+
+ @VisibleForTesting
+ public void setLastCheckpointCreationTimeTaken(long val) {
+ this.lastCheckpointCreationTimeTaken.set(val);
+ }
+
+ @VisibleForTesting
+ public void setLastCheckpointStreamingTimeTaken(long val) {
+ this.lastCheckpointStreamingTimeTaken.set(val);
+ }
+
+ @VisibleForTesting
+ public void incNumCheckpoints() {
+ numCheckpoints.incr();
+ }
+
+ @VisibleForTesting
+ public void incNumCheckpointFails() {
+ numCheckpointFails.incr();
+ }
+
+ @VisibleForTesting
+ public long getLastCheckpointCreationTimeTaken() {
+ return lastCheckpointCreationTimeTaken.value();
+ }
+
+ @VisibleForTesting
+ public long getNumCheckpoints() {
+ return numCheckpoints.value();
+ }
+
+ @VisibleForTesting
+ public long getNumCheckpointFails() {
+ return numCheckpointFails.value();
+ }
+
+ @VisibleForTesting
+ public long getLastCheckpointStreamingTimeTaken() {
+ return lastCheckpointStreamingTimeTaken.value();
+ }
+}
diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointServlet.java
similarity index 68%
copy from hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java
copy to hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointServlet.java
index dcb5392..f1ab608 100644
--- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java
+++ b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/DBCheckpointServlet.java
@@ -6,17 +6,16 @@
* 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>
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-package org.apache.hadoop.ozone.om;
+package org.apache.hadoop.hdds.utils;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
@@ -34,11 +33,8 @@ import java.util.Collection;
import java.util.stream.Collectors;
import java.util.stream.Stream;
-import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.utils.db.DBCheckpoint;
import org.apache.hadoop.hdds.utils.db.DBStore;
-import org.apache.hadoop.hdfs.util.DataTransferThrottler;
-import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveOutputStream;
@@ -56,74 +52,48 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Provides the current checkpoint Snapshot of the OM DB. (tar.gz)
- *
- * When Ozone ACL is enabled (`ozone.acl.enabled`=`true`), only users/principals
- * configured in `ozone.administrator` (along with the user that starts OM,
- * which automatically becomes an Ozone administrator but not necessarily in
- * the config) are allowed to access this endpoint.
- *
- * If Kerberos is enabled, the principal should be appended to
- * `ozone.administrator`, e.g. `scm/scm@EXAMPLE.COM`
- * If Kerberos is not enabled, simply append the login user name to
- * `ozone.administrator`, e.g. `scm`
+ * Provides the current checkpoint Snapshot of the OM/SCM DB. (tar.gz)
*/
-public class OMDBCheckpointServlet extends HttpServlet {
+public class DBCheckpointServlet extends HttpServlet {
private static final Logger LOG =
- LoggerFactory.getLogger(OMDBCheckpointServlet.class);
+ LoggerFactory.getLogger(DBCheckpointServlet.class);
private static final long serialVersionUID = 1L;
- private transient OzoneManager om;
- private transient DBStore omDbStore;
- private transient OMMetrics omMetrics;
- private transient DataTransferThrottler throttler = null;
+ private transient DBStore dbStore;
+ private transient DBCheckpointMetrics dbMetrics;
- @Override
- public void init() throws ServletException {
+ private boolean aclEnabled;
+ private Collection<String> ozAdmins;
- om = (OzoneManager) getServletContext()
- .getAttribute(OzoneConsts.OM_CONTEXT_ATTRIBUTE);
+ public void initialize(DBStore store, DBCheckpointMetrics metrics,
+ boolean omAclEnabled, Collection<String> ozoneAdmins)
+ throws ServletException {
- if (om == null) {
- LOG.error("Unable to initialize OMDBCheckpointServlet. OM is null");
- return;
+ dbStore = store;
+ dbMetrics = metrics;
+ if (dbStore == null) {
+ LOG.error(
+ "Unable to set metadata snapshot request. DB Store is null");
}
- omDbStore = om.getMetadataManager().getStore();
- omMetrics = om.getMetrics();
-
- OzoneConfiguration configuration = om.getConfiguration();
- long transferBandwidth = configuration.getLongBytes(
- OMConfigKeys.OZONE_DB_CHECKPOINT_TRANSFER_RATE_KEY,
- OMConfigKeys.OZONE_DB_CHECKPOINT_TRANSFER_RATE_DEFAULT);
-
- if (transferBandwidth > 0) {
- throttler = new DataTransferThrottler(transferBandwidth);
- }
+ this.aclEnabled = omAclEnabled;
+ this.ozAdmins = ozoneAdmins;
}
private boolean hasPermission(String username) {
// Check ACL for dbCheckpoint only when global Ozone ACL is enabled
- if (om.getAclsEnabled()) {
+ if (aclEnabled) {
// Only Ozone admins are allowed
- try {
- Collection<String> admins = om.getOzoneAdmins(om.getConfiguration());
- if (admins.contains(OZONE_ADMINISTRATORS_WILDCARD) ||
- admins.contains(username)) {
- return true;
- }
- } catch (IOException e) {
- LOG.warn("Error checking permission: {}", e.getMessage());
- }
- return false;
+ return ozAdmins.contains(OZONE_ADMINISTRATORS_WILDCARD)
+ || ozAdmins.contains(username);
} else {
return true;
}
}
/**
- * Process a GET request for the Ozone Manager DB checkpoint snapshot.
+ * Process a GET request for the DB checkpoint snapshot.
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
@@ -131,8 +101,8 @@ public class OMDBCheckpointServlet extends HttpServlet {
@Override
public void doGet(HttpServletRequest request, HttpServletResponse response) {
- LOG.info("Received request to obtain OM DB checkpoint snapshot");
- if (omDbStore == null) {
+ LOG.info("Received request to obtain DB checkpoint snapshot");
+ if (dbStore == null) {
LOG.error(
"Unable to process metadata snapshot request. DB Store is null");
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
@@ -140,12 +110,12 @@ public class OMDBCheckpointServlet extends HttpServlet {
}
// Check ACL for dbCheckpoint only when global Ozone ACL is enable
- if (om.getAclsEnabled()) {
+ if (aclEnabled) {
final java.security.Principal userPrincipal = request.getUserPrincipal();
if (userPrincipal == null) {
final String remoteUser = request.getRemoteUser();
LOG.error("Permission denied: Unauthorized access to /dbCheckpoint,"
- + " no user principal found. Current login user is {}.",
+ + " no user principal found. Current login user is {}.",
remoteUser != null ? "'" + remoteUser + "'" : "UNKNOWN");
response.setStatus(HttpServletResponse.SC_FORBIDDEN);
return;
@@ -153,10 +123,11 @@ public class OMDBCheckpointServlet extends HttpServlet {
final String userPrincipalName = userPrincipal.getName();
if (!hasPermission(userPrincipalName)) {
LOG.error("Permission denied: User principal '{}' does not have"
- + " access to /dbCheckpoint.\nThis can happen when Ozone Manager"
- + " is started with a different user.\nPlease append '{}' to OM"
- + " 'ozone.administrators' config and restart OM to grant current"
- + " user access to this endpoint.",
+ + " access to /dbCheckpoint.\nThis can happen when Ozone"
+ + " Manager is started with a different user.\n"
+ + " Please append '{}' to OM 'ozone.administrators'"
+ + " config and restart OM to grant current"
+ + " user access to this endpoint.",
userPrincipalName, userPrincipalName);
response.setStatus(HttpServletResponse.SC_FORBIDDEN);
return;
@@ -176,14 +147,14 @@ public class OMDBCheckpointServlet extends HttpServlet {
flush = Boolean.valueOf(flushParam);
}
- checkpoint = omDbStore.getCheckpoint(flush);
+ checkpoint = dbStore.getCheckpoint(flush);
if (checkpoint == null || checkpoint.getCheckpointLocation() == null) {
LOG.error("Unable to process metadata snapshot request. " +
"Checkpoint request returned null.");
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
return;
}
- omMetrics.setLastCheckpointCreationTimeTaken(
+ dbMetrics.setLastCheckpointCreationTimeTaken(
checkpoint.checkpointCreationTimeTaken());
Path file = checkpoint.getCheckpointLocation().getFileName();
@@ -196,20 +167,20 @@ public class OMDBCheckpointServlet extends HttpServlet {
file.toString() + ".tgz\"");
Instant start = Instant.now();
- writeOmDBCheckpointToStream(checkpoint,
+ writeDBCheckpointToStream(checkpoint,
response.getOutputStream());
Instant end = Instant.now();
long duration = Duration.between(start, end).toMillis();
LOG.info("Time taken to write the checkpoint to response output " +
"stream: {} milliseconds", duration);
- omMetrics.setLastCheckpointStreamingTimeTaken(duration);
- omMetrics.incNumCheckpoints();
+ dbMetrics.setLastCheckpointStreamingTimeTaken(duration);
+ dbMetrics.incNumCheckpoints();
} catch (Exception e) {
LOG.error(
"Unable to process metadata snapshot request. ", e);
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
- omMetrics.incNumCheckpointFails();
+ dbMetrics.incNumCheckpointFails();
} finally {
if (checkpoint != null) {
try {
@@ -223,13 +194,13 @@ public class OMDBCheckpointServlet extends HttpServlet {
}
/**
- * Write OM DB Checkpoint to an output stream as a compressed file (tgz).
+ * Write DB Checkpoint to an output stream as a compressed file (tgz).
*
* @param checkpoint checkpoint file
* @param destination desination output stream.
* @throws IOException
*/
- public static void writeOmDBCheckpointToStream(DBCheckpoint checkpoint,
+ public static void writeDBCheckpointToStream(DBCheckpoint checkpoint,
OutputStream destination)
throws IOException {
diff --git a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBCheckpointManager.java b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBCheckpointManager.java
index f70d63a..1879364 100644
--- a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBCheckpointManager.java
+++ b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBCheckpointManager.java
@@ -38,7 +38,7 @@ public class RDBCheckpointManager {
private final Checkpoint checkpoint;
private final RocksDB db;
- public static final String RDB_CHECKPOINT_DIR_PREFIX = "rdb_checkpoint_";
+ public static final String RDB_CHECKPOINT_DIR_PREFIX = "checkpoint_";
private static final Logger LOG =
LoggerFactory.getLogger(RDBCheckpointManager.class);
private String checkpointNamePrefix = "";
diff --git a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBStore.java b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBStore.java
index a7bad57..c67238d 100644
--- a/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBStore.java
+++ b/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/utils/db/RDBStore.java
@@ -150,7 +150,7 @@ public class RDBStore implements DBStore {
}
//Initialize checkpoint manager
- checkPointManager = new RDBCheckpointManager(db, "rdb");
+ checkPointManager = new RDBCheckpointManager(db, dbLocation.getName());
rdbMetrics = RDBMetrics.create();
} catch (RocksDBException e) {
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/placement/metrics/SCMMetrics.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/placement/metrics/SCMMetrics.java
index e4dd9aa..5194829 100644
--- a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/placement/metrics/SCMMetrics.java
+++ b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/placement/metrics/SCMMetrics.java
@@ -17,6 +17,7 @@
*/
package org.apache.hadoop.hdds.scm.container.placement.metrics;
+import org.apache.hadoop.hdds.utils.DBCheckpointMetrics;
import org.apache.hadoop.metrics2.MetricsSystem;
import org.apache.hadoop.metrics2.annotation.Metric;
import org.apache.hadoop.metrics2.annotation.Metrics;
@@ -52,7 +53,14 @@ public class SCMMetrics {
@Metric private MutableCounterLong containerReportReadCount;
@Metric private MutableCounterLong containerReportWriteCount;
+ private DBCheckpointMetrics dbCheckpointMetrics;
+
+ public DBCheckpointMetrics getDBCheckpointMetrics() {
+ return dbCheckpointMetrics;
+ }
+
public SCMMetrics() {
+ dbCheckpointMetrics = DBCheckpointMetrics.create("SCM Metrics");
}
public static SCMMetrics create() {
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMDBCheckpointServlet.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMDBCheckpointServlet.java
new file mode 100644
index 0000000..7614161
--- /dev/null
+++ b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMDBCheckpointServlet.java
@@ -0,0 +1,64 @@
+/**
+ * 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.hdds.scm.server;
+
+import javax.servlet.ServletException;
+import org.apache.hadoop.hdds.utils.DBCheckpointServlet;
+import org.apache.hadoop.ozone.OzoneConsts;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Collections;
+
+/**
+ * Provides the current checkpoint Snapshot of the SCM DB. (tar.gz)
+ *
+ * When Ozone ACL is enabled (`ozone.acl.enabled`=`true`), only users/principals
+ * configured in `ozone.administrator` (along with the user that starts OM,
+ * which automatically becomes an Ozone administrator but not necessarily in
+ * the config) are allowed to access this endpoint.
+ *
+ * If Kerberos is enabled, the principal should be appended to
+ * `ozone.administrator`, e.g. `scm/scm@EXAMPLE.COM`
+ * If Kerberos is not enabled, simply append the login user name to
+ * `ozone.administrator`, e.g. `scm`
+ */
+public class SCMDBCheckpointServlet extends DBCheckpointServlet {
+
+ private static final Logger LOG =
+ LoggerFactory.getLogger(SCMDBCheckpointServlet.class);
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public void init() throws ServletException {
+
+ StorageContainerManager scm = (StorageContainerManager) getServletContext()
+ .getAttribute(OzoneConsts.SCM_CONTEXT_ATTRIBUTE);
+
+ if (scm == null) {
+ LOG.error("Unable to initialize SCMDBCheckpointServlet. SCM is null");
+ return;
+ }
+
+ initialize(scm.getScmMetadataStore().getStore(),
+ scm.getMetrics().getDBCheckpointMetrics(),
+ false,
+ Collections.emptyList());
+ }
+}
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManager.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManager.java
index 0a26c8f..bca98ed 100644
--- a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManager.java
+++ b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManager.java
@@ -174,7 +174,7 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
/*
* HTTP endpoint for JMX access.
*/
- private final StorageContainerManagerHttpServer httpServer;
+ private StorageContainerManagerHttpServer httpServer;
/**
* SCM super user.
*/
@@ -221,7 +221,6 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
this(conf, new SCMConfigurator());
}
-
/**
* This constructor offers finer control over how SCM comes up.
* To use this, user needs to create a SCMConfigurator and set various
@@ -333,7 +332,6 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
eventQueue);
blockProtocolServer = new SCMBlockProtocolServer(conf, this);
clientProtocolServer = new SCMClientProtocolServer(conf, this);
- httpServer = new StorageContainerManagerHttpServer(conf);
eventQueue.addHandler(SCMEvents.DATANODE_COMMAND, scmNodeManager);
eventQueue.addHandler(SCMEvents.RETRIABLE_DATANODE_COMMAND, scmNodeManager);
eventQueue.addHandler(SCMEvents.NODE_REPORT, nodeReportHandler);
@@ -363,13 +361,17 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
eventQueue
.addHandler(SCMEvents.DELAYED_SAFE_MODE_STATUS, pipelineManager);
-
// Emit initial safe mode status, as now handlers are registered.
scmSafeModeManager.emitSafeModeStatus();
+
registerMXBean();
registerMetricsSource(this);
}
+ public OzoneConfiguration getConfiguration() {
+ return configuration;
+ }
+
/**
* This function initializes the following managers. If the configurator
* specifies a value, we will use it, else we will use the default value.
@@ -831,7 +833,6 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
getSecurityProtocolServer().start();
}
- httpServer.start();
scmBlockManager.start();
// Start jvm monitor
@@ -839,6 +840,14 @@ public final class StorageContainerManager extends ServiceRuntimeInfoImpl
jvmPauseMonitor.init(configuration);
jvmPauseMonitor.start();
+ try {
+ httpServer = new StorageContainerManagerHttpServer(configuration, this);
+ httpServer.start();
+ } catch (Exception ex) {
+ // SCM HttpServer start-up failure should be non-fatal
+ LOG.error("SCM HttpServer failed to start.", ex);
+ }
+
setStartTime();
}
diff --git a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManagerHttpServer.java b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManagerHttpServer.java
index 8a94462..f7a0761 100644
--- a/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManagerHttpServer.java
+++ b/hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManagerHttpServer.java
@@ -22,15 +22,21 @@ import java.io.IOException;
import org.apache.hadoop.hdds.conf.MutableConfigurationSource;
import org.apache.hadoop.hdds.scm.ScmConfigKeys;
import org.apache.hadoop.hdds.server.http.BaseHttpServer;
+import org.apache.hadoop.ozone.OzoneConsts;
+import static org.apache.hadoop.ozone.OzoneConsts.OZONE_OM_DB_CHECKPOINT_HTTP_ENDPOINT;
/**
* HttpServer2 wrapper for the Ozone Storage Container Manager.
*/
public class StorageContainerManagerHttpServer extends BaseHttpServer {
- public StorageContainerManagerHttpServer(MutableConfigurationSource conf)
+ public StorageContainerManagerHttpServer(MutableConfigurationSource conf,
+ StorageContainerManager scm)
throws IOException {
super(conf, "scm");
+ addServlet("dbCheckpoint", OZONE_OM_DB_CHECKPOINT_HTTP_ENDPOINT,
+ SCMDBCheckpointServlet.class);
+ getWebAppContext().setAttribute(OzoneConsts.SCM_CONTEXT_ATTRIBUTE, scm);
}
@Override protected String getHttpAddressKey() {
diff --git a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/TestStorageContainerManagerHttpServer.java b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/TestStorageContainerManagerHttpServer.java
index 70b8ad4..20d5485 100644
--- a/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/TestStorageContainerManagerHttpServer.java
+++ b/hadoop-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/TestStorageContainerManagerHttpServer.java
@@ -104,7 +104,7 @@ public class TestStorageContainerManagerHttpServer {
StorageContainerManagerHttpServer server = null;
try {
DefaultMetricsSystem.initialize("TestStorageContainerManagerHttpServer");
- server = new StorageContainerManagerHttpServer(conf);
+ server = new StorageContainerManagerHttpServer(conf, null);
server.start();
Assert.assertTrue(implies(policy.isHttpEnabled(),
diff --git a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMDbCheckpointServlet.java
similarity index 55%
copy from hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java
copy to hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMDbCheckpointServlet.java
index 2a52c96..7c3a8a9 100644
--- a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java
+++ b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/hdds/scm/TestSCMDbCheckpointServlet.java
@@ -6,17 +6,16 @@
* 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>
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-package org.apache.hadoop.ozone.om;
+package org.apache.hadoop.hdds.scm;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
@@ -25,33 +24,24 @@ import javax.servlet.WriteListener;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
-import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
-import java.io.OutputStreamWriter;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Path;
-import java.nio.file.Paths;
+import java.util.Collections;
import java.util.UUID;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
-import org.apache.hadoop.hdds.utils.db.DBCheckpoint;
-import org.apache.hadoop.io.IOUtils;
+import org.apache.hadoop.hdds.scm.container.placement.metrics.SCMMetrics;
+import org.apache.hadoop.hdds.scm.server.SCMDBCheckpointServlet;
+import org.apache.hadoop.hdds.scm.server.StorageContainerManager;
import org.apache.hadoop.ozone.MiniOzoneCluster;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.commons.io.FileUtils;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ACL_ENABLED;
-import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS;
-import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS_WILDCARD;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_SECONDS;
import static org.apache.hadoop.ozone.OzoneConsts.OZONE_DB_CHECKPOINT_REQUEST_FLUSH;
-import static org.apache.hadoop.ozone.om.OMDBCheckpointServlet.writeOmDBCheckpointToStream;
-
-import org.apache.hadoop.security.UserGroupInformation;
import org.junit.After;
import org.junit.Assert;
-import static org.junit.Assert.assertNotNull;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
@@ -66,16 +56,17 @@ import static org.mockito.Mockito.when;
/**
* Class used for testing the OM DB Checkpoint provider servlet.
*/
-public class TestOMDbCheckpointServlet {
+public class TestSCMDbCheckpointServlet {
private MiniOzoneCluster cluster = null;
- private OMMetrics omMetrics;
+ private StorageContainerManager scm;
+ private SCMMetrics scmMetrics;
private OzoneConfiguration conf;
private String clusterId;
private String scmId;
private String omId;
@Rule
- public Timeout timeout = new Timeout(60000);
+ public Timeout timeout = new Timeout(240000);
@Rule
public TemporaryFolder folder = new TemporaryFolder();
@@ -92,8 +83,7 @@ public class TestOMDbCheckpointServlet {
clusterId = UUID.randomUUID().toString();
scmId = UUID.randomUUID().toString();
omId = UUID.randomUUID().toString();
- conf.setBoolean(OZONE_ACL_ENABLED, false);
- conf.set(OZONE_ADMINISTRATORS, OZONE_ADMINISTRATORS_WILDCARD);
+ conf.setBoolean(OZONE_ACL_ENABLED, true);
conf.setInt(OZONE_OPEN_KEY_EXPIRE_THRESHOLD_SECONDS, 2);
cluster = MiniOzoneCluster.newBuilder(conf)
.setClusterId(clusterId)
@@ -101,7 +91,8 @@ public class TestOMDbCheckpointServlet {
.setOmId(omId)
.build();
cluster.waitForClusterToBeReady();
- omMetrics = cluster.getOzoneManager().getMetrics();
+ scm = cluster.getStorageContainerManager();
+ scmMetrics = StorageContainerManager.getMetrics();
}
/**
@@ -119,23 +110,25 @@ public class TestOMDbCheckpointServlet {
File tempFile = null;
try {
- OMDBCheckpointServlet omDbCheckpointServletMock =
- mock(OMDBCheckpointServlet.class);
+ SCMDBCheckpointServlet scmDbCheckpointServletMock =
+ mock(SCMDBCheckpointServlet.class);
- doCallRealMethod().when(omDbCheckpointServletMock).init();
+ doCallRealMethod().when(scmDbCheckpointServletMock).init();
+ doCallRealMethod().when(scmDbCheckpointServletMock).initialize(
+ scm.getScmMetadataStore().getStore(),
+ scmMetrics.getDBCheckpointMetrics(),
+ false,
+ Collections.emptyList());
HttpServletRequest requestMock = mock(HttpServletRequest.class);
- // Return current user short name when asked
- when(requestMock.getRemoteUser())
- .thenReturn(UserGroupInformation.getCurrentUser().getShortUserName());
HttpServletResponse responseMock = mock(HttpServletResponse.class);
ServletContext servletContextMock = mock(ServletContext.class);
- when(omDbCheckpointServletMock.getServletContext())
+ when(scmDbCheckpointServletMock.getServletContext())
.thenReturn(servletContextMock);
- when(servletContextMock.getAttribute(OzoneConsts.OM_CONTEXT_ATTRIBUTE))
- .thenReturn(cluster.getOzoneManager());
+ when(servletContextMock.getAttribute(OzoneConsts.SCM_CONTEXT_ATTRIBUTE))
+ .thenReturn(cluster.getStorageContainerManager());
when(requestMock.getParameter(OZONE_DB_CHECKPOINT_REQUEST_FLUSH))
.thenReturn("true");
doNothing().when(responseMock).setContentType("application/x-tgz");
@@ -163,90 +156,27 @@ public class TestOMDbCheckpointServlet {
}
});
- doCallRealMethod().when(omDbCheckpointServletMock).doGet(requestMock,
+ doCallRealMethod().when(scmDbCheckpointServletMock).doGet(requestMock,
responseMock);
- omDbCheckpointServletMock.init();
- long initialCheckpointCount = omMetrics.getNumCheckpoints();
+ scmDbCheckpointServletMock.init();
+ long initialCheckpointCount =
+ scmMetrics.getDBCheckpointMetrics().getNumCheckpoints();
- omDbCheckpointServletMock.doGet(requestMock, responseMock);
+ scmDbCheckpointServletMock.doGet(requestMock, responseMock);
Assert.assertTrue(tempFile.length() > 0);
Assert.assertTrue(
- omMetrics.getLastCheckpointCreationTimeTaken() > 0);
+ scmMetrics.getDBCheckpointMetrics().
+ getLastCheckpointCreationTimeTaken() > 0);
Assert.assertTrue(
- omMetrics.getLastCheckpointStreamingTimeTaken() > 0);
- Assert.assertTrue(omMetrics.getNumCheckpoints() > initialCheckpointCount);
+ scmMetrics.getDBCheckpointMetrics().
+ getLastCheckpointStreamingTimeTaken() > 0);
+ Assert.assertTrue(scmMetrics.getDBCheckpointMetrics().
+ getNumCheckpoints() > initialCheckpointCount);
} finally {
FileUtils.deleteQuietly(tempFile);
}
}
-
- @Test
- public void testWriteCheckpointToOutputStream() throws Exception {
-
- FileInputStream fis = null;
- FileOutputStream fos = null;
-
- try {
- String testDirName = folder.newFolder().getAbsolutePath();
- File file = new File(testDirName + "/temp1.txt");
- OutputStreamWriter writer = new OutputStreamWriter(
- new FileOutputStream(file), StandardCharsets.UTF_8);
- writer.write("Test data 1");
- writer.close();
-
- file = new File(testDirName + "/temp2.txt");
- writer = new OutputStreamWriter(
- new FileOutputStream(file), StandardCharsets.UTF_8);
- writer.write("Test data 2");
- writer.close();
-
- File outputFile =
- new File(Paths.get(testDirName, "output_file.tgz").toString());
- TestDBCheckpoint dbCheckpoint = new TestDBCheckpoint(
- Paths.get(testDirName));
- writeOmDBCheckpointToStream(dbCheckpoint,
- new FileOutputStream(outputFile));
- assertNotNull(outputFile);
- } finally {
- IOUtils.closeStream(fis);
- IOUtils.closeStream(fos);
- }
- }
}
-
-class TestDBCheckpoint implements DBCheckpoint {
-
- private Path checkpointFile;
-
- TestDBCheckpoint(Path checkpointFile) {
- this.checkpointFile = checkpointFile;
- }
-
- @Override
- public Path getCheckpointLocation() {
- return checkpointFile;
- }
-
- @Override
- public long getCheckpointTimestamp() {
- return 0;
- }
-
- @Override
- public long getLatestSequenceNumber() {
- return 0;
- }
-
- @Override
- public long checkpointCreationTimeTaken() {
- return 0;
- }
-
- @Override
- public void cleanupCheckpoint() throws IOException {
- FileUtils.deleteDirectory(checkpointFile.toFile());
- }
-}
\ No newline at end of file
diff --git a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java
index 2a52c96..3a90ae1 100644
--- a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java
+++ b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java
@@ -39,6 +39,7 @@ import org.apache.hadoop.hdds.utils.db.DBCheckpoint;
import org.apache.hadoop.io.IOUtils;
import org.apache.hadoop.ozone.MiniOzoneCluster;
import org.apache.hadoop.ozone.OzoneConsts;
+import org.apache.hadoop.security.UserGroupInformation;
import org.apache.commons.io.FileUtils;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ACL_ENABLED;
@@ -46,13 +47,11 @@ import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS_WILDCARD;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_OPEN_KEY_EXPIRE_THRESHOLD_SECONDS;
import static org.apache.hadoop.ozone.OzoneConsts.OZONE_DB_CHECKPOINT_REQUEST_FLUSH;
-import static org.apache.hadoop.ozone.om.OMDBCheckpointServlet.writeOmDBCheckpointToStream;
-
-import org.apache.hadoop.security.UserGroupInformation;
-import org.junit.After;
+import static org.apache.hadoop.ozone.om.OMDBCheckpointServlet.writeDBCheckpointToStream;
+import org.junit.AfterClass;
import org.junit.Assert;
import static org.junit.Assert.assertNotNull;
-import org.junit.Before;
+import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
@@ -67,15 +66,15 @@ import static org.mockito.Mockito.when;
* Class used for testing the OM DB Checkpoint provider servlet.
*/
public class TestOMDbCheckpointServlet {
- private MiniOzoneCluster cluster = null;
- private OMMetrics omMetrics;
- private OzoneConfiguration conf;
- private String clusterId;
- private String scmId;
- private String omId;
+ private static MiniOzoneCluster cluster = null;
+ private static OMMetrics omMetrics;
+ private static OzoneConfiguration conf;
+ private static String clusterId;
+ private static String scmId;
+ private static String omId;
@Rule
- public Timeout timeout = new Timeout(60000);
+ public Timeout timeout = new Timeout(240000);
@Rule
public TemporaryFolder folder = new TemporaryFolder();
@@ -86,8 +85,8 @@ public class TestOMDbCheckpointServlet {
*
* @throws IOException
*/
- @Before
- public void init() throws Exception {
+ @BeforeClass
+ public static void init() throws Exception {
conf = new OzoneConfiguration();
clusterId = UUID.randomUUID().toString();
scmId = UUID.randomUUID().toString();
@@ -99,6 +98,7 @@ public class TestOMDbCheckpointServlet {
.setClusterId(clusterId)
.setScmId(scmId)
.setOmId(omId)
+ .setNumDatanodes(1)
.build();
cluster.waitForClusterToBeReady();
omMetrics = cluster.getOzoneManager().getMetrics();
@@ -107,8 +107,8 @@ public class TestOMDbCheckpointServlet {
/**
* Shutdown MiniDFSCluster.
*/
- @After
- public void shutdown() {
+ @AfterClass
+ public static void shutdown() {
if (cluster != null) {
cluster.shutdown();
}
@@ -116,13 +116,19 @@ public class TestOMDbCheckpointServlet {
@Test
public void testDoGet() throws ServletException, IOException {
-
File tempFile = null;
try {
OMDBCheckpointServlet omDbCheckpointServletMock =
mock(OMDBCheckpointServlet.class);
+ final OzoneManager om = cluster.getOzoneManager();
+
doCallRealMethod().when(omDbCheckpointServletMock).init();
+ doCallRealMethod().when(omDbCheckpointServletMock).initialize(
+ om.getMetadataManager().getStore(),
+ om.getMetrics().getDBCheckpointMetrics(),
+ om.getAclsEnabled(),
+ om.getOzoneAdmins(om.getConfiguration()));
HttpServletRequest requestMock = mock(HttpServletRequest.class);
// Return current user short name when asked
@@ -167,16 +173,20 @@ public class TestOMDbCheckpointServlet {
responseMock);
omDbCheckpointServletMock.init();
- long initialCheckpointCount = omMetrics.getNumCheckpoints();
+ long initialCheckpointCount =
+ omMetrics.getDBCheckpointMetrics().getNumCheckpoints();
omDbCheckpointServletMock.doGet(requestMock, responseMock);
Assert.assertTrue(tempFile.length() > 0);
Assert.assertTrue(
- omMetrics.getLastCheckpointCreationTimeTaken() > 0);
+ omMetrics.getDBCheckpointMetrics().
+ getLastCheckpointCreationTimeTaken() > 0);
Assert.assertTrue(
- omMetrics.getLastCheckpointStreamingTimeTaken() > 0);
- Assert.assertTrue(omMetrics.getNumCheckpoints() > initialCheckpointCount);
+ omMetrics.getDBCheckpointMetrics().
+ getLastCheckpointStreamingTimeTaken() > 0);
+ Assert.assertTrue(omMetrics.getDBCheckpointMetrics().
+ getNumCheckpoints() > initialCheckpointCount);
} finally {
FileUtils.deleteQuietly(tempFile);
}
@@ -207,7 +217,7 @@ public class TestOMDbCheckpointServlet {
new File(Paths.get(testDirName, "output_file.tgz").toString());
TestDBCheckpoint dbCheckpoint = new TestDBCheckpoint(
Paths.get(testDirName));
- writeOmDBCheckpointToStream(dbCheckpoint,
+ writeDBCheckpointToStream(dbCheckpoint,
new FileOutputStream(outputFile));
assertNotNull(outputFile);
} finally {
diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java
index dcb5392..39868b4 100644
--- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java
+++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java
@@ -19,42 +19,15 @@
package org.apache.hadoop.ozone.om;
import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.time.Duration;
-import java.time.Instant;
-import java.util.Collection;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-import org.apache.hadoop.hdds.conf.OzoneConfiguration;
-import org.apache.hadoop.hdds.utils.db.DBCheckpoint;
-import org.apache.hadoop.hdds.utils.db.DBStore;
-import org.apache.hadoop.hdfs.util.DataTransferThrottler;
+import org.apache.hadoop.hdds.utils.DBCheckpointServlet;
import org.apache.hadoop.ozone.OzoneConsts;
-import org.apache.commons.compress.archivers.ArchiveEntry;
-import org.apache.commons.compress.archivers.ArchiveOutputStream;
-import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
-import org.apache.commons.compress.compressors.CompressorException;
-import org.apache.commons.compress.compressors.CompressorOutputStream;
-import org.apache.commons.compress.compressors.CompressorStreamFactory;
-import org.apache.commons.compress.utils.IOUtils;
-import org.apache.commons.lang3.StringUtils;
-
-import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_ADMINISTRATORS_WILDCARD;
-import static org.apache.hadoop.ozone.OzoneConsts.OZONE_DB_CHECKPOINT_REQUEST_FLUSH;
-
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import java.io.IOException;
+
/**
* Provides the current checkpoint Snapshot of the OM DB. (tar.gz)
*
@@ -68,21 +41,16 @@ import org.slf4j.LoggerFactory;
* If Kerberos is not enabled, simply append the login user name to
* `ozone.administrator`, e.g. `scm`
*/
-public class OMDBCheckpointServlet extends HttpServlet {
+public class OMDBCheckpointServlet extends DBCheckpointServlet {
private static final Logger LOG =
LoggerFactory.getLogger(OMDBCheckpointServlet.class);
private static final long serialVersionUID = 1L;
- private transient OzoneManager om;
- private transient DBStore omDbStore;
- private transient OMMetrics omMetrics;
- private transient DataTransferThrottler throttler = null;
-
@Override
public void init() throws ServletException {
- om = (OzoneManager) getServletContext()
+ OzoneManager om = (OzoneManager) getServletContext()
.getAttribute(OzoneConsts.OM_CONTEXT_ATTRIBUTE);
if (om == null) {
@@ -90,185 +58,13 @@ public class OMDBCheckpointServlet extends HttpServlet {
return;
}
- omDbStore = om.getMetadataManager().getStore();
- omMetrics = om.getMetrics();
-
- OzoneConfiguration configuration = om.getConfiguration();
- long transferBandwidth = configuration.getLongBytes(
- OMConfigKeys.OZONE_DB_CHECKPOINT_TRANSFER_RATE_KEY,
- OMConfigKeys.OZONE_DB_CHECKPOINT_TRANSFER_RATE_DEFAULT);
-
- if (transferBandwidth > 0) {
- throttler = new DataTransferThrottler(transferBandwidth);
- }
- }
-
- private boolean hasPermission(String username) {
- // Check ACL for dbCheckpoint only when global Ozone ACL is enabled
- if (om.getAclsEnabled()) {
- // Only Ozone admins are allowed
- try {
- Collection<String> admins = om.getOzoneAdmins(om.getConfiguration());
- if (admins.contains(OZONE_ADMINISTRATORS_WILDCARD) ||
- admins.contains(username)) {
- return true;
- }
- } catch (IOException e) {
- LOG.warn("Error checking permission: {}", e.getMessage());
- }
- return false;
- } else {
- return true;
- }
- }
-
- /**
- * Process a GET request for the Ozone Manager DB checkpoint snapshot.
- *
- * @param request The servlet request we are processing
- * @param response The servlet response we are creating
- */
- @Override
- public void doGet(HttpServletRequest request, HttpServletResponse response) {
-
- LOG.info("Received request to obtain OM DB checkpoint snapshot");
- if (omDbStore == null) {
- LOG.error(
- "Unable to process metadata snapshot request. DB Store is null");
- response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
- return;
- }
-
- // Check ACL for dbCheckpoint only when global Ozone ACL is enable
- if (om.getAclsEnabled()) {
- final java.security.Principal userPrincipal = request.getUserPrincipal();
- if (userPrincipal == null) {
- final String remoteUser = request.getRemoteUser();
- LOG.error("Permission denied: Unauthorized access to /dbCheckpoint,"
- + " no user principal found. Current login user is {}.",
- remoteUser != null ? "'" + remoteUser + "'" : "UNKNOWN");
- response.setStatus(HttpServletResponse.SC_FORBIDDEN);
- return;
- } else {
- final String userPrincipalName = userPrincipal.getName();
- if (!hasPermission(userPrincipalName)) {
- LOG.error("Permission denied: User principal '{}' does not have"
- + " access to /dbCheckpoint.\nThis can happen when Ozone Manager"
- + " is started with a different user.\nPlease append '{}' to OM"
- + " 'ozone.administrators' config and restart OM to grant current"
- + " user access to this endpoint.",
- userPrincipalName, userPrincipalName);
- response.setStatus(HttpServletResponse.SC_FORBIDDEN);
- return;
- }
- LOG.debug("Granted user principal '{}' access to /dbCheckpoint.",
- userPrincipalName);
- }
- }
-
- DBCheckpoint checkpoint = null;
try {
-
- boolean flush = false;
- String flushParam =
- request.getParameter(OZONE_DB_CHECKPOINT_REQUEST_FLUSH);
- if (StringUtils.isNotEmpty(flushParam)) {
- flush = Boolean.valueOf(flushParam);
- }
-
- checkpoint = omDbStore.getCheckpoint(flush);
- if (checkpoint == null || checkpoint.getCheckpointLocation() == null) {
- LOG.error("Unable to process metadata snapshot request. " +
- "Checkpoint request returned null.");
- response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
- return;
- }
- omMetrics.setLastCheckpointCreationTimeTaken(
- checkpoint.checkpointCreationTimeTaken());
-
- Path file = checkpoint.getCheckpointLocation().getFileName();
- if (file == null) {
- return;
- }
- response.setContentType("application/x-tgz");
- response.setHeader("Content-Disposition",
- "attachment; filename=\"" +
- file.toString() + ".tgz\"");
-
- Instant start = Instant.now();
- writeOmDBCheckpointToStream(checkpoint,
- response.getOutputStream());
- Instant end = Instant.now();
-
- long duration = Duration.between(start, end).toMillis();
- LOG.info("Time taken to write the checkpoint to response output " +
- "stream: {} milliseconds", duration);
- omMetrics.setLastCheckpointStreamingTimeTaken(duration);
- omMetrics.incNumCheckpoints();
- } catch (Exception e) {
- LOG.error(
- "Unable to process metadata snapshot request. ", e);
- response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
- omMetrics.incNumCheckpointFails();
- } finally {
- if (checkpoint != null) {
- try {
- checkpoint.cleanupCheckpoint();
- } catch (IOException e) {
- LOG.error("Error trying to clean checkpoint at {} .",
- checkpoint.getCheckpointLocation().toString());
- }
- }
- }
- }
-
- /**
- * Write OM DB Checkpoint to an output stream as a compressed file (tgz).
- *
- * @param checkpoint checkpoint file
- * @param destination desination output stream.
- * @throws IOException
- */
- public static void writeOmDBCheckpointToStream(DBCheckpoint checkpoint,
- OutputStream destination)
- throws IOException {
-
- try (CompressorOutputStream gzippedOut = new CompressorStreamFactory()
- .createCompressorOutputStream(CompressorStreamFactory.GZIP,
- destination)) {
-
- try (ArchiveOutputStream archiveOutputStream =
- new TarArchiveOutputStream(gzippedOut)) {
-
- Path checkpointPath = checkpoint.getCheckpointLocation();
- try (Stream<Path> files = Files.list(checkpointPath)) {
- for (Path path : files.collect(Collectors.toList())) {
- if (path != null) {
- Path fileName = path.getFileName();
- if (fileName != null) {
- includeFile(path.toFile(), fileName.toString(),
- archiveOutputStream);
- }
- }
- }
- }
- }
- } catch (CompressorException e) {
- throw new IOException(
- "Can't compress the checkpoint: " +
- checkpoint.getCheckpointLocation(), e);
- }
- }
-
- private static void includeFile(File file, String entryName,
- ArchiveOutputStream archiveOutputStream)
- throws IOException {
- ArchiveEntry archiveEntry =
- archiveOutputStream.createArchiveEntry(file, entryName);
- archiveOutputStream.putArchiveEntry(archiveEntry);
- try (FileInputStream fis = new FileInputStream(file)) {
- IOUtils.copy(fis, archiveOutputStream);
+ initialize(om.getMetadataManager().getStore(),
+ om.getMetrics().getDBCheckpointMetrics(),
+ om.getAclsEnabled(),
+ om.getOzoneAdmins(om.getConfiguration()));
+ } catch (IOException e) {
+ LOG.error("Error in getOzoneAdmins: {}", e.getMessage());
}
- archiveOutputStream.closeArchiveEntry();
}
}
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 bc48343..7ce0a16 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
@@ -20,12 +20,12 @@ package org.apache.hadoop.ozone.om;
import com.google.common.annotations.VisibleForTesting;
import org.apache.hadoop.hdds.annotation.InterfaceAudience;
+import org.apache.hadoop.hdds.utils.DBCheckpointMetrics;
import org.apache.hadoop.metrics2.MetricsSystem;
import org.apache.hadoop.metrics2.annotation.Metric;
import org.apache.hadoop.metrics2.annotation.Metrics;
import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
import org.apache.hadoop.metrics2.lib.MutableCounterLong;
-import org.apache.hadoop.metrics2.lib.MutableGaugeLong;
/**
* This class is for maintaining Ozone Manager statistics.
@@ -131,14 +131,6 @@ public class OMMetrics {
// few minutes before restart may not be included in this count.
private @Metric MutableCounterLong numKeys;
-
-
- // Metrics to track checkpointing statistics from last run.
- private @Metric MutableGaugeLong lastCheckpointCreationTimeTaken;
- private @Metric MutableGaugeLong lastCheckpointStreamingTimeTaken;
- private @Metric MutableCounterLong numCheckpoints;
- private @Metric MutableCounterLong numCheckpointFails;
-
private @Metric MutableCounterLong numBucketS3Creates;
private @Metric MutableCounterLong numBucketS3CreateFails;
private @Metric MutableCounterLong numBucketS3Deletes;
@@ -163,7 +155,10 @@ public class OMMetrics {
private @Metric MutableCounterLong numTrashRootsEnqueued;
private @Metric MutableCounterLong numTrashRootsProcessed;
+ private final DBCheckpointMetrics dbCheckpointMetrics;
+
public OMMetrics() {
+ dbCheckpointMetrics = DBCheckpointMetrics.create("OM Metrics");
}
public static OMMetrics create() {
@@ -173,6 +168,10 @@ public class OMMetrics {
new OMMetrics());
}
+ public DBCheckpointMetrics getDBCheckpointMetrics() {
+ return dbCheckpointMetrics;
+ }
+
public void incNumS3BucketCreates() {
numBucketOps.incr();
numBucketS3Creates.incr();
@@ -553,22 +552,6 @@ public class OMMetrics {
numGetServiceListFails.incr();
}
- public void setLastCheckpointCreationTimeTaken(long val) {
- this.lastCheckpointCreationTimeTaken.set(val);
- }
-
- public void setLastCheckpointStreamingTimeTaken(long val) {
- this.lastCheckpointStreamingTimeTaken.set(val);
- }
-
- public void incNumCheckpoints() {
- numCheckpoints.incr();
- }
-
- public void incNumCheckpointFails() {
- numCheckpointFails.incr();
- }
-
public void incNumOpenKeyDeleteRequests() {
numOpenKeyDeleteRequests.incr();
}
@@ -842,21 +825,6 @@ public class OMMetrics {
return numAbortMultipartUploadFails.value();
}
- @VisibleForTesting
- public long getLastCheckpointCreationTimeTaken() {
- return lastCheckpointCreationTimeTaken.value();
- }
-
- @VisibleForTesting
- public long getNumCheckpoints() {
- return numCheckpoints.value();
- }
-
- @VisibleForTesting
- public long getLastCheckpointStreamingTimeTaken() {
- return lastCheckpointStreamingTimeTaken.value();
- }
-
public long getNumOpenKeyDeleteRequests() {
return numOpenKeyDeleteRequests.value();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@ozone.apache.org
For additional commands, e-mail: commits-help@ozone.apache.org