org.apache.hadoop.hbase.ipc

Class SimpleRpcScheduler

java.lang.Object

org.apache.hadoop.hbase.ipc.RpcScheduler

org.apache.hadoop.hbase.ipc.SimpleRpcScheduler

All Implemented Interfaces:

ConfigurationObserver

@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
 @InterfaceStability.Evolving
public class SimpleRpcScheduler
extends RpcScheduler
implements ConfigurationObserver

A scheduler that maintains isolated handler pools for general, high-priority, and replication requests.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.ipc.RpcScheduler

RpcScheduler.Context

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALL_QUEUE_CODEL_DEFAULT_INTERVAL
static double	CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD
static int	CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY
static String	CALL_QUEUE_CODEL_INTERVAL
static String	CALL_QUEUE_CODEL_LIFO_THRESHOLD
static String	CALL_QUEUE_CODEL_TARGET_DELAY
static String	CALL_QUEUE_HANDLER_FACTOR_CONF_KEY
static String	CALL_QUEUE_READ_SHARE_CONF_KEY
static String	CALL_QUEUE_SCAN_SHARE_CONF_KEY
static String	CALL_QUEUE_TYPE_CODEL_CONF_VALUE
static String	CALL_QUEUE_TYPE_CONF_DEFAULT
static String	CALL_QUEUE_TYPE_CONF_KEY The default, 'fifo', has the least friction but is dumb.
static String	CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE
static String	CALL_QUEUE_TYPE_FIFO_CONF_VALUE
static Log	LOG
static String	QUEUE_MAX_CALL_DELAY_CONF_KEY max delay in msec used to bound the deprioritized requests

Fields inherited from class org.apache.hadoop.hbase.ipc.RpcScheduler

IPC_SERVER_MAX_CALLQUEUE_LENGTH, IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH

Constructor Summary

Constructors

Constructor and Description
SimpleRpcScheduler(Configuration conf, int handlerCount, int priorityHandlerCount, int replicationHandlerCount, PriorityFunction priority, Abortable server, int highPriorityLevel)
SimpleRpcScheduler(Configuration conf, int handlerCount, int priorityHandlerCount, int replicationHandlerCount, PriorityFunction priority, int highPriorityLevel)

Method Summary

Modifier and Type	Method and Description
boolean	dispatch(CallRunner callTask) Dispatches an RPC request asynchronously.
int	getActiveRpcHandlerCount() Retrieves the number of active handler.
int	getGeneralQueueLength() Retrieves length of the general queue for metrics.
long	getNumGeneralCallsDropped() If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped from general queue because RPC executor is under high load; returns 0 otherwise.
long	getNumLifoModeSwitches() If CoDel-based RPC executors are used, retrieves the number of Calls that were picked from the tail of the queue (indicating adaptive LIFO mode, when in the period of overloade we serve last requests first); returns 0 otherwise.
int	getPriorityQueueLength() Retrieves length of the priority queue for metrics.
int	getReplicationQueueLength() Retrieves length of the replication queue for metrics.
void	init(RpcScheduler.Context context) Does some quick initialization.
void	onConfigurationChange(Configuration conf) Resize call queues;
void	start() Prepares for request serving.
void	stop() Stops serving new requests.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Log LOG

CALL_QUEUE_READ_SHARE_CONF_KEY

public static final String CALL_QUEUE_READ_SHARE_CONF_KEY

See Also:

Constant Field Values

CALL_QUEUE_SCAN_SHARE_CONF_KEY

public static final String CALL_QUEUE_SCAN_SHARE_CONF_KEY

See Also:

Constant Field Values

CALL_QUEUE_HANDLER_FACTOR_CONF_KEY

public static final String CALL_QUEUE_HANDLER_FACTOR_CONF_KEY

See Also:

Constant Field Values

CALL_QUEUE_TYPE_CONF_KEY

public static final String CALL_QUEUE_TYPE_CONF_KEY

The default, 'fifo', has the least friction but is dumb. If set to 'deadline', uses a priority queue and deprioritizes long-running scans. Sorting by priority comes at a cost, reduced throughput.

See Also:

Constant Field Values

CALL_QUEUE_TYPE_CODEL_CONF_VALUE

public static final String CALL_QUEUE_TYPE_CODEL_CONF_VALUE

See Also:

Constant Field Values

CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE

public static final String CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE

See Also:

Constant Field Values

CALL_QUEUE_TYPE_FIFO_CONF_VALUE

public static final String CALL_QUEUE_TYPE_FIFO_CONF_VALUE

See Also:

Constant Field Values

CALL_QUEUE_TYPE_CONF_DEFAULT

public static final String CALL_QUEUE_TYPE_CONF_DEFAULT

See Also:

Constant Field Values

QUEUE_MAX_CALL_DELAY_CONF_KEY

public static final String QUEUE_MAX_CALL_DELAY_CONF_KEY

max delay in msec used to bound the deprioritized requests

See Also:

Constant Field Values

CALL_QUEUE_CODEL_TARGET_DELAY

public static final String CALL_QUEUE_CODEL_TARGET_DELAY

See Also:

Constant Field Values

CALL_QUEUE_CODEL_INTERVAL

public static final String CALL_QUEUE_CODEL_INTERVAL

See Also:

Constant Field Values

CALL_QUEUE_CODEL_LIFO_THRESHOLD

public static final String CALL_QUEUE_CODEL_LIFO_THRESHOLD

See Also:

Constant Field Values

CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY

public static final int CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY

See Also:

Constant Field Values

CALL_QUEUE_CODEL_DEFAULT_INTERVAL

public static final int CALL_QUEUE_CODEL_DEFAULT_INTERVAL

See Also:

Constant Field Values

CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD

public static final double CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

SimpleRpcScheduler

public SimpleRpcScheduler(Configuration conf,
                          int handlerCount,
                          int priorityHandlerCount,
                          int replicationHandlerCount,
                          PriorityFunction priority,
                          Abortable server,
                          int highPriorityLevel)

Parameters:

conf -

handlerCount - the number of handler threads that will be used to process calls

priorityHandlerCount - How many threads for priority handling.

replicationHandlerCount - How many threads for replication handling.

highPriorityLevel -

priority - Function to extract request priority.

SimpleRpcScheduler

public SimpleRpcScheduler(Configuration conf,
                          int handlerCount,
                          int priorityHandlerCount,
                          int replicationHandlerCount,
                          PriorityFunction priority,
                          int highPriorityLevel)

Method Detail

onConfigurationChange

public void onConfigurationChange(Configuration conf)

Resize call queues;

Specified by:

onConfigurationChange in interface ConfigurationObserver

Parameters:

conf - new configuration

init

public void init(RpcScheduler.Context context)

Description copied from class: RpcScheduler

Does some quick initialization. Heavy tasks (e.g. starting threads) should be done in RpcScheduler.start(). This method is called before start.

Specified by:

init in class RpcScheduler

Parameters:

context - provides methods to retrieve runtime information from

start

public void start()

Description copied from class: RpcScheduler

Prepares for request serving. An implementation may start some handler threads here.

Specified by:

start in class RpcScheduler

stop

public void stop()

Description copied from class: RpcScheduler

Stops serving new requests.

Specified by:

stop in class RpcScheduler

dispatch

public boolean dispatch(CallRunner callTask)
                 throws InterruptedException

Description copied from class: RpcScheduler

Dispatches an RPC request asynchronously. An implementation is free to choose to process the request immediately or delay it for later processing.

Specified by:

dispatch in class RpcScheduler

Parameters:

callTask - the request to be dispatched

Throws:

InterruptedException

getGeneralQueueLength

public int getGeneralQueueLength()

Description copied from class: RpcScheduler

Retrieves length of the general queue for metrics.

Specified by:

getGeneralQueueLength in class RpcScheduler

getPriorityQueueLength

public int getPriorityQueueLength()

Description copied from class: RpcScheduler

Retrieves length of the priority queue for metrics.

Specified by:

getPriorityQueueLength in class RpcScheduler

getReplicationQueueLength

public int getReplicationQueueLength()

Description copied from class: RpcScheduler

Retrieves length of the replication queue for metrics.

Specified by:

getReplicationQueueLength in class RpcScheduler

getActiveRpcHandlerCount

public int getActiveRpcHandlerCount()

Description copied from class: RpcScheduler

Retrieves the number of active handler.

Specified by:

getActiveRpcHandlerCount in class RpcScheduler

getNumGeneralCallsDropped

public long getNumGeneralCallsDropped()

Description copied from class: RpcScheduler

If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped from general queue because RPC executor is under high load; returns 0 otherwise.

Specified by:

getNumGeneralCallsDropped in class RpcScheduler

getNumLifoModeSwitches

public long getNumLifoModeSwitches()

Description copied from class: RpcScheduler

If CoDel-based RPC executors are used, retrieves the number of Calls that were picked from the tail of the queue (indicating adaptive LIFO mode, when in the period of overloade we serve last requests first); returns 0 otherwise.

Specified by:

getNumLifoModeSwitches in class RpcScheduler