1 /**
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19
20 package org.apache.hadoop.hbase.tool;
21
22
23 import java.util.Map;
24 import java.util.concurrent.ExecutorService;
25 import org.apache.hadoop.conf.Configuration;
26 import org.apache.hadoop.hbase.classification.InterfaceAudience;
27
28 @InterfaceAudience.Public
29 public interface Canary {
30
31 public static class Factory {
32 static Canary create(Configuration conf, ExecutorService executor) {
33 return new CanaryTool(conf, executor);
34 }
35
36 @InterfaceAudience.Private
37 static Canary create(Configuration conf, ExecutorService executor, CanaryTool.Sink sink) {
38 return new CanaryTool(conf, executor, sink);
39 }
40 }
41
42 /**
43 * Run Canary in Region mode.
44 *
45 * @param targets -- list of monitor tables.
46 * @return the exit code of the Canary tool.
47 */
48 public int checkRegions(String[] targets) throws Exception;
49
50 /**
51 * Runs Canary in Region server mode.
52 *
53 * @param targets -- list of monitor tables.
54 * @return the exit code of the Canary tool.
55 */
56 public int checkRegionServers(String[] targets) throws Exception;
57
58 /**
59 * Runs Canary in Zookeeper mode.
60 *
61 * @return the exit code of the Canary tool.
62 */
63 public int checkZooKeeper() throws Exception;
64
65 public Map<String, String> getReadFailures();
66
67 public Map<String, String> getWriteFailures();
68 }