Google Git
Sign in
apache / hbase-site / edc9f41ac5957af2e574b6068b2bdf77baaf06cd / . / devapidocs / src-html / org / apache / hadoop / hbase / RegionMetrics.html
blob: ff6898482f5b6f7461f76d905611e2fe335575d0 [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>package org.apache.hadoop.hbase;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.client.CompactionState;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.util.Bytes;<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>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Encapsulates per-region load metrics.<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>@InterfaceAudience.Public<a name="line.28"></a>
<span class="sourceLineNo">029</span>public interface RegionMetrics {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span> /** Returns the region name */<a name="line.31"></a>
<span class="sourceLineNo">032</span> byte[] getRegionName();<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /** Returns the number of stores */<a name="line.34"></a>
<span class="sourceLineNo">035</span> int getStoreCount();<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /** Returns the number of storefiles */<a name="line.37"></a>
<span class="sourceLineNo">038</span> int getStoreFileCount();<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /** Returns the total size of the storefiles */<a name="line.40"></a>
<span class="sourceLineNo">041</span> Size getStoreFileSize();<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /** Returns the memstore size */<a name="line.43"></a>
<span class="sourceLineNo">044</span> Size getMemStoreSize();<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /** Returns the number of read requests made to region */<a name="line.46"></a>
<span class="sourceLineNo">047</span> long getReadRequestCount();<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /** Returns the number of write requests made to region */<a name="line.49"></a>
<span class="sourceLineNo">050</span> long getWriteRequestCount();<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /** Returns the number of coprocessor service requests made to region */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public long getCpRequestCount();<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Returns the number of write requests and read requests and coprocessor service requests made to<a name="line.56"></a>
<span class="sourceLineNo">057</span> * region<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> default long getRequestCount() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> return getReadRequestCount() + getWriteRequestCount() + getCpRequestCount();<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /** Returns the region name as a string */<a name="line.63"></a>
<span class="sourceLineNo">064</span> default String getNameAsString() {<a name="line.64"></a>
<span class="sourceLineNo">065</span> return Bytes.toStringBinary(getRegionName());<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> /** Returns the number of filtered read requests made to region */<a name="line.68"></a>
<span class="sourceLineNo">069</span> long getFilteredReadRequestCount();<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * TODO: why we pass the same value to different counters? Currently, the value from<a name="line.72"></a>
<span class="sourceLineNo">073</span> * getStoreFileIndexSize() is same with getStoreFileRootLevelIndexSize() see<a name="line.73"></a>
<span class="sourceLineNo">074</span> * HRegionServer#createRegionLoad.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @return The current total size of root-level indexes for the region<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> Size getStoreFileIndexSize();<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /** Returns The current total size of root-level indexes for the region */<a name="line.79"></a>
<span class="sourceLineNo">080</span> Size getStoreFileRootLevelIndexSize();<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /** Returns The total size of all index blocks, not just the root level */<a name="line.82"></a>
<span class="sourceLineNo">083</span> Size getStoreFileUncompressedDataIndexSize();<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /** Returns The total size of all Bloom filter blocks, not just loaded into the block cache */<a name="line.85"></a>
<span class="sourceLineNo">086</span> Size getBloomFilterSize();<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /** Returns the total number of cells in current compaction */<a name="line.88"></a>
<span class="sourceLineNo">089</span> long getCompactingCellCount();<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /** Returns the number of already compacted kvs in current compaction */<a name="line.91"></a>
<span class="sourceLineNo">092</span> long getCompactedCellCount();<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * This does not really belong inside RegionLoad but its being done in the name of expediency.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @return the completed sequence Id for the region<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> long getCompletedSequenceId();<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /** Returns completed sequence id per store. */<a name="line.100"></a>
<span class="sourceLineNo">101</span> Map&lt;byte[], Long&gt; getStoreSequenceId();<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> /** Returns the uncompressed size of the storefiles */<a name="line.103"></a>
<span class="sourceLineNo">104</span> Size getUncompressedStoreFileSize();<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /** Returns the data locality of region in the regionserver. */<a name="line.106"></a>
<span class="sourceLineNo">107</span> float getDataLocality();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> /** Returns the timestamp of the oldest hfile for any store of this region. */<a name="line.109"></a>
<span class="sourceLineNo">110</span> long getLastMajorCompactionTimestamp();<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> /** Returns the reference count for the stores of this region */<a name="line.112"></a>
<span class="sourceLineNo">113</span> int getStoreRefCount();<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * Returns the max reference count for any store file among all compacted stores files of this<a name="line.116"></a>
<span class="sourceLineNo">117</span> * region<a name="line.117"></a>
<span class="sourceLineNo">118</span> */<a name="line.118"></a>
<span class="sourceLineNo">119</span> int getMaxCompactedStoreFileRefCount();<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Different from dataLocality,this metric's numerator only include the data stored on ssd<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @return the data locality for ssd of region in the regionserver<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> float getDataLocalityForSsd();<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> /** Returns the data at local weight of this region in the regionserver */<a name="line.127"></a>
<span class="sourceLineNo">128</span> long getBlocksLocalWeight();<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> /**<a name="line.130"></a>
<span class="sourceLineNo">131</span> * Different from blocksLocalWeight,this metric's numerator only include the data stored on ssd<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @return the data at local with ssd weight of this region in the regionserver<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> long getBlocksLocalWithSsdWeight();<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /** Returns the block total weight of this region */<a name="line.136"></a>
<span class="sourceLineNo">137</span> long getBlocksTotalWeight();<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /** Returns the compaction state of this region */<a name="line.139"></a>
<span class="sourceLineNo">140</span> CompactionState getCompactionState();<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> /** Returns the total size of the hfiles in the region */<a name="line.142"></a>
<span class="sourceLineNo">143</span> Size getRegionSizeMB();<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> /** Returns current prefetch ratio of this region on this server */<a name="line.145"></a>
<span class="sourceLineNo">146</span> float getCurrentRegionCachedRatio();<a name="line.146"></a>
<span class="sourceLineNo">147</span>}<a name="line.147"></a>
</pre>
</div>
</body>
</html>