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 for "canary monitoring" of a running HBase cluster. There are three modes:

1. region mode (Default): For each region, try to get one row per column family outputting information on failure (ERROR) or else the latency.
2. regionserver mode: For each regionserver try to get one row from one table selected randomly outputting information on failure (ERROR) or else the latency.
3. zookeeper mode: for each zookeeper instance, selects a znode outputting information on failure (ERROR) or else the latency.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Canary.Monitor A Monitor super-class can be extended by users
static class	Canary.RegionServerStdOutSink By RegionServer, for 'regionserver' mode.
static class	Canary.RegionStdOutSink By Region, for 'region' mode.
static interface	Canary.Sink Sink interface used by the canary to output information
static class	Canary.StdOutSink Simple implementation of canary sink that allows plotting to a file or standard output.
static class	Canary.ZookeeperStdOutSink Output for 'zookeeper' mode.

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)

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)

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. Makes a RegionServerMonitor, or a ZooKeeperMonitor, or a RegionMonitor.

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