org.apache.hadoop.hbase.tool

Class Canary

java.lang.Object

org.apache.hadoop.hbase.tool.Canary

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@InterfaceAudience.Private
public final class Canary
extends Object
implements org.apache.hadoop.util.Tool

HBase Canary Tool, that that can be used to do "canary monitoring" of a running HBase cluster. Here are three modes 1. region mode - Foreach region tries to get one row per column family and outputs some information about failure or latency. 2. regionserver mode - Foreach regionserver tries to get one row from one table selected randomly and outputs some information about failure or latency. 3. zookeeper mode - for each zookeeper instance, selects a zNode and outputs some information about failure or latency.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Canary.Monitor
static class	Canary.RegionServerStdOutSink
static class	Canary.RegionStdOutSink
static interface	Canary.Sink
static class	Canary.StdOutSink
static class	Canary.ZookeeperStdOutSink

Field Summary

Fields

Modifier and Type	Field and Description
static TableName	DEFAULT_WRITE_TABLE_NAME

Constructor Summary

Constructors

Constructor and Description
Canary()
Canary(ExecutorService executor, Canary.Sink sink)

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.conf.Configuration	getConf()
Map<String,String>	getReadFailures()
Map<String,String>	getWriteFailures()
static void	main(String[] args)
Canary.Monitor	newMonitor(Connection connection, int index, String[] args) A Factory method for Canary.Monitor.
int	run(String[] args)
void	setConf(org.apache.hadoop.conf.Configuration conf)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WRITE_TABLE_NAME

public static final TableName DEFAULT_WRITE_TABLE_NAME

Constructor Detail

Canary

public Canary()

Canary

public Canary(ExecutorService executor,
              Canary.Sink sink)

Method Detail

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

run

public int run(String[] args)
        throws Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

Exception

getReadFailures

public Map<String,String> getReadFailures()

getWriteFailures

public Map<String,String> getWriteFailures()

newMonitor

public Canary.Monitor newMonitor(Connection connection,
                                 int index,
                                 String[] args)

A Factory method for Canary.Monitor. Can be overridden by user.

Parameters:

index - a start index for monitor target

args - args passed from user

Returns:

a Monitor instance

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception