org.apache.hadoop.hbase.coprocessor.example

Class ExampleMasterObserverWithMetrics

java.lang.Object

org.apache.hadoop.hbase.coprocessor.example.ExampleMasterObserverWithMetrics

All Implemented Interfaces:

Coprocessor, MasterCoprocessor, MasterObserver

@InterfaceAudience.Private
public class ExampleMasterObserverWithMetrics
extends Object
implements MasterCoprocessor, MasterObserver

An example coprocessor that collects some metrics to demonstrate the usage of exporting custom metrics from the coprocessor.

These metrics will be available through the regular Hadoop metrics2 sinks (ganglia, opentsdb, etc) as well as JMX output. You can view a snapshot of the metrics by going to the http web UI of the master page, something like http://mymasterhost:16010/jmx

See Also:

ExampleRegionObserverWithMetrics

Nested Class Summary

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

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field and Description
private long	createTableStartTime
private Timer	createTableTimer This is the Timer metric object to keep track of the current count across invocations
private Counter	disableTableCounter This is a Counter object to keep track of disableTable operations
private static org.slf4j.Logger	LOG

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
ExampleMasterObserverWithMetrics()

Method Summary

Modifier and Type	Method and Description
Optional<MasterObserver>	getMasterObserver()
private long	getMaxMemory() Returns the max memory of the process.
private long	getTotalMemory() Returns the total memory of the process.
void	postCreateTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc, RegionInfo[] regions) Called after the createTable operation has been requested.
void	preCreateTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableDescriptor desc, RegionInfo[] regions) Called before a new table is created by HMaster.
void	preDisableTable(ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName) Called prior to disabling a table.
void	start(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.

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

getServices, stop

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

postAbortProcedure, postAddReplicationPeer, postAddRSGroup, postAssign, postBalance, postBalanceRSGroup, postBalanceSwitch, postClearDeadServers, postCloneSnapshot, postCompletedCreateTableAction, postCompletedDeleteTableAction, postCompletedDisableTableAction, postCompletedEnableTableAction, postCompletedMergeRegionsAction, postCompletedModifyTableAction, postCompletedModifyTableAction, postCompletedSplitRegionAction, postCompletedTruncateTableAction, postCreateNamespace, postDecommissionRegionServers, postDeleteNamespace, postDeleteSnapshot, postDeleteTable, postDisableReplicationPeer, postDisableTable, postEnableReplicationPeer, postEnableTable, postGetClusterMetrics, postGetLocks, postGetNamespaceDescriptor, postGetProcedures, postGetReplicationPeerConfig, postGetTableDescriptors, postGetTableNames, postListDecommissionedRegionServers, postListNamespaceDescriptors, postListReplicationPeers, postListSnapshot, postLockHeartbeat, postMergeRegions, postMergeRegionsCommitAction, postModifyNamespace, postModifyNamespace, postModifyTable, postModifyTable, postMove, postMoveServers, postMoveServersAndTables, postMoveTables, postRecommissionRegionServer, postRegionOffline, postRemoveReplicationPeer, postRemoveRSGroup, postRemoveServers, postRequestLock, postRestoreSnapshot, postRollBackMergeRegionsAction, postRollBackSplitRegionAction, postSetNamespaceQuota, postSetSplitOrMergeEnabled, postSetTableQuota, postSetUserQuota, postSetUserQuota, postSetUserQuota, postSnapshot, postStartMaster, postTableFlush, postTruncateTable, postUnassign, postUpdateReplicationPeerConfig, preAbortProcedure, preAddReplicationPeer, preAddRSGroup, preAssign, preBalance, preBalanceRSGroup, preBalanceSwitch, preClearDeadServers, preCloneSnapshot, preCreateNamespace, preCreateTableAction, preDecommissionRegionServers, preDeleteNamespace, preDeleteSnapshot, preDeleteTable, preDeleteTableAction, preDisableReplicationPeer, preDisableTableAction, preEnableReplicationPeer, preEnableTable, preEnableTableAction, preGetClusterMetrics, preGetLocks, preGetNamespaceDescriptor, preGetProcedures, preGetReplicationPeerConfig, preGetTableDescriptors, preGetTableNames, preListDecommissionedRegionServers, preListNamespaceDescriptors, preListReplicationPeers, preListSnapshot, preLockHeartbeat, preMasterInitialization, preMergeRegions, preMergeRegionsAction, preMergeRegionsCommitAction, preModifyNamespace, preModifyNamespace, preModifyTable, preModifyTable, preModifyTableAction, preModifyTableAction, preMove, preMoveServers, preMoveServersAndTables, preMoveTables, preRecommissionRegionServer, preRegionOffline, preRemoveReplicationPeer, preRemoveRSGroup, preRemoveServers, preRequestLock, preRestoreSnapshot, preSetNamespaceQuota, preSetSplitOrMergeEnabled, preSetTableQuota, preSetUserQuota, preSetUserQuota, preSetUserQuota, preShutdown, preSnapshot, preSplitRegion, preSplitRegionAction, preSplitRegionAfterMETAAction, preSplitRegionBeforeMETAAction, preStopMaster, preTableFlush, preTruncateTable, preTruncateTableAction, preUnassign, preUpdateReplicationPeerConfig

Field Detail

LOG

private static final org.slf4j.Logger LOG

createTableTimer

private Timer createTableTimer

This is the Timer metric object to keep track of the current count across invocations

createTableStartTime

private long createTableStartTime

disableTableCounter

private Counter disableTableCounter

This is a Counter object to keep track of disableTable operations

Constructor Detail

ExampleMasterObserverWithMetrics

public ExampleMasterObserverWithMetrics()

Method Detail

getMasterObserver

public Optional<MasterObserver> getMasterObserver()

Specified by:

getMasterObserver in interface MasterCoprocessor

getTotalMemory

private long getTotalMemory()

Returns the total memory of the process. We will use this to define a gauge metric

getMaxMemory

private long getMaxMemory()

Returns the max memory of the process. We will use this to define a gauge metric

preCreateTable

public void preCreateTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
                           TableDescriptor desc,
                           RegionInfo[] regions)
                    throws IOException

Description copied from interface: MasterObserver

Called before a new table is created by HMaster. Called as part of create table RPC call.

Specified by:

preCreateTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

desc - the TableDescriptor for the table

regions - the initial regions created for the table

Throws:

IOException

postCreateTable

public void postCreateTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
                            TableDescriptor desc,
                            RegionInfo[] regions)
                     throws IOException

Description copied from interface: MasterObserver

Called after the createTable operation has been requested. Called as part of create table RPC call.

Specified by:

postCreateTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

desc - the TableDescriptor for the table

regions - the initial regions created for the table

Throws:

IOException

preDisableTable

public void preDisableTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
                            TableName tableName)
                     throws IOException

Description copied from interface: MasterObserver

Called prior to disabling a table. Called as part of disable table RPC call.

Specified by:

preDisableTable in interface MasterObserver

Parameters:

ctx - the environment to interact with the framework and master

tableName - the name of the table

Throws:

IOException

start

public void start(CoprocessorEnvironment env)
           throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.

Specified by:

start in interface Coprocessor

Throws:

IOException