sravani-revuri commented on code in PR #11342: URL: https://github.com/apache/ozone/pull/11342#discussion_r4130138738
########## hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/hdds/scm/cli/ContainerBalancerRecommendSubcommand.java: ########## @@ -0,0 +1,228 @@ +/* + * 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.cli; + +import static org.apache.hadoop.util.StringUtils.byteDesc; + +import java.io.IOException; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.commons.lang3.StringUtils; +import org.apache.hadoop.hdds.cli.HddsVersionProvider; +import org.apache.hadoop.hdds.conf.OzoneConfiguration; +import org.apache.hadoop.hdds.protocol.proto.HddsProtos.DatanodeUsageInfoProto; +import org.apache.hadoop.hdds.scm.client.ScmClient; +import org.apache.hadoop.hdds.scm.container.balancer.ContainerBalancerAdvisor; +import org.apache.hadoop.hdds.scm.container.balancer.ContainerBalancerEstimation; +import org.apache.hadoop.hdds.scm.container.balancer.ContainerBalancerProfile; +import org.apache.hadoop.hdds.scm.container.balancer.ContainerBalancerRecommendation; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + +/** + * Recommends container balancer configuration for SLOW, MEDIUM, and FAST profiles + * without starting the balancer. + */ +@Command( + name = "recommend", + description = "Recommend container balancer configuration based on current cluster imbalance. " + + "When --profile is omitted, SLOW, MEDIUM, and FAST are recommended. Does not start the balancer.", + mixinStandardHelpOptions = true, + versionProvider = HddsVersionProvider.class) +public class ContainerBalancerRecommendSubcommand extends ScmSubcommand { + + private static final double PLANNING_ITERATION_BUFFER = 1.3d; + private static final int PARAM_COLUMN_WIDTH = 42; + private static final int VALUE_COLUMN_WIDTH = 14; + + @Option(names = {"-t", "--threshold"}, + description = "Percentage deviation from average utilization of " + + "the cluster after which a datanode will be rebalanced. The value " + + "should be in the range [0.0, 100.0), with a default of 10 " + + "(specify '10' for 10%%).") + private Optional<Double> threshold; + + @Option(names = {"--include-datanodes"}, + description = "A list of Datanode hostnames or ip addresses separated by commas. Only the " + + "Datanodes specified in this list are balanced.") + private Optional<String> includeNodes; + + @Option(names = {"--exclude-datanodes"}, + description = "A list of Datanode hostnames or ip addresses separated by commas. The " + + "Datanodes specified in this list are excluded from balancing.") + private Optional<String> excludeNodes; + + @Option(names = {"--profile"}, + description = "Throttling profile: SLOW, MEDIUM, or FAST. When set, only this profile is " + + "recommended. When omitted, SLOW, MEDIUM, and FAST are recommended.") + private Optional<String> profileName; + + @Override + public void execute(ScmClient scmClient) throws IOException { + List<DatanodeUsageInfoProto> nodes = scmClient.getDatanodeUsageInfo(true, Integer.MAX_VALUE); + if (nodes == null || nodes.isEmpty()) { + throw new IOException("No datanode usage information available from SCM."); + } + + OzoneConfiguration conf = getOzoneConf(); + ContainerBalancerAdvisor.AdvisorRequest request = buildRequest(nodes); + List<ContainerBalancerRecommendation> recommendations; + try { + recommendations = ContainerBalancerAdvisor.recommend(conf, request); + } catch (IllegalArgumentException e) { + throw new IOException(e.getMessage(), e); + } + + boolean anySucceeded = false; + for (ContainerBalancerRecommendation recommendation : recommendations) { + printRecommendation(recommendation); + if (recommendation.succeeded()) { + anySucceeded = true; + } + } + if (!anySucceeded) { + throw new IOException(recommendations.get(0).getFailureMessage()); + } + } + + private ContainerBalancerAdvisor.AdvisorRequest buildRequest(List<DatanodeUsageInfoProto> nodes) + throws IOException { + ContainerBalancerAdvisor.AdvisorRequest request = + new ContainerBalancerAdvisor.AdvisorRequest().setNodes(nodes); + threshold.ifPresent(request::setThresholdPercent); + includeNodes.ifPresent(value -> request.setIncludeNodes(parseNodeSet(value))); + excludeNodes.ifPresent(value -> request.setExcludeNodes(parseNodeSet(value))); + if (profileName.isPresent()) { + request.setProfile(parseProfile(profileName.get())); + } + return request; + } + + private static ContainerBalancerProfile parseProfile(String name) throws IOException { + try { + return ContainerBalancerProfile.valueOf(name.trim().toUpperCase(Locale.ENGLISH)); + } catch (IllegalArgumentException e) { + throw new IOException("Invalid profile: " + name + ". Expected SLOW, MEDIUM, or FAST."); + } + } + + private void printRecommendation(ContainerBalancerRecommendation recommendation) { + out().printf("RECOMMENDED CONFIGURATION (profile: %s)%n", recommendation.getProfile().name()); + out().println(); + + if (!recommendation.succeeded()) { + out().printf("Recommendation failed: %s%n%n", recommendation.getFailureMessage()); + return; + } + + printRecommendedParameters(recommendation); + out().println(); + out().println(" Estimation:"); + printEstimation(recommendation.getEstimation()); + } + + private void printRecommendedParameters(ContainerBalancerRecommendation recommendation) { + Map<String, String> rationale = recommendation.getRationale(); + long moveTimeoutMinutes = Math.round(recommendation.getMoveTimeoutMillis() / 60000d); + long moveReplicationTimeoutMinutes = + Math.round(recommendation.getMoveReplicationTimeoutMillis() / 60000d); + long balancingIntervalMinutes = Math.round(recommendation.getBalancingIntervalMillis() / 60000d); + + out().println(" Recommended parameters:"); + printParameterRow("Parameter", "Value", "Rationale"); + printParameterRow("--threshold", + String.format(Locale.ENGLISH, "%.1f%%", recommendation.getThresholdPercent()), + rationale.get("threshold")); + printParameterRow("--max-datanodes-percentage-to-involve", + String.format(Locale.ENGLISH, "%d%%", recommendation.getMaxDatanodesPercentage()), + rationale.get("maxDatanodesPercentage")); + printParameterRow("--max-size-to-move-per-iteration-in-gb", + byteDesc(recommendation.getMaxSizeToMovePerIteration()), + rationale.get("maxSizeToMovePerIteration")); + printParameterRow("--max-size-entering-target-in-gb", + byteDesc(recommendation.getMaxSizeEnteringTarget()) + " / node", + rationale.get("maxSizeEnteringTarget")); + printParameterRow("--max-size-leaving-source-in-gb", + byteDesc(recommendation.getMaxSizeLeavingSource()) + " / node", + rationale.get("maxSizeLeavingSource")); + printParameterRow("--move-timeout-minutes", + String.format(Locale.ENGLISH, "%d min", moveTimeoutMinutes), + rationale.get("moveTimeout")); + printParameterRow("--move-replication-timeout-minutes", + String.format(Locale.ENGLISH, "%d min", moveReplicationTimeoutMinutes), + rationale.get("moveReplicationTimeout")); + printParameterRow("--balancing-iteration-interval-minutes", + String.format(Locale.ENGLISH, "%d min", balancingIntervalMinutes), + rationale.get("balancingInterval")); + printParameterRow("--iterations", + String.valueOf(recommendation.getRecommendedIterations()), + rationale.get("iterations")); + } + + private void printParameterRow(String parameter, String value, String rationaleText) { + String rationale = rationaleText == null ? "" : rationaleText; + out().printf(Locale.ENGLISH, " %-" + PARAM_COLUMN_WIDTH + "s %-" + VALUE_COLUMN_WIDTH + "s %s%n", + parameter, value, rationale); + } + + private void printEstimation(ContainerBalancerEstimation estimation) { Review Comment: > What is the difference between container balancer recommend and estimate commands? recommend also prints estimate output. - for estimate command you can choose the settings (profiles, -s, -d, timeouts, etc.). It shows how much would move and how long it might take for that scenario using the values user passed. - the recommend command suggests these configs for you and also shows the estimated duration of these configs per profile. without the estimation in the same place, the user would have to take note of all these configs and pass them again to the estimate command -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
