blob: 50d50e42f7408bd15778fd3a09d0aeb6fe28b963 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.master, interface: MetricsMasterWrapper">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.master;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.util.Map;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Map.Entry;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.util.PairOfSameType;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">/**</span>
<span class="source-line-no">026</span><span id="line-26"> * This is the interface that will expose information to hadoop1/hadoop2 implementations of the</span>
<span class="source-line-no">027</span><span id="line-27"> * MetricsMasterSource.</span>
<span class="source-line-no">028</span><span id="line-28"> */</span>
<span class="source-line-no">029</span><span id="line-29">@InterfaceAudience.Private</span>
<span class="source-line-no">030</span><span id="line-30">public interface MetricsMasterWrapper {</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> /**</span>
<span class="source-line-no">033</span><span id="line-33"> * Returns if the master is currently running and is not attempting to shutdown.</span>
<span class="source-line-no">034</span><span id="line-34"> */</span>
<span class="source-line-no">035</span><span id="line-35"> boolean isRunning();</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> /**</span>
<span class="source-line-no">038</span><span id="line-38"> * Get ServerName</span>
<span class="source-line-no">039</span><span id="line-39"> */</span>
<span class="source-line-no">040</span><span id="line-40"> String getServerName();</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> /**</span>
<span class="source-line-no">043</span><span id="line-43"> * Get Average Load</span>
<span class="source-line-no">044</span><span id="line-44"> * @return Average Load</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46"> double getAverageLoad();</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> /**</span>
<span class="source-line-no">049</span><span id="line-49"> * Get the Cluster ID</span>
<span class="source-line-no">050</span><span id="line-50"> * @return Cluster ID</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52"> String getClusterId();</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /**</span>
<span class="source-line-no">055</span><span id="line-55"> * Get the ZooKeeper Quorum Info</span>
<span class="source-line-no">056</span><span id="line-56"> * @return ZooKeeper Quorum Info</span>
<span class="source-line-no">057</span><span id="line-57"> */</span>
<span class="source-line-no">058</span><span id="line-58"> String getZookeeperQuorum();</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> /**</span>
<span class="source-line-no">061</span><span id="line-61"> * Get the co-processors</span>
<span class="source-line-no">062</span><span id="line-62"> * @return Co-processors</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> String[] getCoprocessors();</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> /**</span>
<span class="source-line-no">067</span><span id="line-67"> * Get hbase master start time</span>
<span class="source-line-no">068</span><span id="line-68"> * @return Start time of master in milliseconds</span>
<span class="source-line-no">069</span><span id="line-69"> */</span>
<span class="source-line-no">070</span><span id="line-70"> long getStartTime();</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /**</span>
<span class="source-line-no">073</span><span id="line-73"> * Get the hbase master active time</span>
<span class="source-line-no">074</span><span id="line-74"> * @return Time in milliseconds when master became active</span>
<span class="source-line-no">075</span><span id="line-75"> */</span>
<span class="source-line-no">076</span><span id="line-76"> long getActiveTime();</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> /**</span>
<span class="source-line-no">079</span><span id="line-79"> * Whether this master is the active master</span>
<span class="source-line-no">080</span><span id="line-80"> * @return True if this is the active master</span>
<span class="source-line-no">081</span><span id="line-81"> */</span>
<span class="source-line-no">082</span><span id="line-82"> boolean getIsActiveMaster();</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> /**</span>
<span class="source-line-no">085</span><span id="line-85"> * Get the live region servers</span>
<span class="source-line-no">086</span><span id="line-86"> * @return Live region servers</span>
<span class="source-line-no">087</span><span id="line-87"> */</span>
<span class="source-line-no">088</span><span id="line-88"> String getRegionServers();</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> /**</span>
<span class="source-line-no">091</span><span id="line-91"> * Get the number of live region servers</span>
<span class="source-line-no">092</span><span id="line-92"> * @return number of Live region servers</span>
<span class="source-line-no">093</span><span id="line-93"> */</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> int getNumRegionServers();</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> /**</span>
<span class="source-line-no">098</span><span id="line-98"> * Get the dead region servers</span>
<span class="source-line-no">099</span><span id="line-99"> * @return Dead region Servers</span>
<span class="source-line-no">100</span><span id="line-100"> */</span>
<span class="source-line-no">101</span><span id="line-101"> String getDeadRegionServers();</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> /**</span>
<span class="source-line-no">104</span><span id="line-104"> * Get the number of dead region servers</span>
<span class="source-line-no">105</span><span id="line-105"> * @return number of Dead region Servers</span>
<span class="source-line-no">106</span><span id="line-106"> */</span>
<span class="source-line-no">107</span><span id="line-107"> int getNumDeadRegionServers();</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> /**</span>
<span class="source-line-no">110</span><span id="line-110"> * Get the draining region servers</span>
<span class="source-line-no">111</span><span id="line-111"> * @return Draining region server</span>
<span class="source-line-no">112</span><span id="line-112"> */</span>
<span class="source-line-no">113</span><span id="line-113"> String getDrainingRegionServers();</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> /**</span>
<span class="source-line-no">116</span><span id="line-116"> * Get the number of draining region servers</span>
<span class="source-line-no">117</span><span id="line-117"> * @return number of draining region servers</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> int getNumDrainingRegionServers();</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> /**</span>
<span class="source-line-no">122</span><span id="line-122"> * Get the number of master WAL files.</span>
<span class="source-line-no">123</span><span id="line-123"> */</span>
<span class="source-line-no">124</span><span id="line-124"> long getNumWALFiles();</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> /**</span>
<span class="source-line-no">127</span><span id="line-127"> * Get the number of region split plans executed.</span>
<span class="source-line-no">128</span><span id="line-128"> */</span>
<span class="source-line-no">129</span><span id="line-129"> long getSplitPlanCount();</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> /**</span>
<span class="source-line-no">132</span><span id="line-132"> * Get the number of region merge plans executed.</span>
<span class="source-line-no">133</span><span id="line-133"> */</span>
<span class="source-line-no">134</span><span id="line-134"> long getMergePlanCount();</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> /**</span>
<span class="source-line-no">137</span><span id="line-137"> * Gets the space usage and limit for each table.</span>
<span class="source-line-no">138</span><span id="line-138"> */</span>
<span class="source-line-no">139</span><span id="line-139"> Map&lt;String, Entry&lt;Long, Long&gt;&gt; getTableSpaceUtilization();</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> /**</span>
<span class="source-line-no">142</span><span id="line-142"> * Gets the space usage and limit for each namespace.</span>
<span class="source-line-no">143</span><span id="line-143"> */</span>
<span class="source-line-no">144</span><span id="line-144"> Map&lt;String, Entry&lt;Long, Long&gt;&gt; getNamespaceSpaceUtilization();</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> /**</span>
<span class="source-line-no">147</span><span id="line-147"> * Get the time in Millis when the master finished initializing/becoming the active master</span>
<span class="source-line-no">148</span><span id="line-148"> */</span>
<span class="source-line-no">149</span><span id="line-149"> long getMasterInitializationTime();</span>
<span class="source-line-no">150</span><span id="line-150"></span>
<span class="source-line-no">151</span><span id="line-151"> /**</span>
<span class="source-line-no">152</span><span id="line-152"> * Get the online and offline region counts</span>
<span class="source-line-no">153</span><span id="line-153"> * @return pair of count for online regions and offline regions</span>
<span class="source-line-no">154</span><span id="line-154"> */</span>
<span class="source-line-no">155</span><span id="line-155"> PairOfSameType&lt;Integer&gt; getRegionCounts();</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> /**</span>
<span class="source-line-no">158</span><span id="line-158"> * Get the size of old WALs directory in bytes.</span>
<span class="source-line-no">159</span><span id="line-159"> */</span>
<span class="source-line-no">160</span><span id="line-160"> long getOldWALsDirSize();</span>
<span class="source-line-no">161</span><span id="line-161">}</span>
</pre>
</div>
</main>
</body>
</html>