Package org.apache.hadoop.hbase.coprocessor.example

Class ExampleRegionObserverWithMetrics

java.lang.Object

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

All Implemented Interfaces:

Coprocessor, RegionCoprocessor

@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

Modifier and Type	Class	Description
(package private) class	ExampleRegionObserverWithMetrics.ExampleRegionObserver

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

Coprocessor.State

Field Summary

Fields

Modifier and Type	Field	Description
private Timer	costlyOperationTimer
private Counter	filesCompactedCounter
private Counter	flushCounter
private ExampleRegionObserverWithMetrics.ExampleRegionObserver	observer
private Counter	preGetCounter

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor	Description
ExampleRegionObserverWithMetrics()

Method Summary

Modifier and Type	Method	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

getServices

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

getBulkLoadObserver, getEndpointObserver

Field Details

preGetCounter

private Counter preGetCounter

flushCounter

private Counter flushCounter

filesCompactedCounter

private Counter filesCompactedCounter

costlyOperationTimer

private Timer costlyOperationTimer

observer

private ExampleRegionObserverWithMetrics.ExampleRegionObserver observer

Constructor Details

ExampleRegionObserverWithMetrics

public ExampleRegionObserverWithMetrics()

Method Details

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