Google Git
Sign in
apache / hbase-site / 5c27bdb1b67418733efd6995a2540ff9aaf7e272 / . / devapidocs / src-html / org / apache / hadoop / hbase / master / MetricsAssignmentManagerSource.html
blob: bb67246a008e75fb89ace97993965a0f8129e8ee [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.master;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.metrics.BaseSource;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.metrics.OperationMetrics;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>@InterfaceAudience.Private<a name="line.25"></a>
<span class="sourceLineNo">026</span>public interface MetricsAssignmentManagerSource extends BaseSource {<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span> /**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * The name of the metrics<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span> String METRICS_NAME = "AssignmentManager";<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span> /**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * The context metrics will be under.<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span> String METRICS_CONTEXT = "master";<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * The name of the metrics context that metrics will be under in jmx<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Description<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> String METRICS_DESCRIPTION = "Metrics about HBase master assignment manager.";<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> // RIT metrics<a name="line.48"></a>
<span class="sourceLineNo">049</span> String RIT_COUNT_NAME = "ritCount";<a name="line.49"></a>
<span class="sourceLineNo">050</span> String RIT_COUNT_OVER_THRESHOLD_NAME = "ritCountOverThreshold";<a name="line.50"></a>
<span class="sourceLineNo">051</span> String RIT_OLDEST_AGE_NAME = "ritOldestAge";<a name="line.51"></a>
<span class="sourceLineNo">052</span> String RIT_DURATION_NAME = "ritDuration";<a name="line.52"></a>
<span class="sourceLineNo">053</span> String DEAD_SERVER_OPEN_REGIONS = "deadServerOpenRegions";<a name="line.53"></a>
<span class="sourceLineNo">054</span> String UNKNOWN_SERVER_OPEN_REGIONS = "unknownServerOpenRegions";<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> String RIT_COUNT_DESC = "Current number of Regions In Transition (Gauge).";<a name="line.56"></a>
<span class="sourceLineNo">057</span> String RIT_COUNT_OVER_THRESHOLD_DESC =<a name="line.57"></a>
<span class="sourceLineNo">058</span> "Current number of Regions In Transition over threshold time (Gauge).";<a name="line.58"></a>
<span class="sourceLineNo">059</span> String RIT_OLDEST_AGE_DESC =<a name="line.59"></a>
<span class="sourceLineNo">060</span> "Timestamp in milliseconds of the oldest Region In Transition (Gauge).";<a name="line.60"></a>
<span class="sourceLineNo">061</span> String RIT_DURATION_DESC =<a name="line.61"></a>
<span class="sourceLineNo">062</span> "Total durations in milliseconds for all Regions in Transition (Histogram).";<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> String ASSIGN_METRIC_PREFIX = "assign";<a name="line.64"></a>
<span class="sourceLineNo">065</span> String UNASSIGN_METRIC_PREFIX = "unassign";<a name="line.65"></a>
<span class="sourceLineNo">066</span> String MOVE_METRIC_PREFIX = "move";<a name="line.66"></a>
<span class="sourceLineNo">067</span> String REOPEN_METRIC_PREFIX = "reopen";<a name="line.67"></a>
<span class="sourceLineNo">068</span> String OPEN_METRIC_PREFIX = "open";<a name="line.68"></a>
<span class="sourceLineNo">069</span> String CLOSE_METRIC_PREFIX = "close";<a name="line.69"></a>
<span class="sourceLineNo">070</span> String SPLIT_METRIC_PREFIX = "split";<a name="line.70"></a>
<span class="sourceLineNo">071</span> String MERGE_METRIC_PREFIX = "merge";<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> String OPERATION_COUNT_NAME = "operationCount";<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Set the number of regions in transition.<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param ritCount count of the regions in transition.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> void setRIT(int ritCount);<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Set the count of the number of regions that have been in transition over the threshold time.<a name="line.83"></a>
<span class="sourceLineNo">084</span> *<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @param ritCountOverThreshold number of regions in transition for longer than threshold.<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> void setRITCountOverThreshold(int ritCountOverThreshold);<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Set the oldest region in transition.<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param age age of the oldest RIT.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> void setRITOldestAge(long age);<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> void updateRitDuration(long duration);<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> void updateDeadServerOpenRegions(int deadRegions);<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> void updateUnknownServerOpenRegions(int unknownRegions);<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * TODO: Remove. This may not be needed now as assign and unassign counts are tracked separately<a name="line.103"></a>
<span class="sourceLineNo">104</span> * Increment the count of operations (assign/unassign).<a name="line.104"></a>
<span class="sourceLineNo">105</span> */<a name="line.105"></a>
<span class="sourceLineNo">106</span> void incrementOperationCounter();<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return {@link OperationMetrics} containing common metrics for assign region operation<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> OperationMetrics getAssignMetrics();<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @return {@link OperationMetrics} containing common metrics for unassign region operation<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> OperationMetrics getUnassignMetrics();<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @return {@link OperationMetrics} containing common metrics for move region operation<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> OperationMetrics getMoveMetrics();<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @return {@link OperationMetrics} containing common metrics for reopen region operation<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> OperationMetrics getReopenMetrics();<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @return {@link OperationMetrics} containing common metrics for open region request<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> OperationMetrics getOpenMetrics();<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> /**<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @return {@link OperationMetrics} containing common metrics for close region request<a name="line.134"></a>
<span class="sourceLineNo">135</span> */<a name="line.135"></a>
<span class="sourceLineNo">136</span> OperationMetrics getCloseMetrics();<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> /**<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @return {@link OperationMetrics} containing common metrics for split operation<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> OperationMetrics getSplitMetrics();<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
<span class="sourceLineNo">144</span> * @return {@link OperationMetrics} containing common metrics for merge operation<a name="line.144"></a>
<span class="sourceLineNo">145</span> */<a name="line.145"></a>
<span class="sourceLineNo">146</span> OperationMetrics getMergeMetrics();<a name="line.146"></a>
<span class="sourceLineNo">147</span>}<a name="line.147"></a>
</pre>
</div>
</body>
</html>