org.apache.hadoop.hbase.master

Interface LoadBalancer

All Superinterfaces:

org.apache.hadoop.conf.Configurable, ConfigurationObserver, Stoppable

All Known Subinterfaces:

RSGroupableBalancer

All Known Implementing Classes:

BaseLoadBalancer, FavoredNodeLoadBalancer, FavoredStochasticBalancer, RSGroupBasedLoadBalancer, SimpleLoadBalancer, StochasticLoadBalancer

@InterfaceAudience.Private
public interface LoadBalancer
extends org.apache.hadoop.conf.Configurable, Stoppable, ConfigurationObserver

Makes decisions about the placement and movement of Regions across RegionServers.

Cluster-wide load balancing will occur only when there are no regions in transition and according to a fixed period of a time using balanceCluster(Map).

On cluster startup, bulk assignment can be used to determine locations for all Regions in a cluster.

This class produces plans for the AssignmentManager to execute.

Field Summary

Fields

Modifier and Type	Field and Description
static ServerName	BOGUS_SERVER_NAME
static String	SYSTEM_TABLES_ON_MASTER Deprecated. since 2.4.0, will be removed in 3.0.0.
static String	TABLES_ON_MASTER Deprecated. since 2.4.0, will be removed in 3.0.0.

Method Summary

Modifier and Type	Method and Description
List<RegionPlan>	balanceCluster(Map<TableName,Map<ServerName,List<RegionInfo>>> loadOfAllTable) Perform the major balance operation for cluster, will invoke balanceTable(org.apache.hadoop.hbase.TableName, java.util.Map<org.apache.hadoop.hbase.ServerName, java.util.List<org.apache.hadoop.hbase.client.RegionInfo>>) to do actual balance.
List<RegionPlan>	balanceTable(TableName tableName, Map<ServerName,List<RegionInfo>> loadOfOneTable) Perform the major balance operation for table, all class implement of LoadBalancer should override this method
void	initialize() Initialize the load balancer.
static boolean	isMasterCanHostUserRegions(org.apache.hadoop.conf.Configuration conf) Deprecated. since 2.4.0, will be removed in 3.0.0.
static boolean	isSystemTablesOnlyOnMaster(org.apache.hadoop.conf.Configuration conf) Deprecated. since 2.4.0, will be removed in 3.0.0.
static boolean	isTablesOnMaster(org.apache.hadoop.conf.Configuration conf) Deprecated. since 2.4.0, will be removed in 3.0.0.
void	onConfigurationChange(org.apache.hadoop.conf.Configuration conf) This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.
void	postMasterStartupInitialize() If balancer needs to do initialization after Master has started up, lets do that here.
ServerName	randomAssignment(RegionInfo regionInfo, List<ServerName> servers) Get a random region server from the list
void	regionOffline(RegionInfo regionInfo) Marks the region as offline at balancer.
void	regionOnline(RegionInfo regionInfo, ServerName sn) Marks the region as online at balancer.
Map<ServerName,List<RegionInfo>>	retainAssignment(Map<RegionInfo,ServerName> regions, List<ServerName> servers) Assign regions to the previously hosting region server
Map<ServerName,List<RegionInfo>>	roundRobinAssignment(List<RegionInfo> regions, List<ServerName> servers) Perform a Round Robin assignment of regions.
void	setClusterMetrics(ClusterMetrics st) Set the current cluster status.
void	setMasterServices(MasterServices masterServices) Set the master service.
void	updateBalancerStatus(boolean status)

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Methods inherited from interface org.apache.hadoop.hbase.Stoppable

isStopped, stop

Field Detail

TABLES_ON_MASTER

@Deprecated
static final String TABLES_ON_MASTER

Deprecated. since 2.4.0, will be removed in 3.0.0.

Master can carry regions as of hbase-2.0.0. By default, it carries no tables. TODO: Add any | system as flags to indicate what it can do.

See Also:

HBASE-15549, Constant Field Values

SYSTEM_TABLES_ON_MASTER

@Deprecated
static final String SYSTEM_TABLES_ON_MASTER

Deprecated. since 2.4.0, will be removed in 3.0.0.

Master carries system tables.

See Also:

HBASE-15549, Constant Field Values

BOGUS_SERVER_NAME

static final ServerName BOGUS_SERVER_NAME

Method Detail

setClusterMetrics

void setClusterMetrics(ClusterMetrics st)

Set the current cluster status. This allows a LoadBalancer to map host name to a server

Parameters:

st -

setMasterServices

void setMasterServices(MasterServices masterServices)

Set the master service.

Parameters:

masterServices -

balanceCluster

List<RegionPlan> balanceCluster(Map<TableName,Map<ServerName,List<RegionInfo>>> loadOfAllTable)
                         throws IOException

Perform the major balance operation for cluster, will invoke balanceTable(org.apache.hadoop.hbase.TableName, java.util.Map<org.apache.hadoop.hbase.ServerName, java.util.List<org.apache.hadoop.hbase.client.RegionInfo>>) to do actual balance. Normally not need override this method, except SimpleLoadBalancer and RSGroupBasedLoadBalancer.

Parameters:

loadOfAllTable - region load of servers for all table

Returns:

a list of regions to be moved, including source and destination, or null if cluster is already balanced

Throws:

IOException

balanceTable

List<RegionPlan> balanceTable(TableName tableName,
                              Map<ServerName,List<RegionInfo>> loadOfOneTable)

Perform the major balance operation for table, all class implement of LoadBalancer should override this method

Parameters:

tableName - the table to be balanced

loadOfOneTable - region load of servers for the specific one table

Returns:

List of plans

roundRobinAssignment

@NonNull
Map<ServerName,List<RegionInfo>> roundRobinAssignment(List<RegionInfo> regions,
                                                               List<ServerName> servers)
                                                        throws HBaseIOException

Perform a Round Robin assignment of regions.

Parameters:

regions -

servers -

Returns:

Map of servername to regioninfos

Throws:

HBaseIOException

retainAssignment

@NonNull
Map<ServerName,List<RegionInfo>> retainAssignment(Map<RegionInfo,ServerName> regions,
                                                           List<ServerName> servers)
                                                    throws HBaseIOException

Assign regions to the previously hosting region server

Parameters:

regions -

servers -

Returns:

List of plans

Throws:

HBaseIOException

randomAssignment

ServerName randomAssignment(RegionInfo regionInfo,
                            List<ServerName> servers)
                     throws HBaseIOException

Get a random region server from the list

Parameters:

regionInfo - Region for which this selection is being done.

servers -

Returns:

Servername

Throws:

HBaseIOException

initialize

void initialize()
         throws HBaseIOException

Initialize the load balancer. Must be called after setters.

Throws:

HBaseIOException

regionOnline

void regionOnline(RegionInfo regionInfo,
                  ServerName sn)

Marks the region as online at balancer.

Parameters:

regionInfo -

sn -

regionOffline

void regionOffline(RegionInfo regionInfo)

Marks the region as offline at balancer.

Parameters:

regionInfo -

onConfigurationChange

void onConfigurationChange(org.apache.hadoop.conf.Configuration conf)

Description copied from interface: ConfigurationObserver

This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.

Specified by:

onConfigurationChange in interface ConfigurationObserver

postMasterStartupInitialize

void postMasterStartupInitialize()

If balancer needs to do initialization after Master has started up, lets do that here.

updateBalancerStatus

void updateBalancerStatus(boolean status)

isTablesOnMaster

@Deprecated
static boolean isTablesOnMaster(org.apache.hadoop.conf.Configuration conf)

Deprecated. since 2.4.0, will be removed in 3.0.0.

Returns:

true if Master carries regions

See Also:

HBASE-15549

isSystemTablesOnlyOnMaster

@Deprecated
static boolean isSystemTablesOnlyOnMaster(org.apache.hadoop.conf.Configuration conf)

Deprecated. since 2.4.0, will be removed in 3.0.0.

See Also:

HBASE-15549

isMasterCanHostUserRegions

@Deprecated
static boolean isMasterCanHostUserRegions(org.apache.hadoop.conf.Configuration conf)

Deprecated. since 2.4.0, will be removed in 3.0.0.

See Also:

HBASE-15549