org.apache.hadoop.hbase.coprocessor.example

Class ExampleRegionObserverWithMetrics.ExampleRegionObserver

java.lang.Object

org.apache.hadoop.hbase.coprocessor.example.ExampleRegionObserverWithMetrics.ExampleRegionObserver

All Implemented Interfaces:

Coprocessor, RegionCoprocessor, RegionObserver

Enclosing class:

ExampleRegionObserverWithMetrics

class ExampleRegionObserverWithMetrics.ExampleRegionObserver
extends Object
implements RegionCoprocessor, RegionObserver

Nested Class Summary

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

Coprocessor.State

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.coprocessor.RegionObserver

RegionObserver.MutationType

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
ExampleRegionObserver()

Method Summary

Modifier and Type	Method and Description
Optional<RegionObserver>	getRegionObserver()
private void	performCostlyOperation()
void	postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store, List<? extends StoreFile> selected, CompactionLifeCycleTracker tracker, CompactionRequest request) Called after the StoreFiles to compact have been selected from the available candidates.
void	postFlush(ObserverContext<RegionCoprocessorEnvironment> c, FlushLifeCycleTracker tracker) Called after the memstore is flushed to disk.
void	postFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store, StoreFile resultFile, FlushLifeCycleTracker tracker) Called after a Store's memstore is flushed to disk.
void	postGetOp(ObserverContext<RegionCoprocessorEnvironment> e, Get get, List<Cell> results) Called after the client performs a Get
void	preGetOp(ObserverContext<RegionCoprocessorEnvironment> e, Get get, List<Cell> results) Called before the client performs a Get

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.RegionCoprocessor

getBulkLoadObserver, getEndpointObserver

Methods inherited from interface org.apache.hadoop.hbase.Coprocessor

getServices, start, stop

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.RegionObserver

postAppend, postAppendBeforeWAL, postBatchMutate, postBatchMutateIndispensably, postBulkLoadHFile, postCheckAndDelete, postCheckAndDelete, postCheckAndPut, postCheckAndPut, postClose, postCloseRegionOperation, postCommitStoreFile, postCompact, postDelete, postExists, postIncrement, postIncrementBeforeWAL, postInstantiateDeleteTracker, postMemStoreCompaction, postMutationBeforeWAL, postOpen, postPut, postReplayWALs, postScannerClose, postScannerFilterRow, postScannerNext, postScannerOpen, postStartRegionOperation, postStoreFileReaderOpen, postWALRestore, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndDeleteAfterRowLock, preCheckAndPut, preCheckAndPut, preCheckAndPutAfterRowLock, preCheckAndPutAfterRowLock, preClose, preCommitStoreFile, preCompact, preCompactScannerOpen, preCompactSelection, preDelete, preExists, preFlush, preFlush, preFlushScannerOpen, preIncrement, preIncrementAfterRowLock, preMemStoreCompaction, preMemStoreCompactionCompact, preMemStoreCompactionCompactScannerOpen, preOpen, prePrepareTimeStampForDeleteVersion, prePut, preReplayWALs, preScannerClose, preScannerNext, preScannerOpen, preStoreFileReaderOpen, preStoreScannerOpen, preWALAppend, preWALRestore

Constructor Detail

ExampleRegionObserver

ExampleRegionObserver()

Method Detail

getRegionObserver

public Optional<RegionObserver> getRegionObserver()

Specified by:

getRegionObserver in interface RegionCoprocessor

preGetOp

public void preGetOp(ObserverContext<RegionCoprocessorEnvironment> e,
                     Get get,
                     List<Cell> results)
              throws IOException

Description copied from interface: RegionObserver

Called before the client performs a Get

Call CoprocessorEnvironment#bypass to skip default actions. If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.

Specified by:

preGetOp in interface RegionObserver

Parameters:

e - the environment provided by the region server

get - the Get request

results - The result to return to the client if default processing is bypassed. Can be modified. Will not be used if default processing is not bypassed.

Throws:

IOException

postGetOp

public void postGetOp(ObserverContext<RegionCoprocessorEnvironment> e,
                      Get get,
                      List<Cell> results)
               throws IOException

Description copied from interface: RegionObserver

Called after the client performs a Get

Note: Do not retain references to any Cells in 'result' beyond the life of this invocation. If need a Cell reference for later use, copy the cell and use that.

Specified by:

postGetOp in interface RegionObserver

Parameters:

e - the environment provided by the region server

get - the Get request

results - the result to return to the client, modify as necessary

Throws:

IOException

postFlush

public void postFlush(ObserverContext<RegionCoprocessorEnvironment> c,
                      FlushLifeCycleTracker tracker)
               throws IOException

Description copied from interface: RegionObserver

Called after the memstore is flushed to disk.

Specified by:

postFlush in interface RegionObserver

Parameters:

c - the environment provided by the region server

tracker - tracker used to track the life cycle of a flush

Throws:

IOException - if an error occurred on the coprocessor

postFlush

public void postFlush(ObserverContext<RegionCoprocessorEnvironment> c,
                      Store store,
                      StoreFile resultFile,
                      FlushLifeCycleTracker tracker)
               throws IOException

Description copied from interface: RegionObserver

Called after a Store's memstore is flushed to disk.

Specified by:

postFlush in interface RegionObserver

Parameters:

c - the environment provided by the region server

store - the store being flushed

resultFile - the new store file written out during compaction

tracker - tracker used to track the life cycle of a flush

Throws:

IOException

postCompactSelection

public void postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c,
                                 Store store,
                                 List<? extends StoreFile> selected,
                                 CompactionLifeCycleTracker tracker,
                                 CompactionRequest request)

Description copied from interface: RegionObserver

Called after the StoreFiles to compact have been selected from the available candidates.

Specified by:

postCompactSelection in interface RegionObserver

Parameters:

c - the environment provided by the region server

store - the store being compacted

selected - the store files selected to compact

tracker - tracker used to track the life cycle of a compaction

request - the requested compaction

performCostlyOperation

private void performCostlyOperation()