CanaryTool (Apache HBase 1.4.11 API)

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

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, Canary, org.apache.hadoop.util.Tool
```
@InterfaceAudience.LimitedPrivate(value="Tools")
public class CanaryTool
extends Object
implements org.apache.hadoop.util.Tool, Canary
```
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`	`CanaryTool.Monitor` A Monitor super-class can be extended by users
`static class`	`CanaryTool.RegionServerStdOutSink` By RegionServer, for 'regionserver' mode.
`static class`	`CanaryTool.RegionStdOutSink` By Region, for 'region' mode.
`static class`	`CanaryTool.RegionTaskResult` Canary region mode-specific data structure which stores information about each region to be scanned
`static interface`	`CanaryTool.Sink` Sink interface used by the canary to output information
`static class`	`CanaryTool.StdOutSink` Simple implementation of canary sink that allows plotting to a file or standard output.
`static class`	`CanaryTool.ZookeeperStdOutSink` Output for 'zookeeper' mode.

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.tool.Canary
Canary.Factory

Field Summary

Fields
Modifier and Type	Field and Description
`static TableName`	`DEFAULT_WRITE_TABLE_NAME`
`static String`	`HBASE_CANARY_FAIL_ON_ERROR`
`static String`	`HBASE_CANARY_REGION_READ_TABLE_TIMEOUT`
`static String`	`HBASE_CANARY_REGION_WRITE_SNIFFING`
`static String`	`HBASE_CANARY_REGION_WRITE_TABLE_NAME`
`static String`	`HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT`
`static String`	`HBASE_CANARY_REGIONSERVER_ALL_REGIONS`
`static String`	`HBASE_CANARY_TIMEOUT`
`static String`	`HBASE_CANARY_USE_REGEX`
`static String`	`HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES`

Constructor Summary

Constructors
Constructor and Description

CanaryTool()

CanaryTool(ExecutorService executor)

Constructors
Constructor and Description
`CanaryTool()`
`CanaryTool(ExecutorService executor)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`checkRegions(String[] targets)` Run Canary in Region mode.
`int`	`checkRegionServers(String[] targets)` Runs Canary in Region server mode.
`int`	`checkZooKeeper()` Runs Canary in Zookeeper mode.
`org.apache.hadoop.conf.Configuration`	`getConf()`
`Map<String,String>`	`getReadFailures()`
`Map<String,String>`	`getWriteFailures()`
`static void`	`main(String[] args)`
`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
```
  - HBASE_CANARY_REGIONSERVER_ALL_REGIONS
```
public static final String HBASE_CANARY_REGIONSERVER_ALL_REGIONS
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_REGION_WRITE_SNIFFING
```
public static final String HBASE_CANARY_REGION_WRITE_SNIFFING
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT
```
public static final String HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_REGION_WRITE_TABLE_NAME
```
public static final String HBASE_CANARY_REGION_WRITE_TABLE_NAME
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_REGION_READ_TABLE_TIMEOUT
```
public static final String HBASE_CANARY_REGION_READ_TABLE_TIMEOUT
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES
```
public static final String HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_USE_REGEX
```
public static final String HBASE_CANARY_USE_REGEX
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_TIMEOUT
```
public static final String HBASE_CANARY_TIMEOUT
```
    See Also:
    Constant Field Values
  - HBASE_CANARY_FAIL_ON_ERROR
```
public static final String HBASE_CANARY_FAIL_ON_ERROR
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CanaryTool
```
public CanaryTool()
```
  - CanaryTool
```
public CanaryTool(ExecutorService executor)
```
- Method Detail
  - checkRegions
```
public int checkRegions(String[] targets)
                 throws Exception
```
    Description copied from interface: Canary
    
    Run Canary in Region mode.
    
    Specified by:
    
    checkRegions in interface Canary
    
    Parameters:
    targets - -- list of monitor tables.
    
    Returns:
    the exit code of the Canary tool.
    
    Throws:
    
    Exception
  - checkRegionServers
```
public int checkRegionServers(String[] targets)
                       throws Exception
```
    Description copied from interface: Canary
    
    Runs Canary in Region server mode.
    
    Specified by:
    
    checkRegionServers in interface Canary
    
    Parameters:
    targets - -- list of monitor tables.
    
    Returns:
    the exit code of the Canary tool.
    
    Throws:
    
    Exception
  - checkZooKeeper
```
public int checkZooKeeper()
                   throws Exception
```
    Description copied from interface: Canary
    
    Runs Canary in Zookeeper mode.
    
    Specified by:
    
    checkZooKeeper in interface Canary
    
    Returns:
    the exit code of the Canary tool.
    
    Throws:
    
    Exception
  - 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()
```
    Specified by:
    
    getReadFailures in interface Canary
  - getWriteFailures
```
public Map<String,String> getWriteFailures()
```
    Specified by:
    
    getWriteFailures in interface Canary
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class CanaryTool

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WRITE_TABLE_NAME

HBASE_CANARY_REGIONSERVER_ALL_REGIONS

HBASE_CANARY_REGION_WRITE_SNIFFING

HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT

HBASE_CANARY_REGION_WRITE_TABLE_NAME

HBASE_CANARY_REGION_READ_TABLE_TIMEOUT

HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES

HBASE_CANARY_USE_REGEX

HBASE_CANARY_TIMEOUT

HBASE_CANARY_FAIL_ON_ERROR

Constructor Detail

CanaryTool

CanaryTool

Method Detail

checkRegions

checkRegionServers

checkZooKeeper

getConf

setConf

run

getReadFailures

getWriteFailures

main