FANNG1 commented on code in PR #10110: URL: https://github.com/apache/gravitino/pull/10110#discussion_r2870926263
########## maintenance/optimizer/src/main/java/org/apache/gravitino/maintenance/optimizer/OptimizerCmd.java: ########## @@ -0,0 +1,784 @@ +/* + * 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.gravitino.maintenance.optimizer; + +import com.google.common.base.Preconditions; +import java.io.BufferedWriter; +import java.io.File; +import java.io.OutputStreamWriter; +import java.io.PrintStream; +import java.io.PrintWriter; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Arrays; +import java.util.Collections; +import java.util.EnumSet; +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.cli.CommandLine; +import org.apache.commons.cli.CommandLineParser; +import org.apache.commons.cli.DefaultParser; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Option; +import org.apache.commons.cli.Options; +import org.apache.commons.cli.ParseException; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.maintenance.optimizer.api.common.MetricSample; +import org.apache.gravitino.maintenance.optimizer.api.common.PartitionPath; +import org.apache.gravitino.maintenance.optimizer.api.monitor.EvaluationResult; +import org.apache.gravitino.maintenance.optimizer.api.monitor.MetricScope; +import org.apache.gravitino.maintenance.optimizer.api.monitor.MetricsProvider; +import org.apache.gravitino.maintenance.optimizer.command.rule.CommandRules; +import org.apache.gravitino.maintenance.optimizer.common.OptimizerEnv; +import org.apache.gravitino.maintenance.optimizer.common.StatisticsInputContent; +import org.apache.gravitino.maintenance.optimizer.common.conf.OptimizerConfig; +import org.apache.gravitino.maintenance.optimizer.common.util.ProviderUtils; +import org.apache.gravitino.maintenance.optimizer.monitor.Monitor; +import org.apache.gravitino.maintenance.optimizer.recommender.Recommender; +import org.apache.gravitino.maintenance.optimizer.recommender.util.PartitionUtils; +import org.apache.gravitino.maintenance.optimizer.updater.UpdateType; +import org.apache.gravitino.maintenance.optimizer.updater.Updater; +import org.apache.gravitino.maintenance.optimizer.updater.calculator.local.LocalStatisticsCalculator; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** CLI entry point for optimizer actions. */ +public class OptimizerCmd { + private static final Logger LOG = LoggerFactory.getLogger(OptimizerCmd.class); + private static final String DEFAULT_CONF_PATH = + Paths.get("conf", "gravitino-optimizer.conf").toString(); + private static final long DEFAULT_RANGE_SECONDS = 24 * 3600L; + private static final long METRICS_LIST_FROM_SECONDS = 0L; + private static final long METRICS_LIST_TO_SECONDS = Long.MAX_VALUE; + private static final Set<CliOption> GLOBAL_OPTION_SPECS = EnumSet.of(CliOption.CONF_PATH); + private static final String DEFAULT_USAGE = + "./bin/gravitino-optimizer.sh --type <command> [options]"; + private static final Map<OptimizerCommandType, CommandOptionSpec> COMMAND_OPTION_SPECS = + Map.of( + OptimizerCommandType.RECOMMEND_STRATEGY_TYPE, + CommandOptionSpec.of( + EnumSet.of(CliOption.IDENTIFIERS, CliOption.STRATEGY_TYPE), + EnumSet.noneOf(CliOption.class), + "./bin/gravitino-optimizer.sh --type recommend-strategy-type --identifiers c.db.t1,c.db.t2 --strategy-type compaction"), + OptimizerCommandType.UPDATE_STATISTICS, + CommandOptionSpec.of( + EnumSet.of(CliOption.CALCULATOR_NAME), + EnumSet.of(CliOption.IDENTIFIERS, CliOption.STATISTICS_PAYLOAD, CliOption.FILE_PATH), + "./bin/gravitino-optimizer.sh --type update-statistics --calculator-name local-stats-calculator --file-path ./table-stats.jsonl", + statisticsInputRules()), + OptimizerCommandType.APPEND_METRICS, + CommandOptionSpec.of( + EnumSet.of(CliOption.CALCULATOR_NAME), + EnumSet.of(CliOption.IDENTIFIERS, CliOption.STATISTICS_PAYLOAD, CliOption.FILE_PATH), + "./bin/gravitino-optimizer.sh --type append-metrics --calculator-name local-stats-calculator --statistics-payload '<jsonl-lines>'", + statisticsInputRules()), + OptimizerCommandType.MONITOR_METRICS, + CommandOptionSpec.of( + EnumSet.of(CliOption.IDENTIFIERS, CliOption.ACTION_TIME), + EnumSet.of(CliOption.RANGE_SECONDS, CliOption.PARTITION_PATH), + "./bin/gravitino-optimizer.sh --type monitor-metrics --identifiers c.db.t --action-time 1735689600"), + OptimizerCommandType.LIST_TABLE_METRICS, + CommandOptionSpec.of( + EnumSet.of(CliOption.IDENTIFIERS), + EnumSet.of(CliOption.PARTITION_PATH), + "./bin/gravitino-optimizer.sh --type list-table-metrics --identifiers c.db.t"), + OptimizerCommandType.LIST_JOB_METRICS, + CommandOptionSpec.of( + EnumSet.of(CliOption.IDENTIFIERS), + EnumSet.noneOf(CliOption.class), + "./bin/gravitino-optimizer.sh --type list-job-metrics --identifiers c.db.job")); + private static final Map<OptimizerCommandType, CommandHandler> COMMAND_HANDLERS = + Map.of( + OptimizerCommandType.RECOMMEND_STRATEGY_TYPE, OptimizerCmd::executeRecommendStrategyType, + OptimizerCommandType.UPDATE_STATISTICS, OptimizerCmd::executeUpdateStatistics, + OptimizerCommandType.APPEND_METRICS, OptimizerCmd::executeAppendMetrics, + OptimizerCommandType.MONITOR_METRICS, OptimizerCmd::executeMonitorMetrics, + OptimizerCommandType.LIST_TABLE_METRICS, OptimizerCmd::executeListTableMetrics, + OptimizerCommandType.LIST_JOB_METRICS, OptimizerCmd::executeListJobMetrics); + private static final String LOCAL_STATS_CALCULATOR_NAME = LocalStatisticsCalculator.NAME; + + static { + validateCommandDefinitions(); + } + + public static void main(String[] args) { + run(args, System.out, System.err); + } + + static void run(String[] args, PrintStream out, PrintStream err) { + Options options = buildOptions(); + + CommandLineParser parser = new DefaultParser(); + CommandLine cmd; + OptimizerCommandType optimizerType = null; + try { + cmd = parser.parse(options, args); + if (cmd.hasOption(CliOption.HELP.longOpt())) { + String helpType = cmd.getOptionValue(CliOption.TYPE.longOpt()); + if (StringUtils.isBlank(helpType)) { + printGlobalHelp(options, out); + } else { + printCommandHelp(OptimizerCommandType.fromString(helpType), out); + } + return; + } + + optimizerType = OptimizerCommandType.fromString(cmd.getOptionValue(CliOption.TYPE.longOpt())); + validateCommandOptions(cmd, optimizerType); + String confPath = cmd.getOptionValue(CliOption.CONF_PATH.longOpt(), DEFAULT_CONF_PATH); + String[] identifiers = cmd.getOptionValues(CliOption.IDENTIFIERS.longOpt()); + String strategyType = cmd.getOptionValue(CliOption.STRATEGY_TYPE.longOpt()); + String calculatorName = cmd.getOptionValue(CliOption.CALCULATOR_NAME.longOpt()); + String actionTime = cmd.getOptionValue(CliOption.ACTION_TIME.longOpt()); + String rangeSeconds = + cmd.getOptionValue( + CliOption.RANGE_SECONDS.longOpt(), Long.toString(DEFAULT_RANGE_SECONDS)); + String partitionPathRaw = cmd.getOptionValue(CliOption.PARTITION_PATH.longOpt()); + String statisticsPayload = cmd.getOptionValue(CliOption.STATISTICS_PAYLOAD.longOpt()); + String filePath = cmd.getOptionValue(CliOption.FILE_PATH.longOpt()); + Optional<StatisticsInputContent> statisticsInputContent = + buildStatisticsInputContent(statisticsPayload, filePath); + CommandContext context = + new CommandContext( + new OptimizerEnv(loadOptimizerConfig(confPath)), + identifiers, + strategyType, + calculatorName, + actionTime, + rangeSeconds, + partitionPathRaw, + statisticsInputContent, + out); + executeCommand(optimizerType, context); + } catch (ParseException e) { + err.println(e.getMessage()); + printGlobalHelp(options, out); + LOG.error("Error parsing command line arguments", e); + } catch (IllegalArgumentException e) { + err.println(e.getMessage()); + if (optimizerType != null) { + printCommandHelp(optimizerType, out); + } else { + printGlobalHelp(options, out); + } + LOG.error("Command validation failed", e); + } catch (Exception e) { + err.println(e.getMessage()); + LOG.error("Error executing optimizer command", e); + } + } + + private static OptimizerConfig loadOptimizerConfig(String confPath) { + OptimizerConfig config = new OptimizerConfig(); + try { + if (StringUtils.isNotBlank(confPath)) { + File confFile = Paths.get(confPath).toFile(); + if (Files.exists(confFile.toPath())) { + config.loadFromProperties(config.loadPropertiesFromFile(confFile)); + return config; + } + } + config.loadFromFile(confPath); + } catch (Exception e) { + throw new IllegalArgumentException("Failed to load optimizer config: " + confPath, e); + } + return config; + } + + private static List<NameIdentifier> parseIdentifiers(String[] identifiers) { + return Arrays.stream(identifiers).map(NameIdentifier::parse).toList(); + } + + private static Optional<StatisticsInputContent> buildStatisticsInputContent( + String statisticsPayload, String filePath) { + boolean hasPayload = StringUtils.isNotBlank(statisticsPayload); + boolean hasFilePath = StringUtils.isNotBlank(filePath); + Preconditions.checkArgument( + !(hasPayload && hasFilePath), + "--statistics-payload and --file-path cannot be used together"); + if (hasPayload) { + return Optional.of(StatisticsInputContent.fromPayload(statisticsPayload)); + } + if (hasFilePath) { + return Optional.of(StatisticsInputContent.fromFilePath(filePath)); + } + return Optional.empty(); + } + + private static OptimizerEnv withStatisticsInput( + OptimizerEnv optimizerEnv, Optional<StatisticsInputContent> statisticsInputContent) { + return statisticsInputContent.map(optimizerEnv::withContent).orElse(optimizerEnv); + } + + private static long parseLongOption(String optionName, String optionValue, boolean allowZero) { + try { + long value = Long.parseLong(optionValue); + Preconditions.checkArgument( + allowZero ? value >= 0 : value > 0, + "Option %s must be %s", + optionName, + allowZero ? ">= 0" : "> 0"); + return value; + } catch (NumberFormatException e) { + throw new IllegalArgumentException( + String.format("Option %s must be a valid integer value.", optionName), e); + } + } + + private static Optional<PartitionPath> parsePartitionPath(String partitionPathStr) { + if (StringUtils.isBlank(partitionPathStr)) { + return Optional.empty(); + } + String trimmed = partitionPathStr.trim(); + Preconditions.checkArgument( + trimmed.startsWith("["), + "--partition-path must be a JSON array, for example: [{\"p1\":\"v1\"},{\"p2\":\"v2\"}]"); + return Optional.of(PartitionUtils.decodePartitionPath(trimmed)); + } + + private static void printEvaluationResult(PrintStream out, EvaluationResult result) { + MetricScope scope = result.scope(); + String partition = + scope.partition().map(PartitionPath::toString).orElse("<table-or-job-scope>"); + out.printf( + "EvaluationResult{scopeType=%s, identifier=%s, partitionPath=%s, evaluation=%s, evaluatorName=%s, actionTimeSeconds=%d, rangeSeconds=%d, beforeMetrics=%s, afterMetrics=%s}%n", + scope.type(), + scope.identifier(), + partition, + result.evaluation(), + result.evaluatorName(), + result.actionTimeSeconds(), + result.rangeSeconds(), + result.beforeMetrics(), + result.afterMetrics()); + } + + private static void printMetricsResult( + PrintStream out, + MetricScope.Type scopeType, + NameIdentifier identifier, + Optional<PartitionPath> partitionPath, + Map<String, List<MetricSample>> metrics) { + String partition = partitionPath.map(PartitionPath::toString).orElse("<table-or-job-scope>"); + out.printf( + "MetricsResult{scopeType=%s, identifier=%s, partitionPath=%s, metrics=%s}%n", + scopeType, identifier, partition, formatMetrics(metrics)); + } + + private static String formatMetrics(Map<String, List<MetricSample>> metrics) { + if (metrics == null || metrics.isEmpty()) { + return "{}"; + } + return metrics.entrySet().stream() + .sorted(Map.Entry.comparingByKey()) + .map( + entry -> + entry.getKey() + + "=" + + formatMetricSamples(entry.getValue() == null ? List.of() : entry.getValue())) + .collect(Collectors.joining(", ", "{", "}")); + } + + private static String formatMetricSamples(List<MetricSample> samples) { + if (samples.isEmpty()) { + return "[]"; + } + return samples.stream() + .sorted(java.util.Comparator.comparingLong(MetricSample::timestamp)) + .map( + sample -> + String.format( + "{timestamp=%d, value=%s}", + sample.timestamp(), String.valueOf(sample.statistic().value().value()))) + .collect(Collectors.joining(", ", "[", "]")); + } + + private static void validateCommandOptions(CommandLine cmd, OptimizerCommandType optimizerType) { + CommandOptionSpec spec = COMMAND_OPTION_SPECS.get(optimizerType); + Preconditions.checkArgument(spec != null, "Missing command option spec for %s", optimizerType); + + List<CliOption> missingRequiredOptions = + spec.requiredOptions().stream() + .filter(option -> !CommandRules.hasEffectiveValue(cmd, option.longOpt())) + .toList(); + Preconditions.checkArgument( + missingRequiredOptions.isEmpty(), + "Missing required options for command '%s': %s. Optional: %s", + optimizerType.toCliType(), + joinOptions(missingRequiredOptions), + joinOptions(spec.optionalOptions())); + + Set<String> allowedOptions = + java.util.stream.Stream.concat( + java.util.stream.Stream.concat( + GLOBAL_OPTION_SPECS.stream(), spec.requiredOptions().stream()), + spec.optionalOptions().stream()) + .map(CliOption::longOpt) + .collect(Collectors.toSet()); + allowedOptions.add(CliOption.TYPE.longOpt()); + + List<String> unsupportedOptions = + Arrays.stream(cmd.getOptions()) + .map(org.apache.commons.cli.Option::getLongOpt) Review Comment: updated -- 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]
