-
Notifications
You must be signed in to change notification settings - Fork 3.4k
HBASE-26147: Add dry_run_balancer and related Admin interfaces for running the balancer without executing any region moves #3536
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
bbeaudreault
wants to merge
3
commits into
apache:branch-2
from
bbeaudreault:dry_run_balancer_upstream
Closed
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
96 changes: 96 additions & 0 deletions
96
hbase-client/src/main/java/org/apache/hadoop/hbase/client/BalanceRequest.java
This file contains hidden or 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,96 @@ | ||
| /* | ||
| * | ||
| * 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.hbase.client; | ||
|
|
||
| import org.apache.yetus.audience.InterfaceAudience; | ||
| import org.apache.yetus.audience.InterfaceStability; | ||
|
|
||
| /** | ||
| * Encapsulates options for executing a run of the Balancer. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public final class BalanceRequest { | ||
| private static final BalanceRequest DEFAULT = BalanceRequest.newBuilder().build(); | ||
|
|
||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public final static class Builder { | ||
bbeaudreault marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private boolean dryRun = false; | ||
| private boolean ignoreRegionsInTransition = false; | ||
|
|
||
| private Builder() {} | ||
|
|
||
| /** | ||
| * Creates a BalancerRequest which runs the balancer in dryRun mode. | ||
| * In this mode, the balancer will try to find a plan but WILL NOT | ||
| * execute any region moves or call any coprocessors. | ||
| * | ||
| * You can run in dryRun mode regardless of whether the balancer switch | ||
| * is enabled or disabled, but dryRun mode will not run over an existing | ||
| * request or chore. | ||
| * | ||
| * Dry run is useful for testing out new balance configs. See the logs | ||
| * on the active HMaster for the results of the dry run. | ||
| */ | ||
| public Builder setDryRun(boolean dryRun) { | ||
| this.dryRun = dryRun; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a BalancerRequest to cause the balancer to run even if there | ||
| * are regions in transition. | ||
| * | ||
| * WARNING: Advanced usage only, this could cause more issues than it fixes. | ||
| */ | ||
| public Builder setIgnoreRegionsInTransition(boolean ignoreRegionsInTransition) { | ||
| this.ignoreRegionsInTransition = ignoreRegionsInTransition; | ||
| return this; | ||
| } | ||
|
|
||
| public BalanceRequest build() { | ||
| return new BalanceRequest(dryRun, ignoreRegionsInTransition); | ||
| } | ||
| } | ||
|
|
||
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| public static BalanceRequest defaultInstance() { | ||
| return DEFAULT; | ||
| } | ||
|
|
||
| private final boolean dryRun; | ||
| private final boolean ignoreRegionsInTransition; | ||
|
|
||
| private BalanceRequest(boolean dryRun, boolean ignoreRegionsInTransition) { | ||
| this.dryRun = dryRun; | ||
| this.ignoreRegionsInTransition = ignoreRegionsInTransition; | ||
| } | ||
|
|
||
| public boolean isDryRun() { | ||
| return dryRun; | ||
| } | ||
|
|
||
| public boolean isIgnoreRegionsInTransition() { | ||
| return ignoreRegionsInTransition; | ||
| } | ||
| } | ||
100 changes: 100 additions & 0 deletions
100
hbase-client/src/main/java/org/apache/hadoop/hbase/client/BalanceResponse.java
This file contains hidden or 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,100 @@ | ||
| /* | ||
| * | ||
| * 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.hbase.client; | ||
|
|
||
| import org.apache.yetus.audience.InterfaceAudience; | ||
| import org.apache.yetus.audience.InterfaceStability; | ||
|
|
||
| /** | ||
| * Response returned from a balancer invocation | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public final class BalanceResponse { | ||
|
|
||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public final static class Builder { | ||
bbeaudreault marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private boolean balancerRan; | ||
| private int movesCalculated; | ||
| private int movesExecuted; | ||
|
|
||
| private Builder() {} | ||
|
|
||
| public Builder setBalancerRan(boolean balancerRan) { | ||
| this.balancerRan = balancerRan; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setMovesCalculated(int movesCalculated) { | ||
| this.movesCalculated = movesCalculated; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setMovesExecuted(int movesExecuted) { | ||
| this.movesExecuted = movesExecuted; | ||
| return this; | ||
| } | ||
|
|
||
| public BalanceResponse build() { | ||
| return new BalanceResponse(balancerRan, movesCalculated, movesExecuted); | ||
| } | ||
| } | ||
|
|
||
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| private final boolean balancerRan; | ||
| private final int movesCalculated; | ||
| private final int movesExecuted; | ||
|
|
||
| private BalanceResponse(boolean balancerRan, int movesCalculated, int movesExecuted) { | ||
| this.balancerRan = balancerRan; | ||
| this.movesCalculated = movesCalculated; | ||
| this.movesExecuted = movesExecuted; | ||
| } | ||
|
|
||
| /** | ||
| * Determines whether the balancer ran or not. The balancer may not run for a variety of reasons, | ||
bbeaudreault marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * such as: another balance is running, there are regions in transition, the cluster is in | ||
| * maintenance mode, etc. | ||
| */ | ||
| public boolean isBalancerRan() { | ||
| return balancerRan; | ||
| } | ||
|
|
||
| /** | ||
| * The number of moves calculated by the balancer if it ran. This may be zero if | ||
| * no better balance could be found. | ||
| */ | ||
| public int getMovesCalculated() { | ||
| return movesCalculated; | ||
| } | ||
|
|
||
| /** | ||
| * The number of moves actually executed by the balancer if it ran. This will be | ||
bbeaudreault marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * zero if {@link #getMovesCalculated()} is zero or if {@link BalanceRequest#isDryRun()} | ||
| * was true. It may also not be equal to {@link #getMovesCalculated()} if the balancer | ||
| * was interrupted midway through executing the moves due to max run time. | ||
| */ | ||
| public int getMovesExecuted() { | ||
| return movesExecuted; | ||
| } | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.