org.apache.hadoop.hbase.replication.regionserver

Class ReplicationSource

java.lang.Object

org.apache.hadoop.hbase.replication.regionserver.ReplicationSource

All Implemented Interfaces:

ReplicationSourceInterface

Direct Known Subclasses:

RecoveredReplicationSource

@InterfaceAudience.Private
public class ReplicationSource
extends Object
implements ReplicationSourceInterface

Class that handles the source of a replication stream. Currently does not handle more than 1 slave cluster. For each slave cluster it selects a random number of peers using a replication ratio. For example, if replication ration = 0.1 and slave cluster has 100 region servers, 10 will be selected.

A stream is considered down when we cannot contact a region server on the peer cluster for more than 55 seconds by default.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.conf.Configuration	conf
static int	DEFAULT_WAIT_ON_ENDPOINT_SECONDS
protected org.apache.hadoop.fs.FileSystem	fs
protected ReplicationSourceLogQueue	logQueue
protected ReplicationSourceManager	manager
protected String	queueId
protected int	queueSizePerGroup
protected ReplicationQueueStorage	queueStorage
protected ReplicationPeer	replicationPeer
protected ReplicationQueueInfo	replicationQueueInfo
protected Server	server
static String	WAIT_ON_ENDPOINT_SECONDS
protected WALEntryFilter	walEntryFilter A filter (or a chain of filters) for WAL entries; filters out edits.
protected ConcurrentHashMap<String,ReplicationSourceShipper>	workerThreads

Method Summary

Modifier and Type	Method and Description
void	addHFileRefs(TableName tableName, byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs) Add hfile names to the queue to be replicated.
protected ReplicationSourceShipper	createNewShipper(String walGroupId)
void	enqueueLog(org.apache.hadoop.fs.Path wal) Add a log to the list of logs to replicate
org.apache.hadoop.fs.Path	getCurrentPath() Get the current log that's replicated
String	getPeerId() Get the id that the source is replicating to.
String	getQueueId() Get the queue id that the source is replicating to
Map<String,PriorityBlockingQueue<org.apache.hadoop.fs.Path>>	getQueues()
ReplicationEndpoint	getReplicationEndpoint() Returns the replication endpoint used by this replication source
ReplicationQueueInfo	getReplicationQueueInfo()
ReplicationQueueStorage	getReplicationQueueStorage() Returns The instance of queueStorage used by this ReplicationSource.
ServerName	getServerWALsBelongTo() The queue of WALs only belong to one region server.
ReplicationSourceManager	getSourceManager() Returns the replication source manager
MetricsSource	getSourceMetrics() Returns metrics of this replication source
String	getStats() Get a string representation of the current statistics for this source
WALFileLengthProvider	getWALFileLengthProvider() Returns the wal file length provider
Map<String,ReplicationStatus>	getWalGroupStatus() get the stat of replication for each wal group.
void	init(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ReplicationSourceManager manager, ReplicationQueueStorage queueStorage, ReplicationPeer replicationPeer, Server server, String queueId, UUID clusterId, WALFileLengthProvider walFileLengthProvider, MetricsSource metrics) Instantiation method used by region servers
boolean	isPeerEnabled() check whether the peer is enabled or not
boolean	isSourceActive() Returns active or not
boolean	isWorkerRunning()
String	logPeerId() Returns String to use as a log prefix that contains current peerId.
void	postShipEdits(List<WAL.Entry> entries, int batchSize) Call this after the shipper thread ship some entries to peer cluster.
protected boolean	sleepForRetries(String msg, int sleepMultiplier) Do the sleeping logic
ReplicationSourceInterface	startup() Start the replication
void	terminate(String reason) End the replication
void	terminate(String reason, Exception cause) End the replication
void	terminate(String reason, Exception cause, boolean clearMetrics) End the replication
void	terminate(String reason, Exception cause, boolean clearMetrics, boolean join)
void	tryThrottle(int batchSize) Try to throttle when the peer config with a bandwidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.replication.regionserver.ReplicationSourceInterface

isRecovered, logPositionAndCleanOldLogs

Field Detail

queueSizePerGroup

protected int queueSizePerGroup

logQueue

protected ReplicationSourceLogQueue logQueue

queueStorage

protected ReplicationQueueStorage queueStorage

replicationPeer

protected ReplicationPeer replicationPeer

conf

protected org.apache.hadoop.conf.Configuration conf

replicationQueueInfo

protected ReplicationQueueInfo replicationQueueInfo

manager

protected ReplicationSourceManager manager

server

protected Server server

fs

protected org.apache.hadoop.fs.FileSystem fs

queueId

protected String queueId

walEntryFilter

protected volatile WALEntryFilter walEntryFilter

A filter (or a chain of filters) for WAL entries; filters out edits.

workerThreads

protected final ConcurrentHashMap<String,ReplicationSourceShipper> workerThreads

WAIT_ON_ENDPOINT_SECONDS

public static final String WAIT_ON_ENDPOINT_SECONDS

See Also:

Constant Field Values

DEFAULT_WAIT_ON_ENDPOINT_SECONDS

public static final int DEFAULT_WAIT_ON_ENDPOINT_SECONDS

See Also:

Constant Field Values

Method Detail

init

public void init(org.apache.hadoop.conf.Configuration conf,
                 org.apache.hadoop.fs.FileSystem fs,
                 ReplicationSourceManager manager,
                 ReplicationQueueStorage queueStorage,
                 ReplicationPeer replicationPeer,
                 Server server,
                 String queueId,
                 UUID clusterId,
                 WALFileLengthProvider walFileLengthProvider,
                 MetricsSource metrics)
          throws IOException

Instantiation method used by region servers

Specified by:

init in interface ReplicationSourceInterface

Parameters:

conf - configuration to use

fs - file system to use

manager - replication manager to ping to

server - the server for this region server

queueId - the id of our replication queue

clusterId - unique UUID for the cluster

metrics - metrics for replication source

Throws:

IOException

enqueueLog

public void enqueueLog(org.apache.hadoop.fs.Path wal)

Description copied from interface: ReplicationSourceInterface

Add a log to the list of logs to replicate

Specified by:

enqueueLog in interface ReplicationSourceInterface

Parameters:

wal - path to the log to replicate

getQueues

@InterfaceAudience.Private
public Map<String,PriorityBlockingQueue<org.apache.hadoop.fs.Path>> getQueues()

addHFileRefs

public void addHFileRefs(TableName tableName,
                         byte[] family,
                         List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
                  throws ReplicationException

Description copied from interface: ReplicationSourceInterface

Add hfile names to the queue to be replicated.

Specified by:

addHFileRefs in interface ReplicationSourceInterface

Parameters:

tableName - Name of the table these files belongs to

family - Name of the family these files belong to

pairs - list of pairs of { HFile location in staging dir, HFile path in region dir which will be added in the queue for replication}

Throws:

ReplicationException - If failed to add hfile references

getWalGroupStatus

public Map<String,ReplicationStatus> getWalGroupStatus()

Description copied from interface: ReplicationSourceInterface

get the stat of replication for each wal group.

Specified by:

getWalGroupStatus in interface ReplicationSourceInterface

Returns:

stat of replication

createNewShipper

protected ReplicationSourceShipper createNewShipper(String walGroupId)

getReplicationEndpoint

public ReplicationEndpoint getReplicationEndpoint()

Description copied from interface: ReplicationSourceInterface

Returns the replication endpoint used by this replication source

Specified by:

getReplicationEndpoint in interface ReplicationSourceInterface

getSourceManager

public ReplicationSourceManager getSourceManager()

Description copied from interface: ReplicationSourceInterface

Returns the replication source manager

Specified by:

getSourceManager in interface ReplicationSourceInterface

tryThrottle

public void tryThrottle(int batchSize)
                 throws InterruptedException

Description copied from interface: ReplicationSourceInterface

Try to throttle when the peer config with a bandwidth

Specified by:

tryThrottle in interface ReplicationSourceInterface

Parameters:

batchSize - entries size will be pushed

Throws:

InterruptedException

sleepForRetries

protected boolean sleepForRetries(String msg,
                                  int sleepMultiplier)

Do the sleeping logic

Parameters:

msg - Why we sleep

sleepMultiplier - by how many times the default sleeping time is augmented

Returns:

True if sleepMultiplier is < maxRetriesMultiplier

isPeerEnabled

public boolean isPeerEnabled()

check whether the peer is enabled or not

Specified by:

isPeerEnabled in interface ReplicationSourceInterface

Returns:

true if the peer is enabled, otherwise false

startup

public ReplicationSourceInterface startup()

Description copied from interface: ReplicationSourceInterface

Start the replication

Specified by:

startup in interface ReplicationSourceInterface

terminate

public void terminate(String reason)

Description copied from interface: ReplicationSourceInterface

End the replication

Specified by:

terminate in interface ReplicationSourceInterface

Parameters:

reason - why it's terminating

terminate

public void terminate(String reason,
                      Exception cause)

Description copied from interface: ReplicationSourceInterface

End the replication

Specified by:

terminate in interface ReplicationSourceInterface

Parameters:

reason - why it's terminating

cause - the error that's causing it

terminate

public void terminate(String reason,
                      Exception cause,
                      boolean clearMetrics)

Description copied from interface: ReplicationSourceInterface

End the replication

Specified by:

terminate in interface ReplicationSourceInterface

Parameters:

reason - why it's terminating

cause - the error that's causing it

clearMetrics - removes all metrics about this Source

terminate

public void terminate(String reason,
                      Exception cause,
                      boolean clearMetrics,
                      boolean join)

getQueueId

public String getQueueId()

Description copied from interface: ReplicationSourceInterface

Get the queue id that the source is replicating to

Specified by:

getQueueId in interface ReplicationSourceInterface

Returns:

queue id

getPeerId

public String getPeerId()

Description copied from interface: ReplicationSourceInterface

Get the id that the source is replicating to.

Specified by:

getPeerId in interface ReplicationSourceInterface

Returns:

peer id

getCurrentPath

public org.apache.hadoop.fs.Path getCurrentPath()

Description copied from interface: ReplicationSourceInterface

Get the current log that's replicated

Specified by:

getCurrentPath in interface ReplicationSourceInterface

Returns:

the current log

isSourceActive

public boolean isSourceActive()

Description copied from interface: ReplicationSourceInterface

Returns active or not

Specified by:

isSourceActive in interface ReplicationSourceInterface

getReplicationQueueInfo

public ReplicationQueueInfo getReplicationQueueInfo()

isWorkerRunning

public boolean isWorkerRunning()

getStats

public String getStats()

Description copied from interface: ReplicationSourceInterface

Get a string representation of the current statistics for this source

Specified by:

getStats in interface ReplicationSourceInterface

Returns:

printable stats

getSourceMetrics

public MetricsSource getSourceMetrics()

Description copied from interface: ReplicationSourceInterface

Returns metrics of this replication source

Specified by:

getSourceMetrics in interface ReplicationSourceInterface

postShipEdits

public void postShipEdits(List<WAL.Entry> entries,
                          int batchSize)

Description copied from interface: ReplicationSourceInterface

Call this after the shipper thread ship some entries to peer cluster.

Specified by:

postShipEdits in interface ReplicationSourceInterface

Parameters:

entries - pushed

batchSize - entries size pushed

getWALFileLengthProvider

public WALFileLengthProvider getWALFileLengthProvider()

Description copied from interface: ReplicationSourceInterface

Returns the wal file length provider

Specified by:

getWALFileLengthProvider in interface ReplicationSourceInterface

getServerWALsBelongTo

public ServerName getServerWALsBelongTo()

Description copied from interface: ReplicationSourceInterface

The queue of WALs only belong to one region server. This will return the server name which all WALs belong to.

Specified by:

getServerWALsBelongTo in interface ReplicationSourceInterface

Returns:

the server name which all WALs belong to

getReplicationQueueStorage

public ReplicationQueueStorage getReplicationQueueStorage()

Description copied from interface: ReplicationSourceInterface

Returns The instance of queueStorage used by this ReplicationSource.

Specified by:

getReplicationQueueStorage in interface ReplicationSourceInterface

logPeerId

public String logPeerId()

Returns String to use as a log prefix that contains current peerId.