| <!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> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * 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<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. 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,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>package org.apache.hadoop.hbase.coprocessor.example;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Optional;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.ThreadLocalRandom;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Cell;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.Get;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.coprocessor.ObserverContext;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessor;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.coprocessor.RegionObserver;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.metrics.Counter;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.metrics.Timer;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.regionserver.FlushLifeCycleTracker;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.regionserver.Store;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.StoreFile;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span>/**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * An example coprocessor that collects some metrics to demonstrate the usage of exporting custom<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * metrics from the coprocessor.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * These metrics will be available through the regular Hadoop metrics2 sinks (ganglia, opentsdb,<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * etc) as well as JMX output. You can view a snapshot of the metrics by going to the http web UI<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * of the regionserver page, something like http://myregionserverhost:16030/jmx<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * </p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> *<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @see ExampleMasterObserverWithMetrics<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>@InterfaceAudience.Private<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>public class ExampleRegionObserverWithMetrics implements RegionCoprocessor {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private Counter preGetCounter;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private Counter flushCounter;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private Counter filesCompactedCounter;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private Timer costlyOperationTimer;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private ExampleRegionObserver observer;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> class ExampleRegionObserver implements RegionCoprocessor, RegionObserver {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @Override<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public Optional<RegionObserver> getRegionObserver() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return Optional.of(this);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> @Override<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public void preGetOp(ObserverContext<RegionCoprocessorEnvironment> e, Get get,<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> List<Cell> results) throws IOException {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> // Increment the Counter whenever the coprocessor is called<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> preGetCounter.increment();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @Override<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public void postGetOp(ObserverContext<RegionCoprocessorEnvironment> e, Get get,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> List<Cell> results) throws IOException {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> // do a costly (high latency) operation which we want to measure how long it takes by<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // using a Timer (which is a Meter and a Histogram).<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> long start = System.nanoTime();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> try {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> performCostlyOperation();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> } finally {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> costlyOperationTimer.updateNanos(System.nanoTime() - start);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<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> @Override<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public void postFlush(<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> FlushLifeCycleTracker tracker) throws IOException {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> flushCounter.increment();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @Override<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public void postFlush(<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> ObserverContext<RegionCoprocessorEnvironment> c, Store store, StoreFile resultFile,<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> FlushLifeCycleTracker tracker) throws IOException {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> flushCounter.increment();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> @Override<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public void postCompactSelection(<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> List<? extends StoreFile> selected, CompactionLifeCycleTracker tracker,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> CompactionRequest request) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (selected != null) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> filesCompactedCounter.increment(selected.size());<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<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> private void performCostlyOperation() {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> try {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // simulate the operation by sleeping.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> Thread.sleep(ThreadLocalRandom.current().nextLong(100));<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> } catch (InterruptedException ignore) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<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><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> @Override public Optional<RegionObserver> getRegionObserver() {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return Optional.of(observer);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> @Override<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public void start(CoprocessorEnvironment env) throws IOException {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> // start for the RegionServerObserver will be called only once in the lifetime of the<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> // server. We will construct and register all metrics that we will track across method<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> // invocations.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (env instanceof RegionCoprocessorEnvironment) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> // Obtain the MetricRegistry for the RegionServer. Metrics from this registry will be reported<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> // at the region server level per-regionserver.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> MetricRegistry registry =<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> ((RegionCoprocessorEnvironment) env).getMetricRegistryForRegionServer();<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> observer = new ExampleRegionObserver();<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (preGetCounter == null) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> // Create a new Counter, or get the already registered counter.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> // It is much better to only call this once and save the Counter as a class field instead<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // of creating the counter every time a coprocessor method is invoked. This will negate<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> // any performance bottleneck coming from map lookups tracking metrics in the registry.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> // Returned counter instance is shared by all coprocessors of the same class in the same<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // region server.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> preGetCounter = registry.counter("preGetRequests");<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (costlyOperationTimer == null) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> // Create a Timer to track execution times for the costly operation.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> costlyOperationTimer = registry.timer("costlyOperation");<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> if (flushCounter == null) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> // Track the number of flushes that have completed<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> flushCounter = registry.counter("flushesCompleted");<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (filesCompactedCounter == null) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> // Track the number of files that were compacted (many files may be rewritten in a single<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> // compaction).<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> filesCompactedCounter = registry.counter("filesCompacted");<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> @Override<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public void stop(CoprocessorEnvironment e) throws IOException {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> // we should NOT remove / deregister the metrics in stop(). The whole registry will be<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // removed when the last region of the table is closed.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span>}<a name="line.173"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
