001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019
020package org.apache.hadoop.hbase.tool;
021
022
023import java.util.Map;
024import java.util.concurrent.ExecutorService;
025import org.apache.hadoop.conf.Configuration;
026import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;
027import org.apache.yetus.audience.InterfaceAudience;
028
029@InterfaceAudience.Public
030public interface Canary {
031
032  static Canary create(Configuration conf, ExecutorService executor) {
033    return new CanaryTool(conf, executor);
034  }
035
036  @VisibleForTesting
037  static Canary create(Configuration conf, ExecutorService executor, CanaryTool.Sink sink) {
038    return new CanaryTool(conf, executor, sink);
039  }
040
041  /**
042   * Run Canary in Region mode.
043   *
044   * @param targets -- list of monitor tables.
045   * @return the exit code of the Canary tool.
046   */
047  public int checkRegions(String[] targets) throws Exception;
048
049  /**
050   * Runs Canary in Region server mode.
051   *
052   * @param targets -- list of monitor tables.
053   * @return the exit code of the Canary tool.
054   */
055  public int checkRegionServers(String[] targets) throws Exception;
056
057  /**
058   * Runs Canary in Zookeeper mode.
059   *
060   * @return the exit code of the Canary tool.
061   */
062  public int checkZooKeeper() throws Exception;
063
064  public Map<String, String> getReadFailures();
065
066  public Map<String, String> getWriteFailures();
067}