blob: ca744f30c014abb4002b73823ba70cc9465052c0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CanaryTool (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CanaryTool (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":9,"i17":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CanaryTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryStatusServlet.html" title="class in org.apache.hadoop.hbase.tool"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/tool/CanaryTool.html" target="_top">Frames</a></li>
<li><a href="CanaryTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.tool</div>
<h2 title="Class CanaryTool" class="title">Class CanaryTool</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.tool.CanaryTool</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.conf.Configurable, <a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a>, org.apache.hadoop.util.Tool</dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.LimitedPrivate(value="Tools")
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.124">CanaryTool</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements org.apache.hadoop.util.Tool, <a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></pre>
<div class="block">HBase Canary Tool for "canary monitoring" of a running HBase cluster.
There are three modes:
<ol>
<li>region mode (Default): For each region, try to get one row per column family outputting
information on failure (ERROR) or else the latency.
</li>
<li>regionserver mode: For each regionserver try to get one row from one table selected
randomly outputting information on failure (ERROR) or else the latency.
</li>
<li>zookeeper mode: for each zookeeper instance, selects a znode outputting information on
failure (ERROR) or else the latency.
</li>
</ol></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.Monitor</a></span></code>
<div class="block">A Monitor super-class can be extended by users</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionMonitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionMonitor</a></span></code>
<div class="block">A monitor for region mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionServerMonitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionServerMonitor</a></span></code>
<div class="block">A monitor for regionserver mode</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionServerStdOutSink.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionServerStdOutSink</a></span></code>
<div class="block">By RegionServer, for 'regionserver' mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionServerTask.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionServerTask</a></span></code>
<div class="block">Run a single RegionServer Task and then exit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionStdOutSink.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionStdOutSink</a></span></code>
<div class="block">By Region, for 'region' mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTask.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionTask</a></span></code>
<div class="block">Run a single Region Task and then exit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTaskResult.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.RegionTaskResult</a></span></code>
<div class="block">Canary region mode-specific data structure which stores information about each region
to be scanned</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a></span></code>
<div class="block">Sink interface used by the canary to output information</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.StdOutSink.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.StdOutSink</a></span></code>
<div class="block">Simple implementation of canary sink that allows plotting to a file or standard output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.ZookeeperMonitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.ZookeeperMonitor</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.ZookeeperStdOutSink.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.ZookeeperStdOutSink</a></span></code>
<div class="block">Output for 'zookeeper' mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.ZookeeperTask.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.ZookeeperTask</a></span></code>
<div class="block">Run a single zookeeper Task and then exit.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CANARY_TABLE_FAMILY_NAME">CANARY_TABLE_FAMILY_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#conf">conf</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#configuredReadTableTimeouts">configuredReadTableTimeouts</a></span></code>
<div class="block">This is a Map of table to timeout.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#DEFAULT_INTERVAL">DEFAULT_INTERVAL</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#DEFAULT_WRITE_TABLE_NAME">DEFAULT_WRITE_TABLE_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#ERROR_EXIT_CODE">ERROR_EXIT_CODE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#executor">executor</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#FAILURE_EXIT_CODE">FAILURE_EXIT_CODE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_FAIL_ON_ERROR">HBASE_CANARY_FAIL_ON_ERROR</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_INFO_BINDADDRESS">HBASE_CANARY_INFO_BINDADDRESS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_INFO_PORT">HBASE_CANARY_INFO_PORT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_REGION_READ_TABLE_TIMEOUT">HBASE_CANARY_REGION_READ_TABLE_TIMEOUT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_REGION_WRITE_SNIFFING">HBASE_CANARY_REGION_WRITE_SNIFFING</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_REGION_WRITE_TABLE_NAME">HBASE_CANARY_REGION_WRITE_TABLE_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT">HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_REGIONSERVER_ALL_REGIONS">HBASE_CANARY_REGIONSERVER_ALL_REGIONS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_TIMEOUT">HBASE_CANARY_TIMEOUT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_USE_REGEX">HBASE_CANARY_USE_REGEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES">HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#INIT_ERROR_EXIT_CODE">INIT_ERROR_EXIT_CODE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#interval">interval</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#MAX_THREADS_NUM">MAX_THREADS_NUM</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#regionServerMode">regionServerMode</a></span></code>
<div class="block">True if we are to run in 'regionServer' mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#sink">sink</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#TIMEOUT_ERROR_EXIT_CODE">TIMEOUT_ERROR_EXIT_CODE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#USAGE_EXIT_CODE">USAGE_EXIT_CODE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#zookeeperMode">zookeeperMode</a></span></code>
<div class="block">True if we are to run in zookeeper 'mode'.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CanaryTool--">CanaryTool</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CanaryTool-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-">CanaryTool</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CanaryTool-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.Sink-">CanaryTool</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CanaryTool-java.util.concurrent.ExecutorService-">CanaryTool</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#CanaryTool-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.Sink-">CanaryTool</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#checkRegions-java.lang.String:A-">checkRegions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;targets)</code>
<div class="block">Run Canary in Region mode.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#checkRegionServers-java.lang.String:A-">checkRegionServers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;targets)</code>
<div class="block">Runs Canary in Region server mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#checkZooKeeper--">checkZooKeeper</a></span>()</code>
<div class="block">Runs Canary in Zookeeper mode.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#getConf--">getConf</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#getReadFailures--">getReadFailures</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>(package private) <a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#getSink-org.apache.hadoop.conf.Configuration-java.lang.Class-">getSink</a></span>(org.apache.hadoop.conf.Configuration&nbsp;configuration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;clazz)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#getWriteFailures--">getWriteFailures</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.Monitor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#newMonitor-org.apache.hadoop.hbase.client.Connection-java.lang.String:A-">newMonitor</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;monitorTargets)</code>
<div class="block">A Factory method for <a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool"><code>CanaryTool.Monitor</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#parseArgs-java.lang.String:A-">parseArgs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#populateReadTableTimeoutsMap-java.lang.String-">populateReadTableTimeoutsMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configuredReadTableTimeoutsStr)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#printUsageAndExit--">printUsageAndExit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#putUpWebUI--">putUpWebUI</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#run-java.lang.String:A-">run</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#runMonitor-java.lang.String:A-">runMonitor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;monitorTargets)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#sniff-org.apache.hadoop.hbase.client.Admin-org.apache.hadoop.hbase.tool.CanaryTool.Sink-java.lang.String-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.RegionTask.TaskType-boolean-java.util.concurrent.atomic.LongAdder-boolean-">sniff</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a>&nbsp;admin,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTask.TaskType.html" title="enum in org.apache.hadoop.hbase.tool">CanaryTool.RegionTask.TaskType</a>&nbsp;taskType,
boolean&nbsp;rawScanEnabled,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/LongAdder.html?is-external=true" title="class or interface in java.util.concurrent.atomic">LongAdder</a>&nbsp;readLatency,
boolean&nbsp;readAllCF)</code>
<div class="block">Canary entry point for specified table.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.html#sniff-org.apache.hadoop.hbase.client.Admin-org.apache.hadoop.hbase.tool.CanaryTool.Sink-org.apache.hadoop.hbase.client.TableDescriptor-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.RegionTask.TaskType-boolean-java.util.concurrent.atomic.LongAdder-boolean-">sniff</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a>&nbsp;admin,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>&nbsp;tableDesc,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTask.TaskType.html" title="enum in org.apache.hadoop.hbase.tool">CanaryTool.RegionTask.TaskType</a>&nbsp;taskType,
boolean&nbsp;rawScanEnabled,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/LongAdder.html?is-external=true" title="class or interface in java.util.concurrent.atomic">LongAdder</a>&nbsp;rwLatency,
boolean&nbsp;readAllCF)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.tool.Canary">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.hbase.tool.<a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#create-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-">create</a>, <a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#create-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.Sink-">create</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="HBASE_CANARY_INFO_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_INFO_PORT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.125">HBASE_CANARY_INFO_PORT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_INFO_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_INFO_BINDADDRESS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_INFO_BINDADDRESS</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.126">HBASE_CANARY_INFO_BINDADDRESS</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_INFO_BINDADDRESS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USAGE_EXIT_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USAGE_EXIT_CODE</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.725">USAGE_EXIT_CODE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.USAGE_EXIT_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INIT_ERROR_EXIT_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INIT_ERROR_EXIT_CODE</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.726">INIT_ERROR_EXIT_CODE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.INIT_ERROR_EXIT_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TIMEOUT_ERROR_EXIT_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TIMEOUT_ERROR_EXIT_CODE</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.727">TIMEOUT_ERROR_EXIT_CODE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.TIMEOUT_ERROR_EXIT_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ERROR_EXIT_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_EXIT_CODE</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.728">ERROR_EXIT_CODE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.ERROR_EXIT_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FAILURE_EXIT_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAILURE_EXIT_CODE</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.729">FAILURE_EXIT_CODE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.FAILURE_EXIT_CODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_INTERVAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_INTERVAL</h4>
<pre>private static final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.731">DEFAULT_INTERVAL</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.DEFAULT_INTERVAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TIMEOUT</h4>
<pre>private static final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.733">DEFAULT_TIMEOUT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.DEFAULT_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAX_THREADS_NUM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_THREADS_NUM</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.734">MAX_THREADS_NUM</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.MAX_THREADS_NUM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.736">LOG</a></pre>
</li>
</ul>
<a name="DEFAULT_WRITE_TABLE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WRITE_TABLE_NAME</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.738">DEFAULT_WRITE_TABLE_NAME</a></pre>
</li>
</ul>
<a name="CANARY_TABLE_FAMILY_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANARY_TABLE_FAMILY_NAME</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.741">CANARY_TABLE_FAMILY_NAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.CANARY_TABLE_FAMILY_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="conf">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conf</h4>
<pre>private&nbsp;org.apache.hadoop.conf.Configuration <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.743">conf</a></pre>
</li>
</ul>
<a name="interval">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interval</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.744">interval</a></pre>
</li>
</ul>
<a name="sink">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sink</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.745">sink</a></pre>
</li>
</ul>
<a name="regionServerMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>regionServerMode</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.750">regionServerMode</a></pre>
<div class="block">True if we are to run in 'regionServer' mode.</div>
</li>
</ul>
<a name="zookeeperMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zookeeperMode</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.755">zookeeperMode</a></pre>
<div class="block">True if we are to run in zookeeper 'mode'.</div>
</li>
</ul>
<a name="configuredReadTableTimeouts">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configuredReadTableTimeouts</h4>
<pre>private&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt; <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.762">configuredReadTableTimeouts</a></pre>
<div class="block">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.</div>
</li>
</ul>
<a name="HBASE_CANARY_REGIONSERVER_ALL_REGIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_REGIONSERVER_ALL_REGIONS</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.764">HBASE_CANARY_REGIONSERVER_ALL_REGIONS</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_REGIONSERVER_ALL_REGIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_REGION_WRITE_SNIFFING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_REGION_WRITE_SNIFFING</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.767">HBASE_CANARY_REGION_WRITE_SNIFFING</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_REGION_WRITE_SNIFFING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.769">HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_REGION_WRITE_TABLE_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_REGION_WRITE_TABLE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_REGION_WRITE_TABLE_NAME</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.771">HBASE_CANARY_REGION_WRITE_TABLE_NAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_REGION_WRITE_TABLE_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_REGION_READ_TABLE_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_REGION_READ_TABLE_TIMEOUT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.773">HBASE_CANARY_REGION_READ_TABLE_TIMEOUT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_REGION_READ_TABLE_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.776">HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_ZOOKEEPER_PERMITTED_FAILURES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_USE_REGEX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_USE_REGEX</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.779">HBASE_CANARY_USE_REGEX</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_USE_REGEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_TIMEOUT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.780">HBASE_CANARY_TIMEOUT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HBASE_CANARY_FAIL_ON_ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CANARY_FAIL_ON_ERROR</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.781">HBASE_CANARY_FAIL_ON_ERROR</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.tool.CanaryTool.HBASE_CANARY_FAIL_ON_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="executor">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executor</h4>
<pre>private&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.784">executor</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CanaryTool--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanaryTool</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.786">CanaryTool</a>()</pre>
</li>
</ul>
<a name="CanaryTool-java.util.concurrent.ExecutorService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanaryTool</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.790">CanaryTool</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</pre>
</li>
</ul>
<a name="CanaryTool-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.Sink-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanaryTool</h4>
<pre>@InterfaceAudience.Private
<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.795">CanaryTool</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink)</pre>
</li>
</ul>
<a name="CanaryTool-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CanaryTool</h4>
<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.800">CanaryTool</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</pre>
</li>
</ul>
<a name="CanaryTool-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.Sink-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CanaryTool</h4>
<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.804">CanaryTool</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="putUpWebUI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putUpWebUI</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.128">putUpWebUI</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="checkRegions-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkRegions</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.153">checkRegions</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;targets)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkRegions-java.lang.String:A-">Canary</a></code></span></div>
<div class="block">Run Canary in Region mode.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkRegions-java.lang.String:A-">checkRegions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targets</code> - -- list of monitor tables.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code of the Canary tool.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="checkRegionServers-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkRegionServers</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.167">checkRegionServers</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;targets)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkRegionServers-java.lang.String:A-">Canary</a></code></span></div>
<div class="block">Runs Canary in Region server mode.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkRegionServers-java.lang.String:A-">checkRegionServers</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targets</code> - -- list of monitor tables.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code of the Canary tool.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="checkZooKeeper--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkZooKeeper</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.173">checkZooKeeper</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkZooKeeper--">Canary</a></code></span></div>
<div class="block">Runs Canary in Zookeeper mode.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#checkZooKeeper--">checkZooKeeper</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code of the Canary tool.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="getConf--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConf</h4>
<pre>public&nbsp;org.apache.hadoop.conf.Configuration&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.810">getConf</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getConf</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.conf.Configurable</code></dd>
</dl>
</li>
</ul>
<a name="setConf-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConf</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.815">setConf</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setConf</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.conf.Configurable</code></dd>
</dl>
</li>
</ul>
<a name="parseArgs-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseArgs</h4>
<pre>private&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.822">parseArgs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</pre>
</li>
</ul>
<a name="run-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.973">run</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.util.Tool</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="runMonitor-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runMonitor</h4>
<pre>private&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.995">runMonitor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;monitorTargets)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="getReadFailures--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadFailures</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1069">getReadFailures</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#getReadFailures--">getReadFailures</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></code></dd>
</dl>
</li>
</ul>
<a name="getWriteFailures--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteFailures</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1074">getWriteFailures</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html#getWriteFailures--">getWriteFailures</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/tool/Canary.html" title="interface in org.apache.hadoop.hbase.tool">Canary</a></code></dd>
</dl>
</li>
</ul>
<a name="printUsageAndExit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printUsageAndExit</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1078">printUsageAndExit</a>()</pre>
</li>
</ul>
<a name="getSink-org.apache.hadoop.conf.Configuration-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSink</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1122">getSink</a>(org.apache.hadoop.conf.Configuration&nbsp;configuration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;clazz)</pre>
</li>
</ul>
<a name="newMonitor-org.apache.hadoop.hbase.client.Connection-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newMonitor</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool">CanaryTool.Monitor</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1235">newMonitor</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;monitorTargets)</pre>
<div class="block">A Factory method for <a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool"><code>CanaryTool.Monitor</code></a>.
Makes a RegionServerMonitor, or a ZooKeeperMonitor, or a RegionMonitor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Monitor instance</dd>
</dl>
</li>
</ul>
<a name="populateReadTableTimeoutsMap-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populateReadTableTimeoutsMap</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1274">populateReadTableTimeoutsMap</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configuredReadTableTimeoutsStr)</pre>
</li>
</ul>
<a name="sniff-org.apache.hadoop.hbase.client.Admin-org.apache.hadoop.hbase.tool.CanaryTool.Sink-java.lang.String-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.RegionTask.TaskType-boolean-java.util.concurrent.atomic.LongAdder-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sniff</h4>
<pre>private static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1647">sniff</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a>&nbsp;admin,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTask.TaskType.html" title="enum in org.apache.hadoop.hbase.tool">CanaryTool.RegionTask.TaskType</a>&nbsp;taskType,
boolean&nbsp;rawScanEnabled,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/LongAdder.html?is-external=true" title="class or interface in java.util.concurrent.atomic">LongAdder</a>&nbsp;readLatency,
boolean&nbsp;readAllCF)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Canary entry point for specified table.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - exception</dd>
</dl>
</li>
</ul>
<a name="sniff-org.apache.hadoop.hbase.client.Admin-org.apache.hadoop.hbase.tool.CanaryTool.Sink-org.apache.hadoop.hbase.client.TableDescriptor-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.tool.CanaryTool.RegionTask.TaskType-boolean-java.util.concurrent.atomic.LongAdder-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sniff</h4>
<pre>private static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1663">sniff</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a>&nbsp;admin,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Sink.html" title="interface in org.apache.hadoop.hbase.tool">CanaryTool.Sink</a>&nbsp;sink,
<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>&nbsp;tableDesc,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor,
<a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.RegionTask.TaskType.html" title="enum in org.apache.hadoop.hbase.tool">CanaryTool.RegionTask.TaskType</a>&nbsp;taskType,
boolean&nbsp;rawScanEnabled,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/LongAdder.html?is-external=true" title="class or interface in java.util.concurrent.atomic">LongAdder</a>&nbsp;rwLatency,
boolean&nbsp;readAllCF)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/tool/CanaryTool.html#line.1967">main</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CanaryTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryStatusServlet.html" title="class in org.apache.hadoop.hbase.tool"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/tool/CanaryTool.Monitor.html" title="class in org.apache.hadoop.hbase.tool"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/tool/CanaryTool.html" target="_top">Frames</a></li>
<li><a href="CanaryTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>