| <!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> * Copyright The Apache Software Foundation<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * contributor license agreements. See the NOTICE file distributed with this<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * work for additional information regarding copyright ownership. The ASF<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * licenses this file to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance with the License.<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * License for the specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<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.regionserver;<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.yetus.audience.InterfaceAudience;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * This interface will be implemented by a MetricsSource that will export metrics from<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * HeapMemoryManager in RegionServer into the hadoop metrics system.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> */<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>@InterfaceAudience.Private<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>public interface MetricsHeapMemoryManagerSource extends BaseSource {<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> /**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * The name of the metrics<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> String METRICS_NAME = "Memory";<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * The name of the metrics context that metrics will be under.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> String METRICS_CONTEXT = "regionserver";<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Description<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> String METRICS_DESCRIPTION = "Metrics about HBase RegionServer's memory";<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * The name of the metrics context that metrics will be under in jmx<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Update/Set the blocked flush count histogram/gauge<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @param blockedFlushCount the number of blocked flush since last tuning.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> void updateBlockedFlushCount(long blockedFlushCount);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Update/Set the unblocked flush count histogram/gauge<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param unblockedFlushCount the number of unblocked flush since last tuning.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> void updateUnblockedFlushCount(long unblockedFlushCount);<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> * Set the current blockcache size used gauge<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param blockCacheSize the current memory usage in blockcache, in bytes.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> void setCurBlockCacheSizeGauge(long blockCacheSize);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Set the current global memstore size used gauge<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param memStoreSize the current memory usage in memstore, in bytes.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> void setCurMemStoreSizeGauge(long memStoreSize);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Update the increase/decrease memstore size histogram<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param memStoreDeltaSize the tuning result of memstore.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> void updateMemStoreDeltaSizeHistogram(int memStoreDeltaSize);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Update the increase/decrease blockcache size histogram<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param blockCacheDeltaSize the tuning result of blockcache.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> void updateBlockCacheDeltaSizeHistogram(int blockCacheDeltaSize);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Increase the counter for tuner neither expanding memstore global size limit nor expanding<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * blockcache max size.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> void increaseTunerDoNothingCounter();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Increase the counter for heap occupancy percent above low watermark<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> void increaseAboveHeapOccupancyLowWatermarkCounter();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> // Histograms<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> String BLOCKED_FLUSH_NAME = "blockedFlushes";<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> String BLOCKED_FLUSH_DESC = "Histogram for the number of blocked flushes in the memstore";<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> String UNBLOCKED_FLUSH_NAME = "unblockedFlushes";<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> String UNBLOCKED_FLUSH_DESC = "Histogram for the number of unblocked flushes in the memstore";<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> String INC_MEMSTORE_TUNING_NAME = "increaseMemStoreSize";<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> String INC_MEMSTORE_TUNING_DESC =<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> "Histogram for the heap memory tuner expanding memstore global size limit in bytes";<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> String DEC_MEMSTORE_TUNING_NAME = "decreaseMemStoreSize";<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> String DEC_MEMSTORE_TUNING_DESC =<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> "Histogram for the heap memory tuner shrinking memstore global size limit in bytes";<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> String INC_BLOCKCACHE_TUNING_NAME = "increaseBlockCacheSize";<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> String INC_BLOCKCACHE_TUNING_DESC =<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> "Histogram for the heap memory tuner expanding blockcache max heap size in bytes";<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> String DEC_BLOCKCACHE_TUNING_NAME = "decreaseBlockCacheSize";<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> String DEC_BLOCKCACHE_TUNING_DESC =<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> "Histogram for the heap memory tuner shrinking blockcache max heap size in bytes";<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> // Gauges<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> String BLOCKED_FLUSH_GAUGE_NAME = "blockedFlushGauge";<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> String BLOCKED_FLUSH_GAUGE_DESC = "Gauge for the blocked flush count before tuning";<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> String UNBLOCKED_FLUSH_GAUGE_NAME = "unblockedFlushGauge";<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> String UNBLOCKED_FLUSH_GAUGE_DESC = "Gauge for the unblocked flush count before tuning";<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> String MEMSTORE_SIZE_GAUGE_NAME = "memStoreSize";<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> String MEMSTORE_SIZE_GAUGE_DESC = "Global MemStore used in bytes by the RegionServer";<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> String BLOCKCACHE_SIZE_GAUGE_NAME = "blockCacheSize";<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> String BLOCKCACHE_SIZE_GAUGE_DESC = "BlockCache used in bytes by the RegionServer";<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> // Counters<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> String DO_NOTHING_COUNTER_NAME = "tunerDoNothingCounter";<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> String DO_NOTHING_COUNTER_DESC =<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> "The number of times that tuner neither expands memstore global size limit nor expands " +<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> "blockcache max size";<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> String ABOVE_HEAP_LOW_WATERMARK_COUNTER_NAME = "aboveHeapOccupancyLowWaterMarkCounter";<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> String ABOVE_HEAP_LOW_WATERMARK_COUNTER_DESC =<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> "The number of times that heap occupancy percent is above low watermark";<a name="line.132"></a> |
| <span class="sourceLineNo">133</span>}<a name="line.133"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
