blob: 2aa3561c05dc73c24bebbdc277b5fa10f648e8d1 [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: MetricsAssignmentManagerSource">
<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 org.apache.hadoop.hbase.metrics.BaseSource;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.metrics.OperationMetrics;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">@InterfaceAudience.Private</span>
<span class="source-line-no">025</span><span id="line-25">public interface MetricsAssignmentManagerSource extends BaseSource {</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27"> /**</span>
<span class="source-line-no">028</span><span id="line-28"> * The name of the metrics</span>
<span class="source-line-no">029</span><span id="line-29"> */</span>
<span class="source-line-no">030</span><span id="line-30"> String METRICS_NAME = "AssignmentManager";</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"> * The context metrics will be under.</span>
<span class="source-line-no">034</span><span id="line-34"> */</span>
<span class="source-line-no">035</span><span id="line-35"> String METRICS_CONTEXT = "master";</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"> * The name of the metrics context that metrics will be under in jmx</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 METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;</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"> * Description</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45"> String METRICS_DESCRIPTION = "Metrics about HBase master assignment manager.";</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> // RIT metrics</span>
<span class="source-line-no">048</span><span id="line-48"> String RIT_COUNT_NAME = "ritCount";</span>
<span class="source-line-no">049</span><span id="line-49"> String RIT_COUNT_OVER_THRESHOLD_NAME = "ritCountOverThreshold";</span>
<span class="source-line-no">050</span><span id="line-50"> String RIT_OLDEST_AGE_NAME = "ritOldestAge";</span>
<span class="source-line-no">051</span><span id="line-51"> String RIT_DURATION_NAME = "ritDuration";</span>
<span class="source-line-no">052</span><span id="line-52"> String DEAD_SERVER_OPEN_REGIONS = "deadServerOpenRegions";</span>
<span class="source-line-no">053</span><span id="line-53"> String UNKNOWN_SERVER_OPEN_REGIONS = "unknownServerOpenRegions";</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> String RIT_COUNT_DESC = "Current number of Regions In Transition (Gauge).";</span>
<span class="source-line-no">056</span><span id="line-56"> String RIT_COUNT_OVER_THRESHOLD_DESC =</span>
<span class="source-line-no">057</span><span id="line-57"> "Current number of Regions In Transition over threshold time (Gauge).";</span>
<span class="source-line-no">058</span><span id="line-58"> String RIT_OLDEST_AGE_DESC =</span>
<span class="source-line-no">059</span><span id="line-59"> "Timestamp in milliseconds of the oldest Region In Transition (Gauge).";</span>
<span class="source-line-no">060</span><span id="line-60"> String RIT_DURATION_DESC =</span>
<span class="source-line-no">061</span><span id="line-61"> "Total durations in milliseconds for all Regions in Transition (Histogram).";</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> // HBCK report metrics</span>
<span class="source-line-no">064</span><span id="line-64"> String ORPHAN_REGIONS_ON_RS = "orphanRegionsOnRS";</span>
<span class="source-line-no">065</span><span id="line-65"> String ORPHAN_REGIONS_ON_FS = "orphanRegionsOnFS";</span>
<span class="source-line-no">066</span><span id="line-66"> String INCONSISTENT_REGIONS = "inconsistentRegions";</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> String ORPHAN_REGIONS_ON_RS_DESC = "Current number of Orphan Regions on RS (Gauge).";</span>
<span class="source-line-no">069</span><span id="line-69"> String ORPHAN_REGIONS_ON_FS_DESC = "Current number of Orphan Regions on FS (Gauge).";</span>
<span class="source-line-no">070</span><span id="line-70"> String INCONSISTENT_REGIONS_DESC = "Current number of Inconsistent Regions (Gauge).";</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> // CatalogJanitor Consistency report metrics</span>
<span class="source-line-no">073</span><span id="line-73"> String HOLES = "holes";</span>
<span class="source-line-no">074</span><span id="line-74"> String OVERLAPS = "overlaps";</span>
<span class="source-line-no">075</span><span id="line-75"> String UNKNOWN_SERVER_REGIONS = "unknownServerRegions";</span>
<span class="source-line-no">076</span><span id="line-76"> String EMPTY_REGION_INFO_REGIONS = "emptyRegionInfoRegions";</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> String HOLES_DESC = "Current number of Holes (Gauge).";</span>
<span class="source-line-no">079</span><span id="line-79"> String OVERLAPS_DESC = "Current number of Overlaps (Gauge).";</span>
<span class="source-line-no">080</span><span id="line-80"> String UNKNOWN_SERVER_REGIONS_DESC = "Current number of Unknown Server Regions (Gauge).";</span>
<span class="source-line-no">081</span><span id="line-81"> String EMPTY_REGION_INFO_REGIONS_DESC =</span>
<span class="source-line-no">082</span><span id="line-82"> "Current number of Regions with Empty Region Info (Gauge).";</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> String ASSIGN_METRIC_PREFIX = "assign";</span>
<span class="source-line-no">085</span><span id="line-85"> String UNASSIGN_METRIC_PREFIX = "unassign";</span>
<span class="source-line-no">086</span><span id="line-86"> String MOVE_METRIC_PREFIX = "move";</span>
<span class="source-line-no">087</span><span id="line-87"> String REOPEN_METRIC_PREFIX = "reopen";</span>
<span class="source-line-no">088</span><span id="line-88"> String OPEN_METRIC_PREFIX = "open";</span>
<span class="source-line-no">089</span><span id="line-89"> String CLOSE_METRIC_PREFIX = "close";</span>
<span class="source-line-no">090</span><span id="line-90"> String SPLIT_METRIC_PREFIX = "split";</span>
<span class="source-line-no">091</span><span id="line-91"> String MERGE_METRIC_PREFIX = "merge";</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> String OPERATION_COUNT_NAME = "operationCount";</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> /**</span>
<span class="source-line-no">096</span><span id="line-96"> * Set the number of regions in transition.</span>
<span class="source-line-no">097</span><span id="line-97"> * @param ritCount count of the regions in transition.</span>
<span class="source-line-no">098</span><span id="line-98"> */</span>
<span class="source-line-no">099</span><span id="line-99"> void setRIT(int ritCount);</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> /**</span>
<span class="source-line-no">102</span><span id="line-102"> * Set the count of the number of regions that have been in transition over the threshold time.</span>
<span class="source-line-no">103</span><span id="line-103"> * @param ritCountOverThreshold number of regions in transition for longer than threshold.</span>
<span class="source-line-no">104</span><span id="line-104"> */</span>
<span class="source-line-no">105</span><span id="line-105"> void setRITCountOverThreshold(int ritCountOverThreshold);</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> /**</span>
<span class="source-line-no">108</span><span id="line-108"> * Set the oldest region in transition.</span>
<span class="source-line-no">109</span><span id="line-109"> * @param age age of the oldest RIT.</span>
<span class="source-line-no">110</span><span id="line-110"> */</span>
<span class="source-line-no">111</span><span id="line-111"> void setRITOldestAge(long age);</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> void updateRitDuration(long duration);</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> void updateDeadServerOpenRegions(int deadRegions);</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> void updateUnknownServerOpenRegions(int unknownRegions);</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> /**</span>
<span class="source-line-no">120</span><span id="line-120"> * Set the number of orphan regions on RS.</span>
<span class="source-line-no">121</span><span id="line-121"> * @param orphanRegionsOnRs count of the orphan regions on RS in HBCK chore report.</span>
<span class="source-line-no">122</span><span id="line-122"> */</span>
<span class="source-line-no">123</span><span id="line-123"> void setOrphanRegionsOnRs(int orphanRegionsOnRs);</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> /**</span>
<span class="source-line-no">126</span><span id="line-126"> * Set the number of orphan regions on FS.</span>
<span class="source-line-no">127</span><span id="line-127"> * @param orphanRegionsOnFs count of the orphan regions on FS in HBCK chore report.</span>
<span class="source-line-no">128</span><span id="line-128"> */</span>
<span class="source-line-no">129</span><span id="line-129"> void setOrphanRegionsOnFs(int orphanRegionsOnFs);</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"> * Set the number of inconsistent regions.</span>
<span class="source-line-no">133</span><span id="line-133"> * @param inconsistentRegions count of the inconsistent regions in HBCK chore report.</span>
<span class="source-line-no">134</span><span id="line-134"> */</span>
<span class="source-line-no">135</span><span id="line-135"> void setInconsistentRegions(int inconsistentRegions);</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> /**</span>
<span class="source-line-no">138</span><span id="line-138"> * Set the number of holes.</span>
<span class="source-line-no">139</span><span id="line-139"> * @param holes count of the holes in CatalogJanitor Consistency report.</span>
<span class="source-line-no">140</span><span id="line-140"> */</span>
<span class="source-line-no">141</span><span id="line-141"> void setHoles(int holes);</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> /**</span>
<span class="source-line-no">144</span><span id="line-144"> * Set the number of overlaps.</span>
<span class="source-line-no">145</span><span id="line-145"> * @param overlaps count of the overlaps in CatalogJanitor Consistency report.</span>
<span class="source-line-no">146</span><span id="line-146"> */</span>
<span class="source-line-no">147</span><span id="line-147"> void setOverlaps(int overlaps);</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> /**</span>
<span class="source-line-no">150</span><span id="line-150"> * Set the number of unknown server regions.</span>
<span class="source-line-no">151</span><span id="line-151"> * @param unknownServerRegions count of the unknown server regions in CatalogJanitor Consistency</span>
<span class="source-line-no">152</span><span id="line-152"> * report.</span>
<span class="source-line-no">153</span><span id="line-153"> */</span>
<span class="source-line-no">154</span><span id="line-154"> void setUnknownServerRegions(int unknownServerRegions);</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> /**</span>
<span class="source-line-no">157</span><span id="line-157"> * Set the number of regions with empty region info.</span>
<span class="source-line-no">158</span><span id="line-158"> * @param emptyRegionInfoRegions count of the regions with empty region info in CatalogJanitor</span>
<span class="source-line-no">159</span><span id="line-159"> * Consistency report.</span>
<span class="source-line-no">160</span><span id="line-160"> */</span>
<span class="source-line-no">161</span><span id="line-161"> void setEmptyRegionInfoRegions(int emptyRegionInfoRegions);</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> /**</span>
<span class="source-line-no">164</span><span id="line-164"> * TODO: Remove. This may not be needed now as assign and unassign counts are tracked separately</span>
<span class="source-line-no">165</span><span id="line-165"> * Increment the count of operations (assign/unassign).</span>
<span class="source-line-no">166</span><span id="line-166"> */</span>
<span class="source-line-no">167</span><span id="line-167"> void incrementOperationCounter();</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> /** Returns {@link OperationMetrics} containing common metrics for assign region operation */</span>
<span class="source-line-no">170</span><span id="line-170"> OperationMetrics getAssignMetrics();</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> /** Returns {@link OperationMetrics} containing common metrics for unassign region operation */</span>
<span class="source-line-no">173</span><span id="line-173"> OperationMetrics getUnassignMetrics();</span>
<span class="source-line-no">174</span><span id="line-174"></span>
<span class="source-line-no">175</span><span id="line-175"> /** Returns {@link OperationMetrics} containing common metrics for move region operation */</span>
<span class="source-line-no">176</span><span id="line-176"> OperationMetrics getMoveMetrics();</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> /** Returns {@link OperationMetrics} containing common metrics for reopen region operation */</span>
<span class="source-line-no">179</span><span id="line-179"> OperationMetrics getReopenMetrics();</span>
<span class="source-line-no">180</span><span id="line-180"></span>
<span class="source-line-no">181</span><span id="line-181"> /** Returns {@link OperationMetrics} containing common metrics for open region request */</span>
<span class="source-line-no">182</span><span id="line-182"> OperationMetrics getOpenMetrics();</span>
<span class="source-line-no">183</span><span id="line-183"></span>
<span class="source-line-no">184</span><span id="line-184"> /** Returns {@link OperationMetrics} containing common metrics for close region request */</span>
<span class="source-line-no">185</span><span id="line-185"> OperationMetrics getCloseMetrics();</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> /** Returns {@link OperationMetrics} containing common metrics for split operation */</span>
<span class="source-line-no">188</span><span id="line-188"> OperationMetrics getSplitMetrics();</span>
<span class="source-line-no">189</span><span id="line-189"></span>
<span class="source-line-no">190</span><span id="line-190"> /** Returns {@link OperationMetrics} containing common metrics for merge operation */</span>
<span class="source-line-no">191</span><span id="line-191"> OperationMetrics getMergeMetrics();</span>
<span class="source-line-no">192</span><span id="line-192">}</span>
</pre>
</div>
</main>
</body>
</html>