org.apache.hadoop.hbase.client

Class MasterRegistry

java.lang.Object

org.apache.hadoop.hbase.client.MasterRegistry

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionRegistry

@InterfaceAudience.Private
public class MasterRegistry
extends Object
implements ConnectionRegistry

Master based registry implementation. Makes RPCs to the configured master addresses from config "hbase.masters".

It supports hedged reads, set the fan out of the requests batch by MASTER_REGISTRY_HEDGED_REQS_FANOUT_KEY to a value greater than 1 will enable it(the default value is MASTER_REGISTRY_HEDGED_REQS_FANOUT_DEFAULT).

TODO: Handle changes to the configuration dynamically without having to restart the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	MasterRegistry.Callable<T> For describing the actual asynchronous rpc call.

Field Summary

Fields

Modifier and Type	Field and Description
private int	hedgedReadFanOut
private static String	MASTER_ADDRS_CONF_SEPARATOR
static int	MASTER_REGISTRY_HEDGED_REQS_FANOUT_DEFAULT Default value for the fan out of hedged requests.
static String	MASTER_REGISTRY_HEDGED_REQS_FANOUT_KEY Configuration key that controls the fan out of requests
private org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap<ServerName,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface>	masterAddr2Stub
private RpcClient	rpcClient
private RpcControllerFactory	rpcControllerFactory

Constructor Summary

Constructors

Constructor and Description
MasterRegistry(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
private IOException	badResponse(String debug)
private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T>	call(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface stub, MasterRegistry.Callable<T> callable)
private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T>	call(MasterRegistry.Callable<T> callable, Predicate<T> isValidResp, String debug)
void	close() Closes this instance and releases any system resources associated with it
CompletableFuture<ServerName>	getActiveMaster() Get the address of active HMaster.
CompletableFuture<String>	getClusterId() Should only be called once.
static String	getMasterAddr(org.apache.hadoop.conf.Configuration conf) Builds the default master address end point if it is not specified in the configuration.
CompletableFuture<RegionLocations>	getMetaRegionLocations() Get the location of meta region(s).
(package private) Set<ServerName>	getParsedMasterServers()
private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> void	groupCall(CompletableFuture<T> future, List<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface> masterStubs, int startIndexInclusive, MasterRegistry.Callable<T> callable, Predicate<T> isValidResp, String debug, ConcurrentLinkedQueue<Throwable> errors) send requests concurrently to hedgedReadsFanout masters.
private static Set<ServerName>	parseMasterAddrs(org.apache.hadoop.conf.Configuration conf) Parses the list of master addresses from the provided configuration.
private RegionLocations	transformMetaRegionLocations(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetMetaRegionLocationsResponse resp) Simple helper to transform the result of getMetaRegionLocations() rpc.
private ServerName	transformServerName(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetActiveMasterResponse resp)

Methods inherited from class java.lang.Object

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

Field Detail

MASTER_REGISTRY_HEDGED_REQS_FANOUT_KEY

public static final String MASTER_REGISTRY_HEDGED_REQS_FANOUT_KEY

Configuration key that controls the fan out of requests

See Also:

Constant Field Values

MASTER_REGISTRY_HEDGED_REQS_FANOUT_DEFAULT

public static final int MASTER_REGISTRY_HEDGED_REQS_FANOUT_DEFAULT

Default value for the fan out of hedged requests.

See Also:

Constant Field Values

MASTER_ADDRS_CONF_SEPARATOR

private static final String MASTER_ADDRS_CONF_SEPARATOR

See Also:

Constant Field Values

hedgedReadFanOut

private final int hedgedReadFanOut

masterAddr2Stub

private final org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap<ServerName,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface> masterAddr2Stub

rpcClient

private final RpcClient rpcClient

rpcControllerFactory

private final RpcControllerFactory rpcControllerFactory

Constructor Detail

MasterRegistry

MasterRegistry(org.apache.hadoop.conf.Configuration conf)
        throws IOException

Throws:

IOException

Method Detail

parseMasterAddrs

private static Set<ServerName> parseMasterAddrs(org.apache.hadoop.conf.Configuration conf)
                                         throws UnknownHostException

Parses the list of master addresses from the provided configuration. Supported format is comma separated host[:port] values. If no port number if specified, default master port is assumed.

Parameters:

conf - Configuration to parse from.

Throws:

UnknownHostException

getMasterAddr

public static String getMasterAddr(org.apache.hadoop.conf.Configuration conf)
                            throws UnknownHostException

Builds the default master address end point if it is not specified in the configuration.

Will be called in HBaseTestingUtility.

Throws:

UnknownHostException

call

private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T> call(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface stub,
                                                                                                      MasterRegistry.Callable<T> callable)

badResponse

private IOException badResponse(String debug)

groupCall

private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> void groupCall(CompletableFuture<T> future,
                                                                                           List<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.ClientMetaService.Interface> masterStubs,
                                                                                           int startIndexInclusive,
                                                                                           MasterRegistry.Callable<T> callable,
                                                                                           Predicate<T> isValidResp,
                                                                                           String debug,
                                                                                           ConcurrentLinkedQueue<Throwable> errors)

send requests concurrently to hedgedReadsFanout masters. If any of the request is succeeded, we will complete the future and quit. If all the requests in one round are failed, we will start another round to send requests concurrently tohedgedReadsFanout masters. If all masters have been tried and all of them are failed, we will fail the future.

call

private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T> call(MasterRegistry.Callable<T> callable,
                                                                                                      Predicate<T> isValidResp,
                                                                                                      String debug)

transformMetaRegionLocations

private RegionLocations transformMetaRegionLocations(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetMetaRegionLocationsResponse resp)

Simple helper to transform the result of getMetaRegionLocations() rpc.

getMetaRegionLocations

public CompletableFuture<RegionLocations> getMetaRegionLocations()

Description copied from interface: ConnectionRegistry

Get the location of meta region(s).

Specified by:

getMetaRegionLocations in interface ConnectionRegistry

getClusterId

public CompletableFuture<String> getClusterId()

Description copied from interface: ConnectionRegistry

Should only be called once.

The upper layer should store this value somewhere as it will not be change any more.

Specified by:

getClusterId in interface ConnectionRegistry

transformServerName

private ServerName transformServerName(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProtos.GetActiveMasterResponse resp)

getActiveMaster

public CompletableFuture<ServerName> getActiveMaster()

Description copied from interface: ConnectionRegistry

Get the address of active HMaster.

Specified by:

getActiveMaster in interface ConnectionRegistry

getParsedMasterServers

Set<ServerName> getParsedMasterServers()

close

public void close()

Description copied from interface: ConnectionRegistry

Closes this instance and releases any system resources associated with it

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ConnectionRegistry