Canary (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.tool.Canary

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool
```
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 two 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Canary.ExtendedSink`
`static class`	`Canary.Monitor`
`private static class`	`Canary.RegionMonitor`
`private static class`	`Canary.RegionServerMonitor`
`static class`	`Canary.RegionServerStdOutSink`
`(package private) static class`	`Canary.RegionServerTask` Get one row from a region on the regionserver and outputs the latency, or the failure.
`(package private) static class`	`Canary.RegionTask` For each column family of the region tries to get one row and outputs the latency, or the failure.
`static interface`	`Canary.Sink`
`static class`	`Canary.StdOutSink`

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`CANARY_TABLE_FAMILY_NAME`
`private org.apache.hadoop.conf.Configuration`	`conf`
`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.apache.commons.logging.Log`	`LOG`
`private static int`	`MAX_THREADS_NUM`
`private boolean`	`regionServerAllRegions`
`private boolean`	`regionServerMode`
`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`

Constructor Summary

Constructors
Constructor and Description

Canary()

Canary(ExecutorService executor, Canary.Sink sink)

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

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.conf.Configuration`	`getConf()`
`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, HTableDescriptor tableDesc, ExecutorService executor, Canary.RegionTask.TaskType taskType)`
`private static List<Future<Void>>`	`sniff(Admin admin, Canary.Sink sink, String tableName, ExecutorService executor, Canary.RegionTask.TaskType taskType)` Canary entry point for specified table.
`static void`	`sniff(Admin admin, TableName tableName)` Canary entry point for specified table.
`static void`	`sniff(Admin admin, TableName tableName, Canary.RegionTask.TaskType taskType)` Canary entry point for specified table with task type(read/write)
`private static void`	`sniffRegion(Admin admin, Canary.Sink sink, HRegionInfo region, Table table)`

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.apache.commons.logging.Log 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
```

regionServerAllRegions
```
private boolean regionServerAllRegions
```

writeSniffing
```
private boolean writeSniffing
```

treatFailureAsError
```
private boolean treatFailureAsError
```

writeTableName
```
private TableName writeTableName
```

executor
```
private ExecutorService executor
```

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

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

printUsageAndExit
```
private void printUsageAndExit()
```

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

sniff

public static void sniff(Admin admin,
         TableName tableName)
                  throws Exception

Canary entry point for specified table.

Throws:: Exception

sniff

public static void sniff(Admin admin,
         TableName tableName,
         Canary.RegionTask.TaskType taskType)
                  throws Exception

Canary entry point for specified table with task type(read/write)

Throws:: Exception

sniff

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

Canary entry point for specified table.

Throws:: Exception

sniff

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

Throws:: Exception

sniffRegion

private static void sniffRegion(Admin admin,
               Canary.Sink sink,
               HRegionInfo region,
               Table table)
                         throws Exception

Throws:: Exception

main

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

Throws:: Exception

Class Canary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USAGE_EXIT_CODE

INIT_ERROR_EXIT_CODE

TIMEOUT_ERROR_EXIT_CODE

ERROR_EXIT_CODE

FAILURE_EXIT_CODE

DEFAULT_INTERVAL

DEFAULT_TIMEOUT

MAX_THREADS_NUM

LOG

DEFAULT_WRITE_TABLE_NAME

CANARY_TABLE_FAMILY_NAME

conf

interval

sink

useRegExp

timeout

failOnError

regionServerMode

regionServerAllRegions

writeSniffing

treatFailureAsError

writeTableName

executor

Constructor Detail

Canary

Canary

Method Detail

getConf

setConf

parseArgs

run

printUsageAndExit

newMonitor

sniff

sniff

sniff

sniff

sniffRegion

main