org.apache.hadoop.hbase.quotas

Class SpaceQuotaRefresherChore

java.lang.Object

org.apache.hadoop.hbase.ScheduledChore

org.apache.hadoop.hbase.quotas.SpaceQuotaRefresherChore

All Implemented Interfaces:

Runnable

@InterfaceAudience.Private
public class SpaceQuotaRefresherChore
extends ScheduledChore

A ScheduledChore which periodically updates the RegionServerSpaceQuotaManager with information from the hbase:quota.

Field Summary

Fields

Modifier and Type	Field and Description
private Connection	conn
private static org.slf4j.Logger	LOG
private RegionServerSpaceQuotaManager	manager
(package private) static long	POLICY_REFRESHER_CHORE_DELAY_DEFAULT
(package private) static String	POLICY_REFRESHER_CHORE_DELAY_KEY
(package private) static int	POLICY_REFRESHER_CHORE_PERIOD_DEFAULT
(package private) static String	POLICY_REFRESHER_CHORE_PERIOD_KEY
(package private) static double	POLICY_REFRESHER_CHORE_REPORT_PERCENT_DEFAULT
(package private) static String	POLICY_REFRESHER_CHORE_REPORT_PERCENT_KEY
(package private) static String	POLICY_REFRESHER_CHORE_TIMEUNIT_DEFAULT
(package private) static String	POLICY_REFRESHER_CHORE_TIMEUNIT_KEY
private boolean	quotaTablePresent

Constructor Summary

Constructors

Constructor and Description
SpaceQuotaRefresherChore(RegionServerSpaceQuotaManager manager, Connection conn)

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkQuotaTableExists() Checks if hbase:quota exists in hbase:meta
protected void	chore() The task to execute on each scheduled execution of the Chore
(package private) void	extractQuotaSnapshot(Result result, Map<TableName,SpaceQuotaSnapshot> snapshots) Wrapper around QuotaTableUtil.extractQuotaSnapshot(Result, Map) for testing.
Map<TableName,SpaceQuotaSnapshot>	fetchSnapshotsFromQuotaTable() Reads all quota snapshots from the quota table.
(package private) Connection	getConnection()
(package private) static long	getInitialDelay(org.apache.hadoop.conf.Configuration conf) Extracts the initial delay for the chore from the configuration.
(package private) RegionServerSpaceQuotaManager	getManager()
(package private) static int	getPeriod(org.apache.hadoop.conf.Configuration conf) Extracts the period for the chore from the configuration.
(package private) static Double	getRegionReportPercent(org.apache.hadoop.conf.Configuration conf) Extracts the percent of Regions for a table to have been reported to enable quota violation state change.
(package private) static TimeUnit	getTimeUnit(org.apache.hadoop.conf.Configuration conf) Extracts the time unit for the chore period and initial delay from the configuration.
(package private) boolean	isInViolation(SpaceQuotaSnapshot snapshot) Checks if the given snapshot is in violation, allowing the snapshot to be null.

Methods inherited from class org.apache.hadoop.hbase.ScheduledChore

cancel, cancel, choreForTesting, cleanup, getInitialDelay, getName, getPeriod, getStopper, getTimeUnit, initialChore, isInitialChoreComplete, isScheduled, run, shutdown, shutdown, toString, triggerNow

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

POLICY_REFRESHER_CHORE_PERIOD_KEY

static final String POLICY_REFRESHER_CHORE_PERIOD_KEY

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_PERIOD_DEFAULT

static final int POLICY_REFRESHER_CHORE_PERIOD_DEFAULT

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_DELAY_KEY

static final String POLICY_REFRESHER_CHORE_DELAY_KEY

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_DELAY_DEFAULT

static final long POLICY_REFRESHER_CHORE_DELAY_DEFAULT

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_TIMEUNIT_KEY

static final String POLICY_REFRESHER_CHORE_TIMEUNIT_KEY

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_TIMEUNIT_DEFAULT

static final String POLICY_REFRESHER_CHORE_TIMEUNIT_DEFAULT

POLICY_REFRESHER_CHORE_REPORT_PERCENT_KEY

static final String POLICY_REFRESHER_CHORE_REPORT_PERCENT_KEY

See Also:

Constant Field Values

POLICY_REFRESHER_CHORE_REPORT_PERCENT_DEFAULT

static final double POLICY_REFRESHER_CHORE_REPORT_PERCENT_DEFAULT

See Also:

Constant Field Values

manager

private final RegionServerSpaceQuotaManager manager

conn

private final Connection conn

quotaTablePresent

private boolean quotaTablePresent

Constructor Detail

SpaceQuotaRefresherChore

public SpaceQuotaRefresherChore(RegionServerSpaceQuotaManager manager,
                                Connection conn)

Method Detail

chore

protected void chore()

Description copied from class: ScheduledChore

The task to execute on each scheduled execution of the Chore

Specified by:

chore in class ScheduledChore

checkQuotaTableExists

boolean checkQuotaTableExists()
                       throws IOException

Checks if hbase:quota exists in hbase:meta

Returns:

true if hbase:quota table is in meta, else returns false.

Throws:

IOException - throws IOException

isInViolation

boolean isInViolation(SpaceQuotaSnapshot snapshot)

Checks if the given snapshot is in violation, allowing the snapshot to be null. If the snapshot is null, this is interpreted as no snapshot which implies not in violation.

Parameters:

snapshot - The snapshot to operate on.

Returns:

true if the snapshot is in violation, false otherwise.

fetchSnapshotsFromQuotaTable

public Map<TableName,SpaceQuotaSnapshot> fetchSnapshotsFromQuotaTable()
                                                               throws IOException

Reads all quota snapshots from the quota table.

Returns:

The current "view" of space use by each table.

Throws:

IOException

extractQuotaSnapshot

void extractQuotaSnapshot(Result result,
                          Map<TableName,SpaceQuotaSnapshot> snapshots)

Wrapper around QuotaTableUtil.extractQuotaSnapshot(Result, Map) for testing.

getConnection

Connection getConnection()

getManager

RegionServerSpaceQuotaManager getManager()

getPeriod

static int getPeriod(org.apache.hadoop.conf.Configuration conf)

Extracts the period for the chore from the configuration.

Parameters:

conf - The configuration object.

Returns:

The configured chore period or the default value.

getInitialDelay

static long getInitialDelay(org.apache.hadoop.conf.Configuration conf)

Extracts the initial delay for the chore from the configuration.

Parameters:

conf - The configuration object.

Returns:

The configured chore initial delay or the default value.

getTimeUnit

static TimeUnit getTimeUnit(org.apache.hadoop.conf.Configuration conf)

Extracts the time unit for the chore period and initial delay from the configuration. The configuration value for POLICY_REFRESHER_CHORE_TIMEUNIT_KEY must correspond to a TimeUnit value.

Parameters:

conf - The configuration object.

Returns:

The configured time unit for the chore period and initial delay or the default value.

getRegionReportPercent

static Double getRegionReportPercent(org.apache.hadoop.conf.Configuration conf)

Extracts the percent of Regions for a table to have been reported to enable quota violation state change.

Parameters:

conf - The configuration object.

Returns:

The percent of regions reported to use.