npawar commented on a change in pull request #5266: URL: https://github.com/apache/incubator-pinot/pull/5266#discussion_r421119352
########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/service/api/resources/PinotServiceManagerInstanceResource.java ########## @@ -0,0 +1,241 @@ +/** + * 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.pinot.tools.service.api.resources; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.ApiResponse; +import io.swagger.annotations.ApiResponses; +import java.io.IOException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.commons.configuration.Configuration; +import org.apache.commons.configuration.PropertiesConfiguration; +import org.apache.pinot.common.utils.CommonConstants; +import org.apache.pinot.common.utils.NetUtil; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.spi.services.ServiceRole; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.tools.service.PinotServiceManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.pinot.common.utils.CommonConstants.Controller.CONFIG_OF_CONTROLLER_METRICS_PREFIX; Review comment: remove static imports? ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/StartServiceManagerCommand.java ########## @@ -0,0 +1,213 @@ +/** + * 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.pinot.tools.admin.command; + +import java.io.File; +import java.net.SocketException; +import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.apache.commons.configuration.Configuration; +import org.apache.pinot.common.utils.CommonConstants; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.spi.services.ServiceRole; +import org.apache.pinot.tools.Command; +import org.apache.pinot.tools.service.PinotServiceManager; +import org.apache.pinot.tools.utils.PinotConfigUtils; +import org.kohsuke.args4j.Option; +import org.kohsuke.args4j.spi.StringArrayOptionHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.pinot.common.utils.CommonConstants.Helix.PINOT_SERVICE_ROLE; + + +/** + * Class to implement StartPinotService command. + * + */ +public class StartServiceManagerCommand extends AbstractBaseAdminCommand implements Command { Review comment: Could you add an example in the description of how to run this command 1. When providing multiple bootstrapConfigPath 2. When starting multiple roles with default configs Or if there's any documentation, having the link here also works ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/StartServiceManagerCommand.java ########## @@ -0,0 +1,213 @@ +/** + * 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.pinot.tools.admin.command; + +import java.io.File; +import java.net.SocketException; +import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.apache.commons.configuration.Configuration; +import org.apache.pinot.common.utils.CommonConstants; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.spi.services.ServiceRole; +import org.apache.pinot.tools.Command; +import org.apache.pinot.tools.service.PinotServiceManager; +import org.apache.pinot.tools.utils.PinotConfigUtils; +import org.kohsuke.args4j.Option; +import org.kohsuke.args4j.spi.StringArrayOptionHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.pinot.common.utils.CommonConstants.Helix.PINOT_SERVICE_ROLE; + + +/** + * Class to implement StartPinotService command. + * + */ +public class StartServiceManagerCommand extends AbstractBaseAdminCommand implements Command { + private static final Logger LOGGER = LoggerFactory.getLogger(StartServiceManagerCommand.class); + private final List<Configuration> _bootstrapConfigurations = new ArrayList<>(); + private final String[] BOOTSTRAP_SERVICES = new String[]{"CONTROLLER", "BROKER", "SERVER"}; + + @Option(name = "-help", required = false, help = true, aliases = {"-h", "--h", "--help"}, usage = "Print this message.") + private boolean _help; + @Option(name = "-zkAddress", required = true, metaVar = "<http>", usage = "Http address of Zookeeper.") + private String _zkAddress = DEFAULT_ZK_ADDRESS; + @Option(name = "-clusterName", required = true, metaVar = "<String>", usage = "Pinot cluster name.") + private String _clusterName = DEFAULT_CLUSTER_NAME; + @Option(name = "-port", required = true, metaVar = "<int>", usage = "Pinot service manager admin port, -1 means disable, 0 means a random available port.") + private int _port; + @Option(name = "-bootstrapConfigPaths", handler = StringArrayOptionHandler.class, required = false, usage = "A list of Pinot service config file paths. Each config file requires an extra config: 'pinot.service.role' to indicate which service to start.", forbids = {"-bootstrapServices"}) + private String[] _bootstrapConfigPaths; + @Option(name = "-bootstrapServices", handler = StringArrayOptionHandler.class, required = false, usage = "A list of Pinot service roles to start with default config. E.g. CONTROLLER/BROKER/SERVER", forbids = {"-bootstrapConfigPaths"}) + private String[] _bootstrapServices = BOOTSTRAP_SERVICES; + + private PinotServiceManager _pinotServiceManager; + + public String getZkAddress() { + return _zkAddress; + } + + public StartServiceManagerCommand setZkAddress(String zkAddress) { + _zkAddress = zkAddress; + return this; + } + + public String getClusterName() { + return _clusterName; + } + + public StartServiceManagerCommand setClusterName(String clusterName) { + _clusterName = clusterName; + return this; + } + + public int getPort() { + return _port; + } + + public StartServiceManagerCommand setPort(int port) { + _port = port; + return this; + } + + public String[] getBootstrapConfigPaths() { + return _bootstrapConfigPaths; + } + + public StartServiceManagerCommand setBootstrapConfigPaths(String[] bootstrapConfigPaths) { + _bootstrapConfigPaths = bootstrapConfigPaths; + return this; + } + + public String[] getBootstrapServices() { + return _bootstrapServices; + } + + public StartServiceManagerCommand setBootstrapServices(String[] bootstrapServices) { + _bootstrapServices = bootstrapServices; + return this; + } + + @Override + public boolean getHelp() { + return _help; + } + + public void setHelp(boolean help) { + _help = help; + } + + @Override + public String getName() { + return "StartPinotService"; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder() + .append("StartServiceManager -clusterName " + _clusterName + " -zkAddress " + _zkAddress + " -port " + _port); + if (_bootstrapConfigPaths != null) { + sb.append(" -bootstrapConfigPaths " + Arrays.toString(_bootstrapConfigPaths)); + } else if (_bootstrapServices != null) { + sb.append(" -bootstrapServices " + Arrays.toString(_bootstrapServices)); + } + + return sb.toString(); + } + + @Override + public void cleanup() { + } + + @Override + public String description() { + return "Start the Pinot Service Process at the specified port."; Review comment: this description is not very clear. "Starts the PinotServiceManager..." ? ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/service/PinotServiceManagerAdminApiApplication.java ########## @@ -0,0 +1,89 @@ +/** + * 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.pinot.tools.service; + +import com.google.common.base.Preconditions; +import io.swagger.jaxrs.config.BeanConfig; +import java.net.URI; +import java.net.URL; +import java.net.URLClassLoader; +import org.glassfish.grizzly.http.server.CLStaticHttpHandler; +import org.glassfish.grizzly.http.server.HttpHandler; +import org.glassfish.grizzly.http.server.HttpServer; +import org.glassfish.hk2.utilities.binding.AbstractBinder; +import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory; +import org.glassfish.jersey.jackson.JacksonFeature; +import org.glassfish.jersey.server.ResourceConfig; + + Review comment: Some javadoc? ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/EnumArrayOptionHandler.java ########## @@ -0,0 +1,67 @@ +/** + * 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.pinot.tools.admin.command; + +import org.kohsuke.args4j.CmdLineException; +import org.kohsuke.args4j.CmdLineParser; +import org.kohsuke.args4j.OptionDef; +import org.kohsuke.args4j.spi.OptionHandler; +import org.kohsuke.args4j.spi.Parameters; +import org.kohsuke.args4j.spi.Setter; + + +public class EnumArrayOptionHandler<T extends Enum<T>> extends OptionHandler<T> { + + public EnumArrayOptionHandler(CmdLineParser parser, OptionDef option, Setter<T> setter) { + super(parser, option, setter); + } + + /** + * Returns {@code "T[]"}. + * + * @return return "T[]"; + */ + @Override + public String getDefaultMetaVariable() { + return setter.getType().getName() + "[]"; + } + + /** + * Tries to parse {@code String[]} argument from {@link Parameters}. + */ + @Override + public int parseArguments(Parameters params) + throws CmdLineException { + int counter = 0; + for (; counter < params.size(); counter++) { + String param = params.getParameter(counter); + + if (param.startsWith("-")) { + break; + } + + for (String p : param.split(" ")) { + Class<T> t = (Class<T>) setter.getType(); + setter.addValue(Enum.valueOf(t, p)); + } + } + + return counter; + } +} Review comment: new line ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/EnumArrayOptionHandler.java ########## @@ -0,0 +1,67 @@ +/** + * 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.pinot.tools.admin.command; + +import org.kohsuke.args4j.CmdLineException; +import org.kohsuke.args4j.CmdLineParser; +import org.kohsuke.args4j.OptionDef; +import org.kohsuke.args4j.spi.OptionHandler; +import org.kohsuke.args4j.spi.Parameters; +import org.kohsuke.args4j.spi.Setter; + + +public class EnumArrayOptionHandler<T extends Enum<T>> extends OptionHandler<T> { Review comment: Some javadoc for this? Also, where is it used? ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/service/api/resources/PinotServiceManagerInstanceResource.java ########## @@ -0,0 +1,241 @@ +/** + * 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.pinot.tools.service.api.resources; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.ApiResponse; +import io.swagger.annotations.ApiResponses; +import java.io.IOException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.inject.Inject; +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.commons.configuration.Configuration; +import org.apache.commons.configuration.PropertiesConfiguration; +import org.apache.pinot.common.utils.CommonConstants; +import org.apache.pinot.common.utils.NetUtil; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.spi.services.ServiceRole; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.tools.service.PinotServiceManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.pinot.common.utils.CommonConstants.Controller.CONFIG_OF_CONTROLLER_METRICS_PREFIX; +import static org.apache.pinot.common.utils.CommonConstants.Controller.DEFAULT_METRICS_PREFIX; +import static org.apache.pinot.tools.utils.PinotConfigUtils.TMP_DIR; +import static org.apache.pinot.tools.utils.PinotConfigUtils.getAvailablePort; + + +@Api(tags = "Startable") +@Path("/") +public class PinotServiceManagerInstanceResource { + + private static final Logger LOGGER = LoggerFactory.getLogger(PinotServiceManagerInstanceResource.class); + + @Inject + private PinotServiceManager _pinotServiceManager; + + @GET + @Produces(MediaType.APPLICATION_JSON) + @Path("/instances") + @ApiOperation(value = "Get Pinot Instances Status") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Instance Status"), @ApiResponse(code = 500, message = "Internal server error")}) + public Map<String, PinotInstanceStatus> getPinotAllInstancesStatus() { + Map<String, PinotInstanceStatus> results = new HashMap<>(); + for (String instanceId : _pinotServiceManager.getRunningInstanceIds()) { + results.put(instanceId, _pinotServiceManager.getInstanceStatus(instanceId)); + } + return results; + } + + @GET + @Produces(MediaType.APPLICATION_JSON) + @Path("/instances/{instanceName}") + @ApiOperation(value = "Get Pinot Instance Status") + @ApiResponses(value = {@ApiResponse(code = 200, message = "Instance Status"), @ApiResponse(code = 404, message = "Instance Not Found"), @ApiResponse(code = 500, message = "Internal server error")}) + public PinotInstanceStatus getPinotInstanceStatus( + @ApiParam(value = "Name of the instance") @PathParam("instanceName") String instanceName) { + List<String> instanceIds = _pinotServiceManager.getRunningInstanceIds(); + if (instanceIds.contains(instanceName)) { + return _pinotServiceManager.getInstanceStatus(instanceName); + } + throw new WebApplicationException(String.format("Instance [%s] not found.", instanceName), + Response.Status.NOT_FOUND); + } + + @DELETE Review comment: is it possible to add "stopAllServers" "stopAllBrokers" etc, and "stopAll" ########## File path: pinot-tools/src/main/java/org/apache/pinot/tools/admin/command/StartServiceManagerCommand.java ########## @@ -0,0 +1,213 @@ +/** + * 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.pinot.tools.admin.command; + +import java.io.File; +import java.net.SocketException; +import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.apache.commons.configuration.Configuration; +import org.apache.pinot.common.utils.CommonConstants; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.spi.services.ServiceRole; +import org.apache.pinot.tools.Command; +import org.apache.pinot.tools.service.PinotServiceManager; +import org.apache.pinot.tools.utils.PinotConfigUtils; +import org.kohsuke.args4j.Option; +import org.kohsuke.args4j.spi.StringArrayOptionHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.apache.pinot.common.utils.CommonConstants.Helix.PINOT_SERVICE_ROLE; + + +/** + * Class to implement StartPinotService command. + * + */ +public class StartServiceManagerCommand extends AbstractBaseAdminCommand implements Command { + private static final Logger LOGGER = LoggerFactory.getLogger(StartServiceManagerCommand.class); + private final List<Configuration> _bootstrapConfigurations = new ArrayList<>(); + private final String[] BOOTSTRAP_SERVICES = new String[]{"CONTROLLER", "BROKER", "SERVER"}; + + @Option(name = "-help", required = false, help = true, aliases = {"-h", "--h", "--help"}, usage = "Print this message.") + private boolean _help; + @Option(name = "-zkAddress", required = true, metaVar = "<http>", usage = "Http address of Zookeeper.") + private String _zkAddress = DEFAULT_ZK_ADDRESS; + @Option(name = "-clusterName", required = true, metaVar = "<String>", usage = "Pinot cluster name.") + private String _clusterName = DEFAULT_CLUSTER_NAME; + @Option(name = "-port", required = true, metaVar = "<int>", usage = "Pinot service manager admin port, -1 means disable, 0 means a random available port.") Review comment: I couldn't find the logic which handles port=-1. I see port being set as -1 in StartControllerCommnad, StartBrokerCommand etc. But in PinotServiceManager I didn't find any special handling for it? ---------------------------------------------------------------- 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: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
