org.apache.hadoop.hbase.quotas

Class RegionServerSpaceQuotaManager

java.lang.Object

org.apache.hadoop.hbase.quotas.RegionServerSpaceQuotaManager

@InterfaceAudience.Private
public class RegionServerSpaceQuotaManager
extends Object

A manager for filesystem space quotas in the RegionServer. This class is the centralized point for what a RegionServer knows about space quotas on tables. For each table, it tracks two different things: the SpaceQuotaSnapshot and a SpaceViolationPolicyEnforcement (which may be null when a quota is not being violated). Both of these are sensitive on when they were last updated. The {link SpaceQutoaViolationPolicyRefresherChore} periodically runs and updates the state on this.

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicReference<Map<TableName,SpaceQuotaSnapshot>>	currentQuotaSnapshots
private ConcurrentHashMap<TableName,SpaceViolationPolicyEnforcement>	enforcedPolicies
private SpaceViolationPolicyEnforcementFactory	factory
private static org.slf4j.Logger	LOG
private RegionSizeReportingChore	regionSizeReporter
private RegionSizeStore	regionSizeStore
private RegionServerServices	rsServices
private SpaceQuotaRefresherChore	spaceQuotaRefresher
private boolean	started

Constructor Summary

Constructors

Constructor and Description
RegionServerSpaceQuotaManager(RegionServerServices rsServices)
RegionServerSpaceQuotaManager(RegionServerServices rsServices, SpaceViolationPolicyEnforcementFactory factory)

Method Summary

Modifier and Type	Method and Description
boolean	areCompactionsDisabled(TableName tableName) Returns whether or not compactions should be disabled for the given tableName per a space quota violation policy.
org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.FileArchiveNotificationRequest	buildFileArchiveRequest(TableName tn, Collection<Map.Entry<String,Long>> archivedFiles) Builds the protobuf message to inform the Master of files being archived.
(package private) Map<TableName,SpaceViolationPolicyEnforcement>	copyActiveEnforcements() Returns the collection of tables which have quota violation policies enforced on this RegionServer.
Map<TableName,SpaceQuotaSnapshot>	copyQuotaSnapshots() Copies the last SpaceQuotaSnapshots that were recorded.
void	disableViolationPolicyEnforcement(TableName tableName) Disables enforcement on any violation policy on the given tableName.
void	enforceViolationPolicy(TableName tableName, SpaceQuotaSnapshot snapshot) Enforces the given violationPolicy on the given table in this RegionServer.
ActivePolicyEnforcement	getActiveEnforcements() Creates an object well-suited for the RegionServer to use in verifying active policies.
Map<TableName,SpaceQuotaSnapshot>	getActivePoliciesAsMap() Converts a map of table to SpaceViolationPolicyEnforcements into SpaceViolationPolicys.
(package private) Connection	getConnection()
(package private) SpaceViolationPolicyEnforcementFactory	getFactory()
(package private) RegionServerServices	getRegionServerServices()
RegionSizeStore	getRegionSizeStore() Returns the RegionSizeStore tracking filesystem utilization by each region.
boolean	isStarted() Returns if the Chore has been started.
void	start()
void	stop()
void	updateQuotaSnapshot(Map<TableName,SpaceQuotaSnapshot> newSnapshots) Updates the current SpaceQuotaSnapshots for the RegionServer.

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

rsServices

private final RegionServerServices rsServices

spaceQuotaRefresher

private SpaceQuotaRefresherChore spaceQuotaRefresher

currentQuotaSnapshots

private AtomicReference<Map<TableName,SpaceQuotaSnapshot>> currentQuotaSnapshots

started

private boolean started

enforcedPolicies

private final ConcurrentHashMap<TableName,SpaceViolationPolicyEnforcement> enforcedPolicies

factory

private SpaceViolationPolicyEnforcementFactory factory

regionSizeStore

private RegionSizeStore regionSizeStore

regionSizeReporter

private RegionSizeReportingChore regionSizeReporter

Constructor Detail

RegionServerSpaceQuotaManager

public RegionServerSpaceQuotaManager(RegionServerServices rsServices)

RegionServerSpaceQuotaManager

RegionServerSpaceQuotaManager(RegionServerServices rsServices,
                              SpaceViolationPolicyEnforcementFactory factory)

Method Detail

start

public void start()
           throws IOException

Throws:

IOException

stop

public void stop()

isStarted

public boolean isStarted()

Returns if the Chore has been started.

copyQuotaSnapshots

public Map<TableName,SpaceQuotaSnapshot> copyQuotaSnapshots()

Copies the last SpaceQuotaSnapshots that were recorded. The current view of what the RegionServer thinks the table's utilization is.

updateQuotaSnapshot

public void updateQuotaSnapshot(Map<TableName,SpaceQuotaSnapshot> newSnapshots)

Updates the current SpaceQuotaSnapshots for the RegionServer.

Parameters:

newSnapshots - The space quota snapshots.

getActiveEnforcements

public ActivePolicyEnforcement getActiveEnforcements()

Creates an object well-suited for the RegionServer to use in verifying active policies.

getActivePoliciesAsMap

public Map<TableName,SpaceQuotaSnapshot> getActivePoliciesAsMap()

Converts a map of table to SpaceViolationPolicyEnforcements into SpaceViolationPolicys.

enforceViolationPolicy

public void enforceViolationPolicy(TableName tableName,
                                   SpaceQuotaSnapshot snapshot)

Enforces the given violationPolicy on the given table in this RegionServer.

disableViolationPolicyEnforcement

public void disableViolationPolicyEnforcement(TableName tableName)

Disables enforcement on any violation policy on the given tableName.

areCompactionsDisabled

public boolean areCompactionsDisabled(TableName tableName)

Returns whether or not compactions should be disabled for the given tableName per a space quota violation policy. A convenience method.

Parameters:

tableName - The table to check

Returns:

True if compactions should be disabled for the table, false otherwise.

getRegionSizeStore

public RegionSizeStore getRegionSizeStore()

Returns the RegionSizeStore tracking filesystem utilization by each region.

Returns:

A RegionSizeStore implementation.

buildFileArchiveRequest

public org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.FileArchiveNotificationRequest buildFileArchiveRequest(TableName tn,
                                                                                                                                         Collection<Map.Entry<String,Long>> archivedFiles)

Builds the protobuf message to inform the Master of files being archived.

Parameters:

tn - The table the files previously belonged to.

archivedFiles - The files and their size in bytes that were archived.

Returns:

The protobuf representation

copyActiveEnforcements

Map<TableName,SpaceViolationPolicyEnforcement> copyActiveEnforcements()

Returns the collection of tables which have quota violation policies enforced on this RegionServer.

getRegionServerServices

RegionServerServices getRegionServerServices()

getConnection

Connection getConnection()

getFactory

SpaceViolationPolicyEnforcementFactory getFactory()