org.apache.hadoop.hbase.master

Interface LoadBalancer

All Superinterfaces:

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

All Known Implementing Classes:

BaseLoadBalancer, FavoredNodeLoadBalancer, FavoredStochasticBalancer, SimpleLoadBalancer, StochasticLoadBalancer

@InterfaceAudience.Private
public interface LoadBalancer
extends org.apache.hadoop.conf.Configurable, org.apache.hadoop.hbase.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 org.apache.hadoop.hbase.ServerName	BOGUS_SERVER_NAME
static String	SYSTEM_TABLES_ON_MASTER Master carries system tables.
static String	TABLES_ON_MASTER Master can carry regions as of hbase-2.0.0.

Method Summary

Modifier and Type	Method and Description
List<RegionPlan>	balanceCluster(Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> clusterState) Perform the major balance operation
List<RegionPlan>	balanceCluster(org.apache.hadoop.hbase.TableName tableName, Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> clusterState) Perform the major balance operation
void	initialize() Initialize the load balancer.
static boolean	isMasterCanHostUserRegions(org.apache.hadoop.conf.Configuration conf)
static boolean	isSystemTablesOnlyOnMaster(org.apache.hadoop.conf.Configuration conf)
static boolean	isTablesOnMaster(org.apache.hadoop.conf.Configuration conf)
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.
org.apache.hadoop.hbase.ServerName	randomAssignment(org.apache.hadoop.hbase.client.RegionInfo regionInfo, List<org.apache.hadoop.hbase.ServerName> servers) Get a random region server from the list
void	regionOffline(org.apache.hadoop.hbase.client.RegionInfo regionInfo) Marks the region as offline at balancer.
void	regionOnline(org.apache.hadoop.hbase.client.RegionInfo regionInfo, org.apache.hadoop.hbase.ServerName sn) Marks the region as online at balancer.
Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>>	retainAssignment(Map<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName> regions, List<org.apache.hadoop.hbase.ServerName> servers) Assign regions to the previously hosting region server
Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>>	roundRobinAssignment(List<org.apache.hadoop.hbase.client.RegionInfo> regions, List<org.apache.hadoop.hbase.ServerName> servers) Perform a Round Robin assignment of regions.
void	setClusterLoad(Map<org.apache.hadoop.hbase.TableName,Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>>> ClusterLoad) Pass RegionStates and allow balancer to set the current cluster load.
void	setClusterMetrics(org.apache.hadoop.hbase.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

static final String TABLES_ON_MASTER

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:

Constant Field Values

SYSTEM_TABLES_ON_MASTER

static final String SYSTEM_TABLES_ON_MASTER

Master carries system tables.

See Also:

Constant Field Values

BOGUS_SERVER_NAME

static final org.apache.hadoop.hbase.ServerName BOGUS_SERVER_NAME

Method Detail

setClusterMetrics

void setClusterMetrics(org.apache.hadoop.hbase.ClusterMetrics st)

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

Parameters:

st -

setClusterLoad

void setClusterLoad(Map<org.apache.hadoop.hbase.TableName,Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>>> ClusterLoad)

Pass RegionStates and allow balancer to set the current cluster load.

Parameters:

ClusterLoad -

setMasterServices

void setMasterServices(MasterServices masterServices)

Set the master service.

Parameters:

masterServices -

balanceCluster

List<RegionPlan> balanceCluster(org.apache.hadoop.hbase.TableName tableName,
                                Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> clusterState)
                         throws org.apache.hadoop.hbase.HBaseIOException

Perform the major balance operation

Parameters:

tableName -

clusterState -

Returns:

List of plans

Throws:

org.apache.hadoop.hbase.HBaseIOException

balanceCluster

List<RegionPlan> balanceCluster(Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> clusterState)
                         throws org.apache.hadoop.hbase.HBaseIOException

Perform the major balance operation

Parameters:

clusterState -

Returns:

List of plans

Throws:

org.apache.hadoop.hbase.HBaseIOException

roundRobinAssignment

Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> roundRobinAssignment(List<org.apache.hadoop.hbase.client.RegionInfo> regions,
                                                                                                             List<org.apache.hadoop.hbase.ServerName> servers)
                                                                                                      throws org.apache.hadoop.hbase.HBaseIOException

Perform a Round Robin assignment of regions.

Parameters:

regions -

servers -

Returns:

Map of servername to regioninfos

Throws:

org.apache.hadoop.hbase.HBaseIOException

retainAssignment

@Nullable
Map<org.apache.hadoop.hbase.ServerName,List<org.apache.hadoop.hbase.client.RegionInfo>> retainAssignment(Map<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName> regions,
                                                                                                                   List<org.apache.hadoop.hbase.ServerName> servers)
                                                                                                            throws org.apache.hadoop.hbase.HBaseIOException

Assign regions to the previously hosting region server

Parameters:

regions -

servers -

Returns:

List of plans

Throws:

org.apache.hadoop.hbase.HBaseIOException

randomAssignment

org.apache.hadoop.hbase.ServerName randomAssignment(org.apache.hadoop.hbase.client.RegionInfo regionInfo,
                                                    List<org.apache.hadoop.hbase.ServerName> servers)
                                             throws org.apache.hadoop.hbase.HBaseIOException

Get a random region server from the list

Parameters:

regionInfo - Region for which this selection is being done.

servers -

Returns:

Servername

Throws:

org.apache.hadoop.hbase.HBaseIOException

initialize

void initialize()
         throws org.apache.hadoop.hbase.HBaseIOException

Initialize the load balancer. Must be called after setters.

Throws:

org.apache.hadoop.hbase.HBaseIOException

regionOnline

void regionOnline(org.apache.hadoop.hbase.client.RegionInfo regionInfo,
                  org.apache.hadoop.hbase.ServerName sn)

Marks the region as online at balancer.

Parameters:

regionInfo -

sn -

regionOffline

void regionOffline(org.apache.hadoop.hbase.client.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

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

Returns:

true if Master carries regions

isSystemTablesOnlyOnMaster

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

isMasterCanHostUserRegions

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