errose28 commented on code in PR #8039: URL: https://github.com/apache/ozone/pull/8039#discussion_r1992425023
########## hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/RocksDBManualCompaction.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.repair.ldb; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.apache.hadoop.hdds.cli.HddsVersionProvider; +import org.apache.hadoop.hdds.utils.IOUtils; +import org.apache.hadoop.hdds.utils.db.managed.ManagedCompactRangeOptions; +import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB; +import org.apache.hadoop.ozone.debug.RocksDBUtils; +import org.apache.hadoop.ozone.repair.RepairTool; +import org.rocksdb.ColumnFamilyDescriptor; +import org.rocksdb.ColumnFamilyHandle; +import org.rocksdb.RocksDBException; +import picocli.CommandLine; + +/** + * Tool to perform compaction on a table. + */ +@CommandLine.Command( + name = "compact", + description = "CLI to compact a column-family in the DB. " + + "Note: If om.db is compacted then it will impact efficient snapshot diff.", + mixinStandardHelpOptions = true, + versionProvider = HddsVersionProvider.class +) +public class RocksDBManualCompaction extends RepairTool { + + @CommandLine.Option(names = {"--db"}, + required = true, + description = "Database File Path") + private String dbPath; + + @CommandLine.Option(names = {"--column_family", "--column-family", "--cf"}, Review Comment: This order means that if the flag is omitted, the kebab case version is the first suggestion, which is more standard. ```suggestion @CommandLine.Option(names = {"--column-family", "--column_family", "--cf"}, ``` ########## hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/RocksDBManualCompaction.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.repair.ldb; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.apache.hadoop.hdds.cli.HddsVersionProvider; +import org.apache.hadoop.hdds.utils.IOUtils; +import org.apache.hadoop.hdds.utils.db.managed.ManagedCompactRangeOptions; +import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB; +import org.apache.hadoop.ozone.debug.RocksDBUtils; +import org.apache.hadoop.ozone.repair.RepairTool; +import org.rocksdb.ColumnFamilyDescriptor; +import org.rocksdb.ColumnFamilyHandle; +import org.rocksdb.RocksDBException; +import picocli.CommandLine; + +/** + * Tool to perform compaction on a table. + */ +@CommandLine.Command( + name = "compact", + description = "CLI to compact a column-family in the DB. " + + "Note: If om.db is compacted then it will impact efficient snapshot diff.", + mixinStandardHelpOptions = true, + versionProvider = HddsVersionProvider.class +) +public class RocksDBManualCompaction extends RepairTool { + + @CommandLine.Option(names = {"--db"}, + required = true, + description = "Database File Path") + private String dbPath; + + @CommandLine.Option(names = {"--column_family", "--column-family", "--cf"}, + required = true, + description = "Column family name") + private String columnFamilyName; + + @Override + public void execute() throws Exception { + List<ColumnFamilyHandle> cfHandleList = new ArrayList<>(); + List<ColumnFamilyDescriptor> cfDescList = RocksDBUtils.getColumnFamilyDescriptors( + dbPath); + + try (ManagedRocksDB db = ManagedRocksDB.open(dbPath, cfDescList, cfHandleList)) { + ColumnFamilyHandle cfh = RocksDBUtils.getColumnFamilyHandle(columnFamilyName, cfHandleList); + if (cfh == null) { + throw new IllegalArgumentException(columnFamilyName + + " is not in a column family in DB for the given path."); + } + + info("Running compaction on " + columnFamilyName); + if (!isDryRun()) { + ManagedCompactRangeOptions compactOptions = new ManagedCompactRangeOptions(); + compactOptions.setBottommostLevelCompaction(ManagedCompactRangeOptions.BottommostLevelCompaction.kForce); + db.get().compactRange(cfh, null, null, compactOptions); + } + info("Compaction completed."); + + } catch (RocksDBException exception) { + error("Failed to compact the RocksDB for the given path: %s, column-family:%s", dbPath, columnFamilyName); + error("Exception: " + exception); Review Comment: Should we just throw an exception with this message instead? The second "Failed to compact RocksDB" message seems redundant, but throwing something is necessary to make the command exit non-zero. Current output is rendered correctly without the stack trace though: ``` $ ./ozone repair ldb compact --db=lkjhlk --column-family=foo ATTENTION: Running as user foo. Make sure this is the same user used to run the Ozone process. Are you sure you want to continue (y/N)? y Run as user: foo Failed to compact the RocksDB for the given path: lkjhlk, column-family:foo Exception: org.rocksdb.RocksDBException: lkjhlk/CURRENT: does not exist (create_if_missing is false) Failed to compact RocksDB. ``` ########## hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/RocksDBManualCompaction.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.repair.ldb; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.apache.hadoop.hdds.cli.HddsVersionProvider; +import org.apache.hadoop.hdds.utils.IOUtils; +import org.apache.hadoop.hdds.utils.db.managed.ManagedCompactRangeOptions; +import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB; +import org.apache.hadoop.ozone.debug.RocksDBUtils; +import org.apache.hadoop.ozone.repair.RepairTool; +import org.rocksdb.ColumnFamilyDescriptor; +import org.rocksdb.ColumnFamilyHandle; +import org.rocksdb.RocksDBException; +import picocli.CommandLine; + +/** + * Tool to perform compaction on a table. + */ +@CommandLine.Command( + name = "compact", + description = "CLI to compact a column-family in the DB. " + + "Note: If om.db is compacted then it will impact efficient snapshot diff.", Review Comment: ```suggestion description = "CLI to compact a column family in the DB while the service is offline." + "Note: If om.db is compacted with this tool then it will negatively impact the Ozone Manager's efficient snapshot diff.", ``` ########## hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/RocksDBManualCompaction.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.repair.ldb; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.apache.hadoop.hdds.cli.HddsVersionProvider; +import org.apache.hadoop.hdds.utils.IOUtils; +import org.apache.hadoop.hdds.utils.db.managed.ManagedCompactRangeOptions; +import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB; +import org.apache.hadoop.ozone.debug.RocksDBUtils; +import org.apache.hadoop.ozone.repair.RepairTool; +import org.rocksdb.ColumnFamilyDescriptor; +import org.rocksdb.ColumnFamilyHandle; +import org.rocksdb.RocksDBException; +import picocli.CommandLine; + +/** + * Tool to perform compaction on a table. + */ +@CommandLine.Command( + name = "compact", + description = "CLI to compact a column-family in the DB. " + + "Note: If om.db is compacted then it will impact efficient snapshot diff.", + mixinStandardHelpOptions = true, + versionProvider = HddsVersionProvider.class +) +public class RocksDBManualCompaction extends RepairTool { + + @CommandLine.Option(names = {"--db"}, + required = true, + description = "Database File Path") + private String dbPath; + + @CommandLine.Option(names = {"--column_family", "--column-family", "--cf"}, + required = true, + description = "Column family name") + private String columnFamilyName; + + @Override + public void execute() throws Exception { + List<ColumnFamilyHandle> cfHandleList = new ArrayList<>(); + List<ColumnFamilyDescriptor> cfDescList = RocksDBUtils.getColumnFamilyDescriptors( + dbPath); + + try (ManagedRocksDB db = ManagedRocksDB.open(dbPath, cfDescList, cfHandleList)) { + ColumnFamilyHandle cfh = RocksDBUtils.getColumnFamilyHandle(columnFamilyName, cfHandleList); + if (cfh == null) { + throw new IllegalArgumentException(columnFamilyName + + " is not in a column family in DB for the given path."); + } + + info("Running compaction on " + columnFamilyName); + if (!isDryRun()) { + ManagedCompactRangeOptions compactOptions = new ManagedCompactRangeOptions(); + compactOptions.setBottommostLevelCompaction(ManagedCompactRangeOptions.BottommostLevelCompaction.kForce); + db.get().compactRange(cfh, null, null, compactOptions); + } + info("Compaction completed."); Review Comment: +1 to Wei-Chiu's suggestion, let's add simple time-elapsed message here. ```suggestion info("Compaction completed in " + time + "ms."); ``` -- 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. To unsubscribe, e-mail: issues-unsubscr...@ozone.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@ozone.apache.org For additional commands, e-mail: issues-h...@ozone.apache.org
