org.apache.hadoop.hbase.coprocessor.example

Class ExampleRegionObserverWithMetrics

java.lang.Object

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

All Implemented Interfaces:

Coprocessor, RegionCoprocessor

@InterfaceAudience.Private
public class ExampleRegionObserverWithMetrics
extends Object
implements RegionCoprocessor

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 regionserver page, something like http://myregionserverhost:16030/jmx

See Also:

ExampleMasterObserverWithMetrics

Nested Class Summary

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

Coprocessor.State

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
ExampleRegionObserverWithMetrics()

Method Summary

Modifier and Type	Method and Description
Optional<RegionObserver>	getRegionObserver()
void	start(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.
void	stop(CoprocessorEnvironment e) Called by the CoprocessorEnvironment during it's own shutdown to stop 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.RegionCoprocessor

getBulkLoadObserver, getEndpointObserver

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

getServices

Constructor Detail

ExampleRegionObserverWithMetrics

public ExampleRegionObserverWithMetrics()

Method Detail

getRegionObserver

public Optional<RegionObserver> getRegionObserver()

Specified by:

getRegionObserver in interface RegionCoprocessor

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

stop

public void stop(CoprocessorEnvironment e)
          throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

Specified by:

stop in interface Coprocessor

Throws:

IOException