forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CLI] Add a broker tool for operations of a specific broker (apache#5768
) *Motivation* Add a tool to collect load report on a specific broker. This is used for troubleshooting problems in a production cluster. *Modifications* Add a broker tool for operations of a specific broker.
- Loading branch information
Showing
9 changed files
with
252 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
pulsar-broker/src/main/java/org/apache/pulsar/broker/tools/BrokerTool.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /** | ||
| * 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.pulsar.broker.tools; | ||
|
|
||
| import org.apache.bookkeeper.tools.framework.Cli; | ||
| import org.apache.bookkeeper.tools.framework.CliFlags; | ||
| import org.apache.bookkeeper.tools.framework.CliSpec; | ||
|
|
||
| /** | ||
| * <b>broker-tool</b> is used for operations on a specific broker. | ||
| */ | ||
| public class BrokerTool { | ||
|
|
||
| public static final String NAME = "broker-tool"; | ||
|
|
||
| public static void main(String[] args) { | ||
| CliSpec.Builder<CliFlags> specBuilder = CliSpec.newBuilder() | ||
| .withName(NAME) | ||
| .withUsage(NAME + " [flags] [commands]") | ||
| .withDescription(NAME + " is used for operations on a specific broker") | ||
| .withFlags(new CliFlags()) | ||
| .withConsole(System.out) | ||
| .addCommand(new LoadReportCommand()); | ||
|
|
||
| CliSpec<CliFlags> spec = specBuilder.build(); | ||
|
|
||
| int retCode = Cli.runCli(spec, args); | ||
| Runtime.getRuntime().exit(retCode); | ||
| } | ||
|
|
||
| } |
127 changes: 127 additions & 0 deletions
127
pulsar-broker/src/main/java/org/apache/pulsar/broker/tools/LoadReportCommand.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /** | ||
| * 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.pulsar.broker.tools; | ||
|
|
||
| import com.beust.jcommander.Parameter; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
| import java.util.concurrent.TimeUnit; | ||
| import org.apache.bookkeeper.tools.framework.Cli; | ||
| import org.apache.bookkeeper.tools.framework.CliCommand; | ||
| import org.apache.bookkeeper.tools.framework.CliFlags; | ||
| import org.apache.bookkeeper.tools.framework.CliSpec; | ||
| import org.apache.commons.lang3.SystemUtils; | ||
| import org.apache.pulsar.broker.loadbalance.BrokerHostUsage; | ||
| import org.apache.pulsar.broker.loadbalance.impl.GenericBrokerHostUsageImpl; | ||
| import org.apache.pulsar.broker.loadbalance.impl.LinuxBrokerHostUsageImpl; | ||
| import org.apache.pulsar.broker.tools.LoadReportCommand.Flags; | ||
| import org.apache.pulsar.policies.data.loadbalancer.ResourceUsage; | ||
| import org.apache.pulsar.policies.data.loadbalancer.SystemResourceUsage; | ||
|
|
||
| /** | ||
| * The command to collect the load report of a specific broker. | ||
| */ | ||
| public class LoadReportCommand extends CliCommand<CliFlags, Flags> { | ||
|
|
||
| private static final String NAME = "load-report"; | ||
| private static final String DESC = "Collect the load report of a specific broker"; | ||
|
|
||
| /** | ||
| * The CLI flags of load report command. | ||
| */ | ||
| public static class Flags extends CliFlags { | ||
|
|
||
| @Parameter( | ||
| names = { | ||
| "-i", "--interval-ms" | ||
| }, | ||
| description = "Interval to collect load report, in milliseconds" | ||
| ) | ||
| public int intervalMilliseconds = 100; | ||
|
|
||
| } | ||
|
|
||
| public LoadReportCommand() { | ||
| super(CliSpec.<Flags>newBuilder() | ||
| .withName(NAME) | ||
| .withDescription(DESC) | ||
| .withFlags(new Flags()) | ||
| .build()); | ||
| } | ||
|
|
||
| @Override | ||
| public Boolean apply(CliFlags globalFlags, String[] args) { | ||
| CliSpec<Flags> newSpec = CliSpec.newBuilder(spec) | ||
| .withRunFunc(cmdFlags -> apply(cmdFlags)) | ||
| .build(); | ||
| return 0 == Cli.runCli(newSpec, args); | ||
| } | ||
|
|
||
| private boolean apply(Flags flags) { | ||
|
|
||
| boolean isLinux = SystemUtils.IS_OS_LINUX; | ||
| spec.console().println("OS ARCH: " + SystemUtils.OS_ARCH); | ||
| spec.console().println("OS NAME: " + SystemUtils.OS_NAME); | ||
| spec.console().println("OS VERSION: " + SystemUtils.OS_VERSION); | ||
| spec.console().println("Linux: " + isLinux); | ||
| spec.console().println("--------------------------------------"); | ||
| spec.console().println(); | ||
| spec.console().println("Load Report Interval : " + flags.intervalMilliseconds + " ms"); | ||
| spec.console().println(); | ||
| spec.console().println("--------------------------------------"); | ||
| spec.console().println(); | ||
|
|
||
| ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); | ||
| BrokerHostUsage hostUsage; | ||
| try { | ||
| if (isLinux) { | ||
| hostUsage = new LinuxBrokerHostUsageImpl( | ||
| Integer.MAX_VALUE, Optional.empty(), scheduler | ||
| ); | ||
| } else { | ||
| hostUsage = new GenericBrokerHostUsageImpl( | ||
| Integer.MAX_VALUE, scheduler | ||
| ); | ||
| } | ||
|
|
||
| hostUsage.calculateBrokerHostUsage(); | ||
| try { | ||
| TimeUnit.MILLISECONDS.sleep(flags.intervalMilliseconds); | ||
| } catch (InterruptedException e) { | ||
| } | ||
| hostUsage.calculateBrokerHostUsage(); | ||
| SystemResourceUsage usage = hostUsage.getBrokerHostUsage(); | ||
|
|
||
| printResourceUsage("CPU", usage.cpu); | ||
| printResourceUsage("Memory", usage.memory); | ||
| printResourceUsage("Direct Memory", usage.directMemory); | ||
| printResourceUsage("Bandwidth In", usage.bandwidthIn); | ||
| printResourceUsage("Bandwidth Out", usage.bandwidthOut); | ||
|
|
||
| return true; | ||
| } finally { | ||
| scheduler.shutdown(); | ||
| } | ||
| } | ||
|
|
||
| private void printResourceUsage(String name, ResourceUsage usage) { | ||
| spec.console().println(name + " : usage = " + usage.usage + ", limit = " + usage.limit); | ||
| } | ||
| } |
Oops, something went wrong.