org.apache.hadoop.hbase.master.procedure

Class SwitchRpcThrottleRemoteProcedure

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<MasterProcedureEnv>

org.apache.hadoop.hbase.master.procedure.ServerRemoteProcedure

org.apache.hadoop.hbase.master.procedure.SwitchRpcThrottleRemoteProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, ServerProcedureInterface, RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

@InterfaceAudience.Private
public class SwitchRpcThrottleRemoteProcedure
extends ServerRemoteProcedure
implements ServerProcedureInterface

The procedure to switch rpc throttle on region server

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.ServerProcedureInterface

ServerProcedureInterface.ServerOperationType

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
private boolean	rpcThrottleEnabled

Fields inherited from class org.apache.hadoop.hbase.master.procedure.ServerRemoteProcedure

dispatched, event, succ, targetServer

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SwitchRpcThrottleRemoteProcedure()
SwitchRpcThrottleRemoteProcedure(ServerName serverName, boolean rpcThrottleEnabled)

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(MasterProcedureEnv env) The abort() call is asynchronous and each procedure must decide how to deal with it, if they want to be abortable.
protected void	complete(MasterProcedureEnv env, Throwable error)
protected void	deserializeStateData(ProcedureStateSerializer serializer) Called on store load to allow the user to decode the previously serialized state.
ServerName	getServerName() Returns Name of this server instance.
ServerProcedureInterface.ServerOperationType	getServerOperationType() Given an operation type we can take decisions about what to do with pending operations.
boolean	hasMetaTableRegion() Returns True if this server has an hbase:meta table region.
Optional<RemoteProcedureDispatcher.RemoteOperation>	remoteCallBuild(MasterProcedureEnv masterProcedureEnv, ServerName remote) For building the remote operation.
protected void	rollback(MasterProcedureEnv env) The code to undo what was done by the execute() code.
protected void	serializeStateData(ProcedureStateSerializer serializer) The user-level code of the procedure may have some state to persist (e.g.
void	toStringClassDetails(StringBuilder sb) Extend the toString() information with the procedure details e.g.

Methods inherited from class org.apache.hadoop.hbase.master.procedure.ServerRemoteProcedure

completionCleanup, execute, remoteCallFailed, remoteOperationCompleted, remoteOperationDone, remoteOperationFailed

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

acquireLock, addStackIndex, afterReplay, beforeReplay, bypass, compareTo, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringDetails, toStringSimpleSB, toStringState, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, waitInitialized, wasExecuted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.procedure2.RemoteProcedureDispatcher.RemoteProcedure

storeInDispatchedQueue

Field Detail

LOG

private static final org.slf4j.Logger LOG

rpcThrottleEnabled

private boolean rpcThrottleEnabled

Constructor Detail

SwitchRpcThrottleRemoteProcedure

public SwitchRpcThrottleRemoteProcedure()

SwitchRpcThrottleRemoteProcedure

public SwitchRpcThrottleRemoteProcedure(ServerName serverName,
                                        boolean rpcThrottleEnabled)

Method Detail

rollback

protected void rollback(MasterProcedureEnv env)
                 throws IOException,
                        InterruptedException

Description copied from class: Procedure

The code to undo what was done by the execute() code. It is called when the procedure or one of the sub-procedures failed or an abort was requested. It should cleanup all the resources created by the execute() call. The implementation must be idempotent since rollback() may be called multiple time in case of machine failure in the middle of the execution.

Specified by:

rollback in class Procedure<MasterProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException - the procedure will be added back to the queue and retried later

abort

protected boolean abort(MasterProcedureEnv env)

Description copied from class: Procedure

The abort() call is asynchronous and each procedure must decide how to deal with it, if they want to be abortable. The simplest implementation is to have an AtomicBoolean set in the abort() method and then the execute() will check if the abort flag is set or not. abort() may be called multiple times from the client, so the implementation must be idempotent.

NOTE: abort() is not like Thread.interrupt(). It is just a notification that allows the procedure implementor abort.

Specified by:

abort in class Procedure<MasterProcedureEnv>

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Specified by:

serializeStateData in class Procedure<MasterProcedureEnv>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Specified by:

deserializeStateData in class Procedure<MasterProcedureEnv>

Parameters:

serializer - contains the serialized state

Throws:

IOException

remoteCallBuild

public Optional<RemoteProcedureDispatcher.RemoteOperation> remoteCallBuild(MasterProcedureEnv masterProcedureEnv,
                                                                           ServerName remote)

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

For building the remote operation. May be empty if no need to send remote call. Usually, this means the RemoteProcedure has been finished already. This is possible, as we may have already sent the procedure to RS but then the rpc connection is broken so the executeProcedures call fails, but the RS does receive the procedure and execute it and then report back, before we retry again.

Specified by:

remoteCallBuild in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

getServerName

public ServerName getServerName()

Description copied from interface: ServerProcedureInterface

Returns Name of this server instance.

Specified by:

getServerName in interface ServerProcedureInterface

hasMetaTableRegion

public boolean hasMetaTableRegion()

Description copied from interface: ServerProcedureInterface

Returns True if this server has an hbase:meta table region.

Specified by:

hasMetaTableRegion in interface ServerProcedureInterface

getServerOperationType

public ServerProcedureInterface.ServerOperationType getServerOperationType()

Description copied from interface: ServerProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a crash handler and we have some assignment operation pending we can abort those operations.

Specified by:

getServerOperationType in interface ServerProcedureInterface

Returns:

the operation type that the procedure is executing.

complete

protected void complete(MasterProcedureEnv env,
                        Throwable error)

Specified by:

complete in class ServerRemoteProcedure

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Description copied from class: Procedure

Extend the toString() information with the procedure details e.g. className and parameters

Overrides:

toStringClassDetails in class Procedure<MasterProcedureEnv>

Parameters:

sb - the string builder to use to append the proc specific information