PressureAwareCompactionThroughputController (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.conf.Configured
- - org.apache.hadoop.hbase.regionserver.compactions.PressureAwareCompactionThroughputController

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, CompactionThroughputController, Stoppable
```
@InterfaceAudience.LimitedPrivate(value="Configuration")
public class PressureAwareCompactionThroughputController
extends org.apache.hadoop.conf.Configured
implements CompactionThroughputController, Stoppable
```
A throughput controller which uses the follow schema to limit throughput
- If compaction pressure is greater than 1.0, no limitation.
- In off peak hours, use a fixed throughput limitation "hbase.hstore.compaction.throughput.offpeak"
- In normal hours, the max throughput is tune between "hbase.hstore.compaction.throughput.lower.bound" and "hbase.hstore.compaction.throughput.higher.bound", using the formula "lower + (higer - lower) * compactionPressure", where compactionPressure is in range [0.0, 1.0]
See Also:
Store.getCompactionPressure()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class PressureAwareCompactionThroughputController.ActiveCompaction
Stores the information of one controlled compaction.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`PressureAwareCompactionThroughputController.ActiveCompaction` Stores the information of one controlled compaction.

Field Summary

Fields
Modifier and Type	Field and Description
`private ConcurrentMap<String,PressureAwareCompactionThroughputController.ActiveCompaction>`	`activeCompactions`
`private long`	`controlPerSize`
`private static long`	`DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND`
`private static long`	`DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND`
`private static long`	`DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK`
`private static int`	`DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD`
`static String`	`HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND`
`static String`	`HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND`
`static String`	`HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK`
`static String`	`HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD`
`private static org.apache.commons.logging.Log`	`LOG`
`(package private) double`	`maxThroughput`
`private long`	`maxThroughputHigherBound`
`private long`	`maxThroughputLowerBound`
`private long`	`maxThroughputOffpeak`
`private OffPeakHours`	`offPeakHours`
`private boolean`	`stopped`
`private int`	`tuningPeriod`

Constructor Summary

Constructors
Constructor and Description

PressureAwareCompactionThroughputController()

Constructors
Constructor and Description
`PressureAwareCompactionThroughputController()`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`control(String compactionName, long size)` Control the compaction throughput.
`void`	`finish(String compactionName)` Finish a compaction.
`boolean`	`isStopped()`
`void`	`setConf(org.apache.hadoop.conf.Configuration conf)`
`void`	`setup(RegionServerServices server)` Setup controller for the given region server.
`void`	`start(String compactionName)` Start a compaction.
`void`	`stop(String why)` Stop this service.
`private String`	`throughputDesc(double speed)`
`private String`	`throughputDesc(long deltaSize, long elapsedTime)`
`String`	`toString()`
`private void`	`tune(double compactionPressure)`

Methods inherited from class org.apache.hadoop.conf.Configured
getConf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND
```
public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND
```
    See Also:
    Constant Field Values
  - DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND
```
private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND
```
    See Also:
    Constant Field Values
  - HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND
```
public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND
```
    See Also:
    Constant Field Values
  - DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND
```
private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND
```
    See Also:
    Constant Field Values
  - HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK
```
public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK
```
    See Also:
    Constant Field Values
  - DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK
```
private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK
```
    See Also:
    Constant Field Values
  - HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD
```
public static final String HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD
```
    See Also:
    Constant Field Values
  - DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD
```
private static final int DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD
```
    See Also:
    Constant Field Values
  - maxThroughputHigherBound
```
private long maxThroughputHigherBound
```
  - maxThroughputLowerBound
```
private long maxThroughputLowerBound
```
  - maxThroughputOffpeak
```
private long maxThroughputOffpeak
```
  - offPeakHours
```
private OffPeakHours offPeakHours
```
  - controlPerSize
```
private long controlPerSize
```
  - tuningPeriod
```
private int tuningPeriod
```
  - maxThroughput
```
volatile double maxThroughput
```
  - activeCompactions
```
private final ConcurrentMap<String,PressureAwareCompactionThroughputController.ActiveCompaction> activeCompactions
```
  - stopped
```
private volatile boolean stopped
```
- Constructor Detail
  - PressureAwareCompactionThroughputController
```
public PressureAwareCompactionThroughputController()
```
- Method Detail
  - setup
```
public void setup(RegionServerServices server)
```
    Description copied from interface: CompactionThroughputController
    
    Setup controller for the given region server.
    
    Specified by:
    
    setup in interface CompactionThroughputController
  - tune
```
private void tune(double compactionPressure)
```
  - setConf
```
public void setConf(org.apache.hadoop.conf.Configuration conf)
```
    Specified by:
    
    setConf in interface org.apache.hadoop.conf.Configurable
    
    Overrides:
    
    setConf in class org.apache.hadoop.conf.Configured
  - throughputDesc
```
private String throughputDesc(long deltaSize,
                    long elapsedTime)
```
  - throughputDesc
```
private String throughputDesc(double speed)
```
  - start
```
public void start(String compactionName)
```
    Description copied from interface: CompactionThroughputController
    
    Start a compaction.
    
    Specified by:
    
    start in interface CompactionThroughputController
  - control
```
public long control(String compactionName,
           long size)
             throws InterruptedException
```
    Description copied from interface: CompactionThroughputController
    
    Control the compaction throughput. Will sleep if too fast.
    
    Specified by:
    
    control in interface CompactionThroughputController
    
    Returns:
    the actual sleep time.
    
    Throws:
    
    InterruptedException
  - finish
```
public void finish(String compactionName)
```
    Description copied from interface: CompactionThroughputController
    
    Finish a compaction. Should call this method in a finally block.
    
    Specified by:
    
    finish in interface CompactionThroughputController
  - stop
```
public void stop(String why)
```
    Description copied from interface: Stoppable
    
    Stop this service.
    
    Specified by:
    
    stop in interface Stoppable
    
    Parameters:
    why - Why we're stopping.
  - isStopped
```
public boolean isStopped()
```
    Specified by:
    
    isStopped in interface Stoppable
    
    Returns:
    True if Stoppable.stop(String) has been closed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PressureAwareCompactionThroughputController

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.conf.Configured

Methods inherited from class java.lang.Object

Field Detail

LOG

HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND

DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND

HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND

DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND

HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK

DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK

HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD

DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD

maxThroughputHigherBound

maxThroughputLowerBound

maxThroughputOffpeak

offPeakHours

controlPerSize

tuningPeriod

maxThroughput

activeCompactions

stopped

Constructor Detail

PressureAwareCompactionThroughputController

Method Detail

setup

tune

setConf

throughputDesc

throughputDesc

start

control

finish

stop

isStopped

toString