Package org.apache.hadoop.hbase.rsgroup

Class RSGroupInfoManagerImpl

java.lang.Object

org.apache.hadoop.hbase.rsgroup.RSGroupInfoManagerImpl

All Implemented Interfaces:

RSGroupInfoManager

@Private
final class RSGroupInfoManagerImpl
extends Object
implements RSGroupInfoManager

This is an implementation of RSGroupInfoManager which makes use of an HBase table as the persistence store for the group information. It also makes use of zookeeper to store group information needed for bootstrapping during offline mode.

Concurrency

RSGroup state is kept locally in Maps. There is a rsgroup name to cached RSGroupInfo Map at RSGroupInfoManagerImpl.RSGroupInfoHolder.groupName2Group. These Maps are persisted to the hbase:rsgroup table (and cached in zk) on each modification.

Mutations on state are synchronized but reads can continue without having to wait on an instance monitor, mutations do wholesale replace of the Maps on update -- Copy-On-Write; the local Maps of state are read-only, just-in-case (see flushConfig).

Reads must not block else there is a danger we'll deadlock.

Clients of this class, the RSGroupAdminEndpoint for example, want to query and then act on the results of the query modifying cache in zookeeper without another thread making intermediate modifications. These clients synchronize on the 'this' instance so no other has access concurrently. Reads must be able to continue concurrently.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RSGroupInfoManagerImpl.RSGroupInfoHolder
(package private) static class	RSGroupInfoManagerImpl.RSGroupMappingScript
private class	RSGroupInfoManagerImpl.RSGroupStartupWorker

Field Summary

Fields

Modifier and Type	Field	Description
private final AsyncClusterConnection	conn
(package private) static final int	DEFAULT_MAX_RETRY_VALUE	Define the default number of retries
(package private) static final String	FAILED_MOVE_MAX_RETRY	Define the config key of retries threshold when movements failed
private RSGroupInfoManagerImpl.RSGroupInfoHolder	holder
(package private) static final String	KEEP_ONE_SERVER_IN_DEFAULT_ERROR_MESSAGE
private static final org.slf4j.Logger	LOG
private final MasterServices	masterServices
(package private) static final byte[]	META_FAMILY_BYTES
(package private) static final byte[]	META_QUALIFIER_BYTES
(package private) static final String	MIGRATE_THREAD_NAME
private Set<String>	prevRSGroups
private static final byte[]	ROW_KEY
private static final String	RS_GROUP_ZNODE
private static final TableDescriptor	RSGROUP_TABLE_DESC	Table descriptor for hbase:rsgroup catalog table
(package private) static final TableName	RSGROUP_TABLE_NAME
private final RSGroupInfoManagerImpl.RSGroupStartupWorker	rsGroupStartupWorker
private RSGroupInfoManagerImpl.RSGroupMappingScript	script
private final ZKWatcher	watcher

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RSGroupInfoManagerImpl(MasterServices masterServices)

Method Summary

Modifier and Type	Method	Description
private void	addRegion(LinkedList<RegionInfo> regions, RegionInfo hri)
void	addRSGroup(RSGroupInfo rsGroupInfo)	Add given RSGroupInfo to existing list of group infos.
BalanceResponse	balanceRSGroup(String groupName, BalanceRequest request)	Balance a region server group.
private void	checkForDeadOrOnlineServers(Set<Address> servers)	Check if the set of servers are belong to dead servers list or online servers list.
private void	checkGroupName(String groupName)
private void	checkOnlineServersOnly(Set<Address> servers)
String	determineRSGroupInfoForTable(TableName tableName)	Determine RSGroupInfo for the given table.
private void	flushConfig()
private void	flushConfig(Map<String,RSGroupInfo> newGroupMap)
private void	flushConfigTable(Map<String,RSGroupInfo> groupMap)
private SortedSet<Address>	getDefaultServers()
private SortedSet<Address>	getDefaultServers(List<RSGroupInfo> rsGroupInfoList)
(package private) static RSGroupInfoManager	getInstance(MasterServices masterServices)
private Set<Address>	getOnlineServers()	Returns Set of online Servers named for their hostname and port (not ServerName).
private List<RegionInfo>	getRegions(Address server)	Returns List of Regions associated with this server.
RSGroupInfo	getRSGroup(String groupName)	Gets RSGroupInfo for the given group name.
(package private) Map<TableName,Map<ServerName,List<RegionInfo>>>	getRSGroupAssignmentsByTable(TableStateManager tableStateManager, String groupName)	This is an EXPENSIVE clone.
RSGroupInfo	getRSGroupForTable(TableName tableName)	Get RSGroupInfo for the given table.
private RSGroupInfo	getRSGroupInfo(String groupName)
RSGroupInfo	getRSGroupOfServer(Address serverHostPort)	Gets the group info of server.
private void	init()
private static boolean	isMasterRunning(MasterServices masterServices)
boolean	isOnline()	Whether the manager is able to fully return group metadata
private boolean	isTableInGroup(TableName tableName, String groupName, Set<TableName> tablesInGroupCache)
List<RSGroupInfo>	listRSGroups()	List the existing RSGroupInfos.
private void	migrate()
private void	migrate(Collection<RSGroupInfo> groupList)
private <T> void	moveRegionsBetweenGroups(Set<T> regionsOwners, Set<Address> newRegionsOwners, String targetGroupName, String sourceGroupName, Function<T,List<RegionInfo>> getRegionsInfo, Function<RegionInfo,Boolean> validation)
private void	moveServerRegionsFromGroup(Set<Address> movedServers, Set<Address> srcGrpServers, String targetGroupName, String sourceGroupName)	Move every region from servers which are currently located on these servers, but should not be located there.
void	moveServers(Set<Address> servers, String targetGroupName)	Move servers to a new group.
Set<Address>	moveServers(Set<Address> servers, String srcGroup, String dstGroup)
private void	moveTablesAndWait(Set<TableName> tables, String targetGroup)
private void	multiMutate(List<Mutation> mutations)
private void	refresh(boolean forceOnline)	Read rsgroup info from the source of truth, the hbase:rsgroup table.
void	removeRSGroup(String groupName)	Remove a region server group.
void	removeServers(Set<Address> servers)	Remove decommissioned servers from rsgroup
void	renameRSGroup(String oldName, String newName)	Rename rsgroup
private void	resetRSGroupMap(Map<String,RSGroupInfo> newRSGroupMap)	Make changes visible.
private List<RSGroupInfo>	retrieveGroupListFromGroupTable()
private List<RSGroupInfo>	retrieveGroupListFromZookeeper()
private Map<String,RegionState>	rsGroupGetRegionsInTransition(String groupName)
private void	saveRSGroupMapToZK(Map<String,RSGroupInfo> newGroupMap)
void	setRSGroup(Set<TableName> tables, String groupName)	Set group for tables.
void	start()
private void	updateCacheOfRSGroups(Set<String> currentGroups)	Update cache of rsgroups.
private void	updateDefaultServers()
void	updateRSGroupConfig(String groupName, Map<String,String> configuration)	Update RSGroup configuration
private void	waitForRegionMovement(List<Pair<RegionInfo,Future<byte[]>>> regionMoveFutures, Set<String> failedRegions, String sourceGroupName, int retryCount)	Wait for all the region move to complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final org.slf4j.Logger LOG

RSGROUP_TABLE_NAME

static final TableName RSGROUP_TABLE_NAME

KEEP_ONE_SERVER_IN_DEFAULT_ERROR_MESSAGE

static final String KEEP_ONE_SERVER_IN_DEFAULT_ERROR_MESSAGE

See Also:

• Constant Field Values

FAILED_MOVE_MAX_RETRY

static final String FAILED_MOVE_MAX_RETRY

Define the config key of retries threshold when movements failed

See Also:

• Constant Field Values

DEFAULT_MAX_RETRY_VALUE

static final int DEFAULT_MAX_RETRY_VALUE

Define the default number of retries

See Also:

• Constant Field Values

RS_GROUP_ZNODE

private static final String RS_GROUP_ZNODE

See Also:

• Constant Field Values

META_FAMILY_BYTES

static final byte[] META_FAMILY_BYTES

META_QUALIFIER_BYTES

static final byte[] META_QUALIFIER_BYTES

MIGRATE_THREAD_NAME

static final String MIGRATE_THREAD_NAME

See Also:

• Constant Field Values

ROW_KEY

private static final byte[] ROW_KEY

RSGROUP_TABLE_DESC

private static final TableDescriptor RSGROUP_TABLE_DESC

Table descriptor for hbase:rsgroup catalog table

holder

private volatile RSGroupInfoManagerImpl.RSGroupInfoHolder holder

masterServices

private final MasterServices masterServices

conn

private final AsyncClusterConnection conn

watcher

private final ZKWatcher watcher

rsGroupStartupWorker

private final RSGroupInfoManagerImpl.RSGroupStartupWorker rsGroupStartupWorker

prevRSGroups

private Set<String> prevRSGroups

script

private RSGroupInfoManagerImpl.RSGroupMappingScript script

Constructor Details

RSGroupInfoManagerImpl

private RSGroupInfoManagerImpl(MasterServices masterServices)

Method Details

updateDefaultServers

private void updateDefaultServers()

init

private void init()
           throws IOException

Throws:

IOException

getInstance

static RSGroupInfoManager getInstance(MasterServices masterServices)
                               throws IOException

Throws:

IOException

start

public void start()

Specified by:

start in interface RSGroupInfoManager

addRSGroup

public void addRSGroup(RSGroupInfo rsGroupInfo)
                throws IOException

Description copied from interface: RSGroupInfoManager

Add given RSGroupInfo to existing list of group infos.

Specified by:

addRSGroup in interface RSGroupInfoManager

Throws:

IOException

getRSGroupInfo

private RSGroupInfo getRSGroupInfo(String groupName)
                            throws ConstraintException

Throws:

ConstraintException

getOnlineServers

private Set<Address> getOnlineServers()

Returns Set of online Servers named for their hostname and port (not ServerName).

moveServers

public Set<Address> moveServers(Set<Address> servers,
 String srcGroup,
 String dstGroup)
                         throws IOException

Throws:

IOException

getRSGroupOfServer

public RSGroupInfo getRSGroupOfServer(Address serverHostPort)

Description copied from interface: RSGroupInfoManager

Gets the group info of server.

Specified by:

getRSGroupOfServer in interface RSGroupInfoManager

getRSGroup

public RSGroupInfo getRSGroup(String groupName)

Description copied from interface: RSGroupInfoManager

Gets RSGroupInfo for the given group name.

Specified by:

getRSGroup in interface RSGroupInfoManager

removeRSGroup

public void removeRSGroup(String groupName)
                   throws IOException

Description copied from interface: RSGroupInfoManager

Remove a region server group.

Specified by:

removeRSGroup in interface RSGroupInfoManager

Throws:

IOException

listRSGroups

public List<RSGroupInfo> listRSGroups()

Description copied from interface: RSGroupInfoManager

List the existing RSGroupInfos.

Specified by:

listRSGroups in interface RSGroupInfoManager

isOnline

public boolean isOnline()

Description copied from interface: RSGroupInfoManager

Whether the manager is able to fully return group metadata

Specified by:

isOnline in interface RSGroupInfoManager

Returns:

whether the manager is in online mode

removeServers

public void removeServers(Set<Address> servers)
                   throws IOException

Description copied from interface: RSGroupInfoManager

Remove decommissioned servers from rsgroup

Specified by:

removeServers in interface RSGroupInfoManager

Parameters:

servers - set of servers to remove

Throws:

IOException

retrieveGroupListFromGroupTable

private List<RSGroupInfo> retrieveGroupListFromGroupTable()
                                                   throws IOException

Throws:

IOException

retrieveGroupListFromZookeeper

private List<RSGroupInfo> retrieveGroupListFromZookeeper()
                                                  throws IOException

Throws:

IOException

migrate

private void migrate(Collection<RSGroupInfo> groupList)

migrate

private void migrate()

refresh

private void refresh(boolean forceOnline)
              throws IOException

Read rsgroup info from the source of truth, the hbase:rsgroup table. Update zk cache. Called on startup of the manager.

Throws:

IOException

flushConfigTable

private void flushConfigTable(Map<String,RSGroupInfo> groupMap)
                       throws IOException

Throws:

IOException

flushConfig

private void flushConfig()
                  throws IOException

Throws:

IOException

flushConfig

private void flushConfig(Map<String,RSGroupInfo> newGroupMap)
                  throws IOException

Throws:

IOException

saveRSGroupMapToZK

private void saveRSGroupMapToZK(Map<String,RSGroupInfo> newGroupMap)
                         throws IOException

Throws:

IOException

resetRSGroupMap

private void resetRSGroupMap(Map<String,RSGroupInfo> newRSGroupMap)

Make changes visible. Caller must be synchronized on 'this'.

updateCacheOfRSGroups

private void updateCacheOfRSGroups(Set<String> currentGroups)

Update cache of rsgroups. Caller must be synchronized on 'this'.

Parameters:

currentGroups - Current list of Groups.

getDefaultServers

private SortedSet<Address> getDefaultServers()

getDefaultServers

private SortedSet<Address> getDefaultServers(List<RSGroupInfo> rsGroupInfoList)

isMasterRunning

private static boolean isMasterRunning(MasterServices masterServices)

multiMutate

private void multiMutate(List<Mutation> mutations)
                  throws IOException

Throws:

IOException

checkGroupName

private void checkGroupName(String groupName)
                     throws ConstraintException

Throws:

ConstraintException

getRSGroupForTable

public RSGroupInfo getRSGroupForTable(TableName tableName)
                               throws IOException

Description copied from interface: RSGroupInfoManager

Get RSGroupInfo for the given table.

Specified by:

getRSGroupForTable in interface RSGroupInfoManager

Throws:

IOException

checkForDeadOrOnlineServers

private void checkForDeadOrOnlineServers(Set<Address> servers)
                                  throws IOException

Check if the set of servers are belong to dead servers list or online servers list.

Parameters:

servers - servers to remove

Throws:

IOException

checkOnlineServersOnly

private void checkOnlineServersOnly(Set<Address> servers)
                             throws IOException

Throws:

IOException

getRegions

private List<RegionInfo> getRegions(Address server)

Returns List of Regions associated with this server.

addRegion

private void addRegion(LinkedList<RegionInfo> regions,
 RegionInfo hri)

moveServerRegionsFromGroup

private void moveServerRegionsFromGroup(Set<Address> movedServers,
 Set<Address> srcGrpServers,
 String targetGroupName,
 String sourceGroupName)
                                 throws IOException

Move every region from servers which are currently located on these servers, but should not be located there.

Parameters:

movedServers - the servers that are moved to new group

srcGrpServers - all servers in the source group, excluding the movedServers

targetGroupName - the target group

sourceGroupName - the source group

Throws:

IOException - if moving the server and tables fail

moveRegionsBetweenGroups

private <T> void moveRegionsBetweenGroups(Set<T> regionsOwners,
 Set<Address> newRegionsOwners,
 String targetGroupName,
 String sourceGroupName,
 Function<T,List<RegionInfo>> getRegionsInfo,
 Function<RegionInfo,Boolean> validation)
                                   throws IOException

Throws:

IOException

waitForRegionMovement

private void waitForRegionMovement(List<Pair<RegionInfo,Future<byte[]>>> regionMoveFutures,
 Set<String> failedRegions,
 String sourceGroupName,
 int retryCount)

Wait for all the region move to complete. Keep waiting for other region movement completion even if some region movement fails.

isTableInGroup

private boolean isTableInGroup(TableName tableName,
 String groupName,
 Set<TableName> tablesInGroupCache)
                        throws IOException

Throws:

IOException

rsGroupGetRegionsInTransition

private Map<String,RegionState> rsGroupGetRegionsInTransition(String groupName)
                                                       throws IOException

Throws:

IOException

getRSGroupAssignmentsByTable

Map<TableName,Map<ServerName,List<RegionInfo>>> getRSGroupAssignmentsByTable(TableStateManager tableStateManager,
 String groupName)
                                                                      throws IOException

This is an EXPENSIVE clone. Cloning though is the safest thing to do. Can't let out original since it can change and at least the load balancer wants to iterate this exported list. Load balancer should iterate over this list because cloned list will ignore disabled table and split parent region cases. This method is invoked by balanceRSGroup(java.lang.String, org.apache.hadoop.hbase.client.BalanceRequest)

Returns:

A clone of current assignments for this group.

Throws:

IOException

balanceRSGroup

public BalanceResponse balanceRSGroup(String groupName,
 BalanceRequest request)
                               throws IOException

Description copied from interface: RSGroupInfoManager

Balance a region server group.

Specified by:

balanceRSGroup in interface RSGroupInfoManager

Throws:

IOException

moveTablesAndWait

private void moveTablesAndWait(Set<TableName> tables,
 String targetGroup)
                        throws IOException

Throws:

IOException

setRSGroup

public void setRSGroup(Set<TableName> tables,
 String groupName)
                throws IOException

Description copied from interface: RSGroupInfoManager

Set group for tables.

Specified by:

setRSGroup in interface RSGroupInfoManager

Throws:

IOException

moveServers

public void moveServers(Set<Address> servers,
 String targetGroupName)
                 throws IOException

Description copied from interface: RSGroupInfoManager

Move servers to a new group.

Specified by:

moveServers in interface RSGroupInfoManager

Throws:

IOException

determineRSGroupInfoForTable

public String determineRSGroupInfoForTable(TableName tableName)

Description copied from interface: RSGroupInfoManager

Determine RSGroupInfo for the given table.

Specified by:

determineRSGroupInfoForTable in interface RSGroupInfoManager

Parameters:

tableName - table name

Returns:

rsgroup name

renameRSGroup

public void renameRSGroup(String oldName,
 String newName)
                   throws IOException

Description copied from interface: RSGroupInfoManager

Rename rsgroup

Specified by:

renameRSGroup in interface RSGroupInfoManager

Parameters:

oldName - old rsgroup name

newName - new rsgroup name

Throws:

IOException

updateRSGroupConfig

public void updateRSGroupConfig(String groupName,
 Map<String,String> configuration)
                         throws IOException

Description copied from interface: RSGroupInfoManager

Update RSGroup configuration

Specified by:

updateRSGroupConfig in interface RSGroupInfoManager

Parameters:

groupName - the group name

configuration - new configuration of the group name to be set

Throws:

IOException - if a remote or network exception occurs