| <!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.metrics, class: BaseSourceImpl"> |
| <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.metrics;</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 org.apache.hadoop.hbase.metrics.impl.GlobalMetricRegistriesAdapter;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.metrics.impl.HBaseMetrics2HadoopMetricsAdapter;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.regionserver.MetricsRegionServerSourceImpl;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.metrics2.MetricsCollector;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.metrics2.MetricsSource;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.metrics2.impl.JmxCacheBuster;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.metrics2.lib.DynamicMetricsRegistry;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.metrics2.lib.MutableFastCounter;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.metrics2.lib.MutableGaugeLong;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.metrics2.lib.MutableHistogram;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.metrics2.source.JvmMetrics;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Hadoop 2 implementation of BaseSource (using metrics2 framework). It handles registration to</span> |
| <span class="source-line-no">036</span><span id="line-36"> * DefaultMetricsSystem and creation of the metrics registry. All MetricsSource's in</span> |
| <span class="source-line-no">037</span><span id="line-37"> * hbase-hadoop2-compat should derive from this class.</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39">@InterfaceAudience.Private</span> |
| <span class="source-line-no">040</span><span id="line-40">public class BaseSourceImpl implements BaseSource, MetricsSource {</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> @SuppressWarnings("ImmutableEnumChecker")</span> |
| <span class="source-line-no">043</span><span id="line-43"> private static enum DefaultMetricsSystemInitializer {</span> |
| <span class="source-line-no">044</span><span id="line-44"> INSTANCE;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> private boolean inited = false;</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> synchronized void init(String name) {</span> |
| <span class="source-line-no">049</span><span id="line-49"> if (inited) {</span> |
| <span class="source-line-no">050</span><span id="line-50"> return;</span> |
| <span class="source-line-no">051</span><span id="line-51"> }</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> inited = true;</span> |
| <span class="source-line-no">054</span><span id="line-54"> DefaultMetricsSystem.initialize(HBASE_METRICS_SYSTEM_NAME);</span> |
| <span class="source-line-no">055</span><span id="line-55"> JvmMetrics.initSingleton(name, "");</span> |
| <span class="source-line-no">056</span><span id="line-56"> // initialize hbase-metrics module based metric system as well. GlobalMetricRegistriesSource</span> |
| <span class="source-line-no">057</span><span id="line-57"> // initialization depends on the metric system being already initialized, that is why we are</span> |
| <span class="source-line-no">058</span><span id="line-58"> // doing it here. Once BaseSourceSourceImpl is removed, we should do the initialization of</span> |
| <span class="source-line-no">059</span><span id="line-59"> // these elsewhere.</span> |
| <span class="source-line-no">060</span><span id="line-60"> GlobalMetricRegistriesAdapter.init();</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"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @deprecated Use hbase-metrics/hbase-metrics-api module interfaces for new metrics. Defining</span> |
| <span class="source-line-no">066</span><span id="line-66"> * BaseSources for new metric groups (WAL, RPC, etc) is not needed anymore, however,</span> |
| <span class="source-line-no">067</span><span id="line-67"> * for existing {@link BaseSource} implementations, please use the field named</span> |
| <span class="source-line-no">068</span><span id="line-68"> * "registry" which is a {@link MetricRegistry} instance together with the</span> |
| <span class="source-line-no">069</span><span id="line-69"> * {@link HBaseMetrics2HadoopMetricsAdapter}.</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> @Deprecated</span> |
| <span class="source-line-no">072</span><span id="line-72"> protected final DynamicMetricsRegistry metricsRegistry;</span> |
| <span class="source-line-no">073</span><span id="line-73"> protected final String metricsName;</span> |
| <span class="source-line-no">074</span><span id="line-74"> protected final String metricsDescription;</span> |
| <span class="source-line-no">075</span><span id="line-75"> protected final String metricsContext;</span> |
| <span class="source-line-no">076</span><span id="line-76"> protected final String metricsJmxContext;</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> /**</span> |
| <span class="source-line-no">079</span><span id="line-79"> * Note that there are at least 4 MetricRegistry definitions in the source code. The first one is</span> |
| <span class="source-line-no">080</span><span id="line-80"> * Hadoop Metrics2 MetricRegistry, second one is DynamicMetricsRegistry which is HBase's fork of</span> |
| <span class="source-line-no">081</span><span id="line-81"> * the Hadoop metrics2 class. The third one is the dropwizard metrics implementation of</span> |
| <span class="source-line-no">082</span><span id="line-82"> * MetricRegistry, and finally a new API abstraction in HBase that is the</span> |
| <span class="source-line-no">083</span><span id="line-83"> * o.a.h.h.metrics.MetricRegistry class. This last one is the new way to use metrics within the</span> |
| <span class="source-line-no">084</span><span id="line-84"> * HBase code. However, the others are in play because of existing metrics2 based code still needs</span> |
| <span class="source-line-no">085</span><span id="line-85"> * to coexists until we get rid of all of our BaseSource and convert them to the new framework.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Until that happens, new metrics can use the new API, but will be collected through the</span> |
| <span class="source-line-no">087</span><span id="line-87"> * HBaseMetrics2HadoopMetricsAdapter class. BaseSourceImpl has two MetricRegistries.</span> |
| <span class="source-line-no">088</span><span id="line-88"> * metricRegistry is for hadoop Metrics2 based metrics, while the registry is for hbase-metrics</span> |
| <span class="source-line-no">089</span><span id="line-89"> * based metrics.</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> protected final MetricRegistry registry;</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * The adapter from hbase-metrics module to metrics2. This adepter is the connection between the</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Metrics in the MetricRegistry and the Hadoop Metrics2 system. Using this adapter, existing</span> |
| <span class="source-line-no">096</span><span id="line-96"> * BaseSource implementations can define new metrics using the hbase-metrics/hbase-metrics-api</span> |
| <span class="source-line-no">097</span><span id="line-97"> * module interfaces and still be able to make use of metrics2 sinks (including JMX). Existing</span> |
| <span class="source-line-no">098</span><span id="line-98"> * BaseSources should call metricsAdapter.snapshotAllMetrics() in getMetrics() method. See</span> |
| <span class="source-line-no">099</span><span id="line-99"> * {@link MetricsRegionServerSourceImpl}.</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> protected final HBaseMetrics2HadoopMetricsAdapter metricsAdapter;</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> public BaseSourceImpl(String metricsName, String metricsDescription, String metricsContext,</span> |
| <span class="source-line-no">104</span><span id="line-104"> String metricsJmxContext) {</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> this.metricsName = metricsName;</span> |
| <span class="source-line-no">107</span><span id="line-107"> this.metricsDescription = metricsDescription;</span> |
| <span class="source-line-no">108</span><span id="line-108"> this.metricsContext = metricsContext;</span> |
| <span class="source-line-no">109</span><span id="line-109"> this.metricsJmxContext = metricsJmxContext;</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> metricsRegistry = new DynamicMetricsRegistry(metricsName).setContext(metricsContext);</span> |
| <span class="source-line-no">112</span><span id="line-112"> DefaultMetricsSystemInitializer.INSTANCE.init(metricsName);</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> // Register this instance.</span> |
| <span class="source-line-no">115</span><span id="line-115"> DefaultMetricsSystem.instance().register(metricsJmxContext, metricsDescription, this);</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> // hbase-metrics module based metrics are registered in the hbase MetricsRegistry.</span> |
| <span class="source-line-no">118</span><span id="line-118"> registry = MetricRegistries.global().create(this.getMetricRegistryInfo());</span> |
| <span class="source-line-no">119</span><span id="line-119"> metricsAdapter = new HBaseMetrics2HadoopMetricsAdapter();</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> init();</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> @Override</span> |
| <span class="source-line-no">126</span><span id="line-126"> public void init() {</span> |
| <span class="source-line-no">127</span><span id="line-127"> this.metricsRegistry.clearMetrics();</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</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"> * Set a single gauge to a value.</span> |
| <span class="source-line-no">132</span><span id="line-132"> * @param gaugeName gauge name</span> |
| <span class="source-line-no">133</span><span id="line-133"> * @param value the new value of the gauge.</span> |
| <span class="source-line-no">134</span><span id="line-134"> */</span> |
| <span class="source-line-no">135</span><span id="line-135"> @Override</span> |
| <span class="source-line-no">136</span><span id="line-136"> public void setGauge(String gaugeName, long value) {</span> |
| <span class="source-line-no">137</span><span id="line-137"> MutableGaugeLong gaugeInt = metricsRegistry.getGauge(gaugeName, value);</span> |
| <span class="source-line-no">138</span><span id="line-138"> gaugeInt.set(value);</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * Add some amount to a gauge.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @param gaugeName The name of the gauge to increment.</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @param delta The amount to increment the gauge by.</span> |
| <span class="source-line-no">145</span><span id="line-145"> */</span> |
| <span class="source-line-no">146</span><span id="line-146"> @Override</span> |
| <span class="source-line-no">147</span><span id="line-147"> public void incGauge(String gaugeName, long delta) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> MutableGaugeLong gaugeInt = metricsRegistry.getGauge(gaugeName, 0L);</span> |
| <span class="source-line-no">149</span><span id="line-149"> gaugeInt.incr(delta);</span> |
| <span class="source-line-no">150</span><span id="line-150"> }</span> |
| <span class="source-line-no">151</span><span id="line-151"></span> |
| <span class="source-line-no">152</span><span id="line-152"> /**</span> |
| <span class="source-line-no">153</span><span id="line-153"> * Decrease the value of a named gauge.</span> |
| <span class="source-line-no">154</span><span id="line-154"> * @param gaugeName The name of the gauge.</span> |
| <span class="source-line-no">155</span><span id="line-155"> * @param delta the ammount to subtract from a gauge value.</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> @Override</span> |
| <span class="source-line-no">158</span><span id="line-158"> public void decGauge(String gaugeName, long delta) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> MutableGaugeLong gaugeInt = metricsRegistry.getGauge(gaugeName, 0L);</span> |
| <span class="source-line-no">160</span><span id="line-160"> gaugeInt.decr(delta);</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> /**</span> |
| <span class="source-line-no">164</span><span id="line-164"> * Increment a named counter by some value.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @param key the name of the counter</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @param delta the ammount to increment</span> |
| <span class="source-line-no">167</span><span id="line-167"> */</span> |
| <span class="source-line-no">168</span><span id="line-168"> @Override</span> |
| <span class="source-line-no">169</span><span id="line-169"> public void incCounters(String key, long delta) {</span> |
| <span class="source-line-no">170</span><span id="line-170"> MutableFastCounter counter = metricsRegistry.getCounter(key, 0L);</span> |
| <span class="source-line-no">171</span><span id="line-171"> counter.incr(delta);</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> @Override</span> |
| <span class="source-line-no">176</span><span id="line-176"> public void updateHistogram(String name, long value) {</span> |
| <span class="source-line-no">177</span><span id="line-177"> MutableHistogram histo = metricsRegistry.getHistogram(name);</span> |
| <span class="source-line-no">178</span><span id="line-178"> histo.add(value);</span> |
| <span class="source-line-no">179</span><span id="line-179"> }</span> |
| <span class="source-line-no">180</span><span id="line-180"></span> |
| <span class="source-line-no">181</span><span id="line-181"> /**</span> |
| <span class="source-line-no">182</span><span id="line-182"> * Remove a named gauge.</span> |
| <span class="source-line-no">183</span><span id="line-183"> * @param key the key of the gauge to remove</span> |
| <span class="source-line-no">184</span><span id="line-184"> */</span> |
| <span class="source-line-no">185</span><span id="line-185"> @Override</span> |
| <span class="source-line-no">186</span><span id="line-186"> public void removeMetric(String key) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> metricsRegistry.removeMetric(key);</span> |
| <span class="source-line-no">188</span><span id="line-188"> JmxCacheBuster.clearJmxCache();</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"></span> |
| <span class="source-line-no">191</span><span id="line-191"> @Override</span> |
| <span class="source-line-no">192</span><span id="line-192"> public void getMetrics(MetricsCollector metricsCollector, boolean all) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> metricsRegistry.snapshot(metricsCollector.addRecord(metricsRegistry.info()), all);</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> public DynamicMetricsRegistry getMetricsRegistry() {</span> |
| <span class="source-line-no">197</span><span id="line-197"> return metricsRegistry;</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"></span> |
| <span class="source-line-no">200</span><span id="line-200"> @Override</span> |
| <span class="source-line-no">201</span><span id="line-201"> public String getMetricsContext() {</span> |
| <span class="source-line-no">202</span><span id="line-202"> return metricsContext;</span> |
| <span class="source-line-no">203</span><span id="line-203"> }</span> |
| <span class="source-line-no">204</span><span id="line-204"></span> |
| <span class="source-line-no">205</span><span id="line-205"> @Override</span> |
| <span class="source-line-no">206</span><span id="line-206"> public String getMetricsDescription() {</span> |
| <span class="source-line-no">207</span><span id="line-207"> return metricsDescription;</span> |
| <span class="source-line-no">208</span><span id="line-208"> }</span> |
| <span class="source-line-no">209</span><span id="line-209"></span> |
| <span class="source-line-no">210</span><span id="line-210"> @Override</span> |
| <span class="source-line-no">211</span><span id="line-211"> public String getMetricsJmxContext() {</span> |
| <span class="source-line-no">212</span><span id="line-212"> return metricsJmxContext;</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"></span> |
| <span class="source-line-no">215</span><span id="line-215"> @Override</span> |
| <span class="source-line-no">216</span><span id="line-216"> public String getMetricsName() {</span> |
| <span class="source-line-no">217</span><span id="line-217"> return metricsName;</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219"></span> |
| <span class="source-line-no">220</span><span id="line-220">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
