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