org.apache.hadoop.hbase.coprocessor

Class MetaTableMetrics.ExampleRegionObserverMeta

java.lang.Object

org.apache.hadoop.hbase.coprocessor.MetaTableMetrics.ExampleRegionObserverMeta

All Implemented Interfaces:

Coprocessor, RegionCoprocessor, RegionObserver

Enclosing class:

MetaTableMetrics

class MetaTableMetrics.ExampleRegionObserverMeta
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
ExampleRegionObserverMeta()

Method Summary

Modifier and Type	Method and Description
private void	clientMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e)
private String	clientRequestMeterName(String clientIP)
private String	getRegionIdFromOp(Row op) Get regionId from Ops such as: get, put, delete.
Optional<RegionObserver>	getRegionObserver()
private String	getTableNameFromOp(Row op) Get table name from Ops such as: get, put, delete.
private boolean	isMetaTableOp(ObserverContext<RegionCoprocessorEnvironment> e)
private void	markMeterIfPresent(String requestMeter)
private String	opMeterName(Object op)
private void	opMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e, Row op)
private String	opWithClientMeterName(Object op)
private void	opWithClientMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e, Object op)
void	preDelete(ObserverContext<RegionCoprocessorEnvironment> e, Delete delete, WALEdit edit, Durability durability) Called before the client deletes a value.
void	preGetOp(ObserverContext<RegionCoprocessorEnvironment> e, Get get, List<Cell> results) Called before the client performs a Get
void	prePut(ObserverContext<RegionCoprocessorEnvironment> e, Put put, WALEdit edit, Durability durability) Called before the client stores a value.
private String	regionMeterName(String regionId)
private void	regionMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e, Row op)
private void	registerLossyCountingMeterIfNotPresent(ObserverContext<RegionCoprocessorEnvironment> e, String requestMeter, LossyCounting lossyCounting) Registers and counts lossyCount for Meters that kept by lossy counting.
private void	registerMeterIfNotPresent(ObserverContext<RegionCoprocessorEnvironment> e, String requestMeter)
private String	tableMeterName(String tableName)
private void	tableMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e, Row op)

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, postBatchMutate, postBatchMutateIndispensably, postBulkLoadHFile, postCheckAndDelete, postCheckAndPut, postClose, postCloseRegionOperation, postCommitStoreFile, postCompact, postCompactSelection, postDelete, postExists, postFlush, postFlush, postGetOp, postIncrement, postInstantiateDeleteTracker, postMemStoreCompaction, postMutationBeforeWAL, postOpen, postPut, postReplayWALs, postScannerClose, postScannerFilterRow, postScannerNext, postScannerOpen, postStartRegionOperation, postStoreFileReaderOpen, postWALRestore, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndPut, preCheckAndPutAfterRowLock, preClose, preCommitStoreFile, preCompact, preCompactScannerOpen, preCompactSelection, preExists, preFlush, preFlush, preFlushScannerOpen, preIncrement, preIncrementAfterRowLock, preMemStoreCompaction, preMemStoreCompactionCompact, preMemStoreCompactionCompactScannerOpen, preOpen, prePrepareTimeStampForDeleteVersion, preReplayWALs, preScannerClose, preScannerNext, preScannerOpen, preStoreFileReaderOpen, preStoreScannerOpen, preWALRestore

Constructor Detail

ExampleRegionObserverMeta

ExampleRegionObserverMeta()

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

prePut

public void prePut(ObserverContext<RegionCoprocessorEnvironment> e,
                   Put put,
                   WALEdit edit,
                   Durability durability)
            throws IOException

Description copied from interface: RegionObserver

Called before the client stores a value.

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

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

Specified by:

prePut in interface RegionObserver

Parameters:

e - the environment provided by the region server

put - The Put object

edit - The WALEdit object that will be written to the wal

durability - Persistence guarantee for this Put

Throws:

IOException

preDelete

public void preDelete(ObserverContext<RegionCoprocessorEnvironment> e,
                      Delete delete,
                      WALEdit edit,
                      Durability durability)
               throws IOException

Description copied from interface: RegionObserver

Called before the client deletes a value.

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

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

Specified by:

preDelete in interface RegionObserver

Parameters:

e - the environment provided by the region server

delete - The Delete object

edit - The WALEdit object for the wal

durability - Persistence guarantee for this Delete

Throws:

IOException

markMeterIfPresent

private void markMeterIfPresent(String requestMeter)

registerMeterIfNotPresent

private void registerMeterIfNotPresent(ObserverContext<RegionCoprocessorEnvironment> e,
                                       String requestMeter)

registerLossyCountingMeterIfNotPresent

private void registerLossyCountingMeterIfNotPresent(ObserverContext<RegionCoprocessorEnvironment> e,
                                                    String requestMeter,
                                                    LossyCounting lossyCounting)

Registers and counts lossyCount for Meters that kept by lossy counting. By using lossy count to maintain meters, at most 7 / e meters will be kept (e is error rate) e.g. when e is 0.02 by default, at most 50 Clients request metrics will be kept also, all kept elements have frequency higher than e * N. (N is total count)

Parameters:

e - Region coprocessor environment

requestMeter - meter to be registered

lossyCounting - lossyCounting object for one type of meters.

getTableNameFromOp

private String getTableNameFromOp(Row op)

Get table name from Ops such as: get, put, delete.

Parameters:

op - such as get, put or delete.

getRegionIdFromOp

private String getRegionIdFromOp(Row op)

Get regionId from Ops such as: get, put, delete.

Parameters:

op - such as get, put or delete.

isMetaTableOp

private boolean isMetaTableOp(ObserverContext<RegionCoprocessorEnvironment> e)

clientMetricRegisterAndMark

private void clientMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e)

tableMetricRegisterAndMark

private void tableMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e,
                                        Row op)

regionMetricRegisterAndMark

private void regionMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e,
                                         Row op)

opMetricRegisterAndMark

private void opMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e,
                                     Row op)

opWithClientMetricRegisterAndMark

private void opWithClientMetricRegisterAndMark(ObserverContext<RegionCoprocessorEnvironment> e,
                                               Object op)

opWithClientMeterName

private String opWithClientMeterName(Object op)

opMeterName

private String opMeterName(Object op)

tableMeterName

private String tableMeterName(String tableName)

clientRequestMeterName

private String clientRequestMeterName(String clientIP)

regionMeterName

private String regionMeterName(String regionId)