org.apache.hadoop.hbase.quotas

Class FileSystemUtilizationChore

java.lang.Object

org.apache.hadoop.hbase.ScheduledChore

org.apache.hadoop.hbase.quotas.FileSystemUtilizationChore

All Implemented Interfaces:

Runnable

@InterfaceAudience.Private
public class FileSystemUtilizationChore
extends ScheduledChore

A chore which computes the size of each HRegion on the FileSystem hosted by the given HRegionServer. The results of this computation are stored in the RegionServerSpaceQuotaManager's RegionSizeStore object.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static long	FS_UTILIZATION_CHORE_DELAY_DEFAULT
(package private) static String	FS_UTILIZATION_CHORE_DELAY_KEY
(package private) static int	FS_UTILIZATION_CHORE_PERIOD_DEFAULT
(package private) static String	FS_UTILIZATION_CHORE_PERIOD_KEY
(package private) static String	FS_UTILIZATION_CHORE_TIMEUNIT_DEFAULT
(package private) static String	FS_UTILIZATION_CHORE_TIMEUNIT_KEY
(package private) static long	FS_UTILIZATION_MAX_ITERATION_DURATION_DEFAULT
(package private) static String	FS_UTILIZATION_MAX_ITERATION_DURATION_KEY
private Iterator<Region>	leftoverRegions
private static org.slf4j.Logger	LOG
private long	maxIterationMillis
private HRegionServer	rs

Constructor Summary

Constructors

Constructor and Description
FileSystemUtilizationChore(HRegionServer rs)

Method Summary

Modifier and Type	Method and Description
protected void	chore() The task to execute on each scheduled execution of the Chore
(package private) long	computeSize(Region r) Computes total FileSystem size for the given Region.
(package private) static long	getInitialDelay(org.apache.hadoop.conf.Configuration conf) Extracts the initial delay for the chore from the configuration.
(package private) Iterator<Region>	getLeftoverRegions() Returns an Iterator over the Regions which were skipped last invocation of the chore.
(package private) static int	getPeriod(org.apache.hadoop.conf.Configuration conf) Extracts the period for the chore from the configuration.
(package private) RegionSizeStore	getRegionSizeStore()
(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) void	setLeftoverRegions(Iterator<Region> newLeftovers) Sets a new collection of Regions as leftovers.

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

cancel, cancel, choreForTesting, cleanup, getInitialDelay, getName, getPeriod, getStopper, getTimeUnit, initialChore, isInitialChoreComplete, isScheduled, run, 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

FS_UTILIZATION_CHORE_PERIOD_KEY

static final String FS_UTILIZATION_CHORE_PERIOD_KEY

See Also:

Constant Field Values

FS_UTILIZATION_CHORE_PERIOD_DEFAULT

static final int FS_UTILIZATION_CHORE_PERIOD_DEFAULT

See Also:

Constant Field Values

FS_UTILIZATION_CHORE_DELAY_KEY

static final String FS_UTILIZATION_CHORE_DELAY_KEY

See Also:

Constant Field Values

FS_UTILIZATION_CHORE_DELAY_DEFAULT

static final long FS_UTILIZATION_CHORE_DELAY_DEFAULT

See Also:

Constant Field Values

FS_UTILIZATION_CHORE_TIMEUNIT_KEY

static final String FS_UTILIZATION_CHORE_TIMEUNIT_KEY

See Also:

Constant Field Values

FS_UTILIZATION_CHORE_TIMEUNIT_DEFAULT

static final String FS_UTILIZATION_CHORE_TIMEUNIT_DEFAULT

FS_UTILIZATION_MAX_ITERATION_DURATION_KEY

static final String FS_UTILIZATION_MAX_ITERATION_DURATION_KEY

See Also:

Constant Field Values

FS_UTILIZATION_MAX_ITERATION_DURATION_DEFAULT

static final long FS_UTILIZATION_MAX_ITERATION_DURATION_DEFAULT

See Also:

Constant Field Values

rs

private final HRegionServer rs

maxIterationMillis

private final long maxIterationMillis

leftoverRegions

private Iterator<Region> leftoverRegions

Constructor Detail

FileSystemUtilizationChore

public FileSystemUtilizationChore(HRegionServer rs)

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

getLeftoverRegions

Iterator<Region> getLeftoverRegions()

Returns an Iterator over the Regions which were skipped last invocation of the chore.

Returns:

Regions from the previous invocation to process, or null.

setLeftoverRegions

void setLeftoverRegions(Iterator<Region> newLeftovers)

Sets a new collection of Regions as leftovers.

computeSize

long computeSize(Region r)

Computes total FileSystem size for the given Region.

Parameters:

r - The region

Returns:

The size, in bytes, of the Region.

getRegionSizeStore

RegionSizeStore getRegionSizeStore()

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 FS_UTILIZATION_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.