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
private static class	Canary.RegionMonitor A monitor for region mode.
private static class	Canary.RegionServerMonitor A monitor for regionserver mode
static class	Canary.RegionServerStdOutSink By RegionServer, for 'regionserver' mode.
(package private) static class	Canary.RegionServerTask Run a single RegionServer Task and then exit.
static class	Canary.RegionStdOutSink By Region, for 'region' mode.
(package private) static class	Canary.RegionTask Run a single Region Task and then exit.
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.
private static class	Canary.ZookeeperMonitor
static class	Canary.ZookeeperStdOutSink Output for 'zookeeper' mode.
(package private) static class	Canary.ZookeeperTask Run a single zookeeper Task and then exit.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CANARY_TABLE_FAMILY_NAME
private org.apache.hadoop.conf.Configuration	conf
private HashMap<String,Long>	configuredReadTableTimeouts This is a Map of table to timeout.
private long	configuredWriteTableTimeout
private static long	DEFAULT_INTERVAL
private static long	DEFAULT_TIMEOUT
static TableName	DEFAULT_WRITE_TABLE_NAME
private static int	ERROR_EXIT_CODE
private ExecutorService	executor
private boolean	failOnError
private static int	FAILURE_EXIT_CODE
private static int	INIT_ERROR_EXIT_CODE
private long	interval
private static org.slf4j.Logger	LOG
private static int	MAX_THREADS_NUM
private long	permittedFailures
private boolean	regionServerAllRegions
private boolean	regionServerMode True if we are to run in 'regionServer' mode.
private Canary.Sink	sink
private long	timeout
private static int	TIMEOUT_ERROR_EXIT_CODE
private boolean	treatFailureAsError
private static int	USAGE_EXIT_CODE
private boolean	useRegExp
private boolean	writeSniffing
private TableName	writeTableName
private boolean	zookeeperMode True if we are to run in zookeeper 'mode'.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.conf.Configuration	getConf()
Map<String,String>	getReadFailures()
(package private) Canary.Sink	getSink(org.apache.hadoop.conf.Configuration configuration, Class clazz)
Map<String,String>	getWriteFailures()
static void	main(String[] args)
Canary.Monitor	newMonitor(Connection connection, int index, String[] args) A Factory method for Canary.Monitor.
private int	parseArgs(String[] args)
private void	printUsageAndExit()
int	run(String[] args)
void	setConf(org.apache.hadoop.conf.Configuration conf)
private static List<Future<Void>>	sniff(Admin admin, Canary.Sink sink, String tableName, ExecutorService executor, Canary.RegionTask.TaskType taskType, boolean rawScanEnabled, LongAdder readLatency) Canary entry point for specified table.
private static List<Future<Void>>	sniff(Admin admin, Canary.Sink sink, TableDescriptor tableDesc, ExecutorService executor, Canary.RegionTask.TaskType taskType, boolean rawScanEnabled, LongAdder rwLatency)

Methods inherited from class java.lang.Object

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

Field Detail

USAGE_EXIT_CODE

private static final int USAGE_EXIT_CODE

See Also:

Constant Field Values

INIT_ERROR_EXIT_CODE

private static final int INIT_ERROR_EXIT_CODE

See Also:

Constant Field Values

TIMEOUT_ERROR_EXIT_CODE

private static final int TIMEOUT_ERROR_EXIT_CODE

See Also:

Constant Field Values

ERROR_EXIT_CODE

private static final int ERROR_EXIT_CODE

See Also:

Constant Field Values

FAILURE_EXIT_CODE

private static final int FAILURE_EXIT_CODE

See Also:

Constant Field Values

DEFAULT_INTERVAL

private static final long DEFAULT_INTERVAL

See Also:

Constant Field Values

DEFAULT_TIMEOUT

private static final long DEFAULT_TIMEOUT

See Also:

Constant Field Values

MAX_THREADS_NUM

private static final int MAX_THREADS_NUM

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

DEFAULT_WRITE_TABLE_NAME

public static final TableName DEFAULT_WRITE_TABLE_NAME

CANARY_TABLE_FAMILY_NAME

private static final String CANARY_TABLE_FAMILY_NAME

See Also:

Constant Field Values

conf

private org.apache.hadoop.conf.Configuration conf

interval

private long interval

sink

private Canary.Sink sink

useRegExp

private boolean useRegExp

timeout

private long timeout

failOnError

private boolean failOnError

regionServerMode

private boolean regionServerMode

True if we are to run in 'regionServer' mode.

zookeeperMode

private boolean zookeeperMode

True if we are to run in zookeeper 'mode'.

permittedFailures

private long permittedFailures

regionServerAllRegions

private boolean regionServerAllRegions

writeSniffing

private boolean writeSniffing

configuredWriteTableTimeout

private long configuredWriteTableTimeout

treatFailureAsError

private boolean treatFailureAsError

writeTableName

private TableName writeTableName

configuredReadTableTimeouts

private HashMap<String,Long> configuredReadTableTimeouts

This is a Map of table to timeout. The timeout is for reading all regions in the table; i.e. we aggregate time to fetch each region and it needs to be less than this value else we log an ERROR.

executor

private ExecutorService executor

Constructor Detail

Canary

public Canary()

Canary

public Canary(ExecutorService executor)

Canary

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

parseArgs

private int parseArgs(String[] args)

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

printUsageAndExit

private void printUsageAndExit()

getSink

Canary.Sink getSink(org.apache.hadoop.conf.Configuration configuration,
                    Class clazz)

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

sniff

private static List<Future<Void>> sniff(Admin admin,
                                        Canary.Sink sink,
                                        String tableName,
                                        ExecutorService executor,
                                        Canary.RegionTask.TaskType taskType,
                                        boolean rawScanEnabled,
                                        LongAdder readLatency)
                                 throws Exception

Canary entry point for specified table.

Throws:

Exception

sniff

private static List<Future<Void>> sniff(Admin admin,
                                        Canary.Sink sink,
                                        TableDescriptor tableDesc,
                                        ExecutorService executor,
                                        Canary.RegionTask.TaskType taskType,
                                        boolean rawScanEnabled,
                                        LongAdder rwLatency)
                                 throws Exception

Throws:

Exception

main

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

Throws:

Exception