org.apache.hadoop.hbase.quotas

Class DefaultOperationQuota

java.lang.Object

org.apache.hadoop.hbase.quotas.DefaultOperationQuota

All Implemented Interfaces:

OperationQuota

Direct Known Subclasses:

ExceedOperationQuota

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class DefaultOperationQuota
extends Object
implements OperationQuota

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.quotas.OperationQuota

OperationQuota.OperationType

Field Summary

Fields

Modifier and Type	Field and Description
protected List<QuotaLimiter>	limiters
private static org.slf4j.Logger	LOG
private long[]	operationSize
protected long	readAvailable
private long	readCapacityUnit
protected long	readCapacityUnitConsumed
protected long	readCapacityUnitDiff
protected long	readConsumed
protected long	readDiff
protected long	writeAvailable
private long	writeCapacityUnit
protected long	writeCapacityUnitConsumed
protected long	writeCapacityUnitDiff
protected long	writeConsumed
protected long	writeDiff

Constructor Summary

Constructors

Constructor and Description
DefaultOperationQuota(org.apache.hadoop.conf.Configuration conf, List<QuotaLimiter> limiters) NOTE: The order matters.
DefaultOperationQuota(org.apache.hadoop.conf.Configuration conf, QuotaLimiter... limiters)

Method Summary

Modifier and Type	Method and Description
void	addGetResult(Result result) Add a get result.
void	addMutation(Mutation mutation) Add a mutation result.
void	addScanResult(List<Result> results) Add a scan result.
private long	calculateReadCapacityUnit(long size)
private long	calculateReadCapacityUnitDiff(long actualSize, long estimateSize)
private long	calculateWriteCapacityUnit(long size)
private long	calculateWriteCapacityUnitDiff(long actualSize, long estimateSize)
void	checkQuota(int numWrites, int numReads, int numScans) Checks if it is possible to execute the specified operation.
void	close() Cleanup method on operation completion
private long	estimateConsume(OperationQuota.OperationType type, int numReqs, long avgSize)
long	getReadAvailable()
long	getWriteAvailable()
protected void	updateEstimateConsumeQuota(int numWrites, int numReads, int numScans) Update estimate quota(read/write size/capacityUnits) which will be consumed

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

limiters

protected final List<QuotaLimiter> limiters

writeCapacityUnit

private final long writeCapacityUnit

readCapacityUnit

private final long readCapacityUnit

writeAvailable

protected long writeAvailable

readAvailable

protected long readAvailable

writeConsumed

protected long writeConsumed

readConsumed

protected long readConsumed

writeCapacityUnitConsumed

protected long writeCapacityUnitConsumed

readCapacityUnitConsumed

protected long readCapacityUnitConsumed

operationSize

private final long[] operationSize

writeDiff

protected long writeDiff

readDiff

protected long readDiff

writeCapacityUnitDiff

protected long writeCapacityUnitDiff

readCapacityUnitDiff

protected long readCapacityUnitDiff

Constructor Detail

DefaultOperationQuota

public DefaultOperationQuota(org.apache.hadoop.conf.Configuration conf,
                             QuotaLimiter... limiters)

DefaultOperationQuota

public DefaultOperationQuota(org.apache.hadoop.conf.Configuration conf,
                             List<QuotaLimiter> limiters)

NOTE: The order matters. It should be something like [user, table, namespace, global]

Method Detail

checkQuota

public void checkQuota(int numWrites,
                       int numReads,
                       int numScans)
                throws RpcThrottlingException

Description copied from interface: OperationQuota

Checks if it is possible to execute the specified operation. The quota will be estimated based on the number of operations to perform and the average size accumulated during time.

Specified by:

checkQuota in interface OperationQuota

Parameters:

numWrites - number of write operation that will be performed

numReads - number of small-read operation that will be performed

numScans - number of long-read operation that will be performed

Throws:

RpcThrottlingException - if the operation cannot be performed because RPC quota is exceeded.

close

public void close()

Description copied from interface: OperationQuota

Cleanup method on operation completion

Specified by:

close in interface OperationQuota

getReadAvailable

public long getReadAvailable()

Specified by:

getReadAvailable in interface OperationQuota

Returns:

the number of bytes available to read to avoid exceeding the quota

getWriteAvailable

public long getWriteAvailable()

Specified by:

getWriteAvailable in interface OperationQuota

Returns:

the number of bytes available to write to avoid exceeding the quota

addGetResult

public void addGetResult(Result result)

Description copied from interface: OperationQuota

Add a get result. This will be used to calculate the exact quota and have a better short-read average size for the next time.

Specified by:

addGetResult in interface OperationQuota

addScanResult

public void addScanResult(List<Result> results)

Description copied from interface: OperationQuota

Add a scan result. This will be used to calculate the exact quota and have a better long-read average size for the next time.

Specified by:

addScanResult in interface OperationQuota

addMutation

public void addMutation(Mutation mutation)

Description copied from interface: OperationQuota

Add a mutation result. This will be used to calculate the exact quota and have a better mutation average size for the next time.

Specified by:

addMutation in interface OperationQuota

updateEstimateConsumeQuota

protected void updateEstimateConsumeQuota(int numWrites,
                                          int numReads,
                                          int numScans)

Update estimate quota(read/write size/capacityUnits) which will be consumed

Parameters:

numWrites - the number of write requests

numReads - the number of read requests

numScans - the number of scan requests

estimateConsume

private long estimateConsume(OperationQuota.OperationType type,
                             int numReqs,
                             long avgSize)

calculateWriteCapacityUnit

private long calculateWriteCapacityUnit(long size)

calculateReadCapacityUnit

private long calculateReadCapacityUnit(long size)

calculateWriteCapacityUnitDiff

private long calculateWriteCapacityUnitDiff(long actualSize,
                                            long estimateSize)

calculateReadCapacityUnitDiff

private long calculateReadCapacityUnitDiff(long actualSize,
                                           long estimateSize)