blob: b9ad6a81150432c1450448e9b80d323a9efb07e1 [file] [log] [blame]
<!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.thrift, class: ThriftMetrics">
<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.thrift;</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.conf.Configuration;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.CallDroppedException;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.CallQueueTooBigException;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.CompatibilitySingletonFactory;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.MultiActionResultTooLarge;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.NotServingRegionException;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.RegionTooBusyException;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.UnknownScannerException;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.exceptions.FailedSanityCheckException;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.exceptions.OutOfOrderScannerNextException;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.exceptions.RegionMovedException;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.exceptions.RequestTooBigException;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.exceptions.ScannerResetException;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.quotas.QuotaExceededException;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.quotas.RpcThrottlingException;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.thrift.generated.IOError;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.thrift2.generated.TIOError;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">039</span><span id="line-39">import org.slf4j.Logger;</span>
<span class="source-line-no">040</span><span id="line-40">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42">/**</span>
<span class="source-line-no">043</span><span id="line-43"> * This class is for maintaining the various statistics of thrift server and publishing them through</span>
<span class="source-line-no">044</span><span id="line-44"> * the metrics interfaces.</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46">@InterfaceAudience.Private</span>
<span class="source-line-no">047</span><span id="line-47">public class ThriftMetrics {</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private static final Logger LOG = LoggerFactory.getLogger(ThriftMetrics.class);</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> public enum ThriftServerType {</span>
<span class="source-line-no">052</span><span id="line-52"> ONE,</span>
<span class="source-line-no">053</span><span id="line-53"> TWO</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"> public MetricsThriftServerSource getSource() {</span>
<span class="source-line-no">057</span><span id="line-57"> return source;</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> public void setSource(MetricsThriftServerSource source) {</span>
<span class="source-line-no">061</span><span id="line-61"> this.source = source;</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"> protected MetricsThriftServerSource source;</span>
<span class="source-line-no">065</span><span id="line-65"> protected final long slowResponseTime;</span>
<span class="source-line-no">066</span><span id="line-66"> public static final String SLOW_RESPONSE_NANO_SEC = "hbase.thrift.slow.response.nano.second";</span>
<span class="source-line-no">067</span><span id="line-67"> public static final long DEFAULT_SLOW_RESPONSE_NANO_SEC = 10 * 1000 * 1000;</span>
<span class="source-line-no">068</span><span id="line-68"> private final ThriftServerType thriftServerType;</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> public ThriftMetrics(Configuration conf, ThriftServerType t) {</span>
<span class="source-line-no">071</span><span id="line-71"> slowResponseTime = conf.getLong(SLOW_RESPONSE_NANO_SEC, DEFAULT_SLOW_RESPONSE_NANO_SEC);</span>
<span class="source-line-no">072</span><span id="line-72"> thriftServerType = t;</span>
<span class="source-line-no">073</span><span id="line-73"> if (t == ThriftServerType.ONE) {</span>
<span class="source-line-no">074</span><span id="line-74"> source = CompatibilitySingletonFactory.getInstance(MetricsThriftServerSourceFactory.class)</span>
<span class="source-line-no">075</span><span id="line-75"> .createThriftOneSource();</span>
<span class="source-line-no">076</span><span id="line-76"> } else if (t == ThriftServerType.TWO) {</span>
<span class="source-line-no">077</span><span id="line-77"> source = CompatibilitySingletonFactory.getInstance(MetricsThriftServerSourceFactory.class)</span>
<span class="source-line-no">078</span><span id="line-78"> .createThriftTwoSource();</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> public void incTimeInQueue(long time) {</span>
<span class="source-line-no">084</span><span id="line-84"> source.incTimeInQueue(time);</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> public void setCallQueueLen(int len) {</span>
<span class="source-line-no">088</span><span id="line-88"> source.setCallQueueLen(len);</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> public void incNumRowKeysInBatchGet(int diff) {</span>
<span class="source-line-no">092</span><span id="line-92"> source.incNumRowKeysInBatchGet(diff);</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"> public void incNumRowKeysInBatchMutate(int diff) {</span>
<span class="source-line-no">096</span><span id="line-96"> source.incNumRowKeysInBatchMutate(diff);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> public void incMethodTime(String name, long time) {</span>
<span class="source-line-no">100</span><span id="line-100"> source.incMethodTime(name, time);</span>
<span class="source-line-no">101</span><span id="line-101"> // inc general processTime</span>
<span class="source-line-no">102</span><span id="line-102"> source.incCall(time);</span>
<span class="source-line-no">103</span><span id="line-103"> if (time &gt; slowResponseTime) {</span>
<span class="source-line-no">104</span><span id="line-104"> source.incSlowCall(time);</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> public void incActiveWorkerCount() {</span>
<span class="source-line-no">109</span><span id="line-109"> source.incActiveWorkerCount();</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> public void decActiveWorkerCount() {</span>
<span class="source-line-no">113</span><span id="line-113"> source.decActiveWorkerCount();</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"> /**</span>
<span class="source-line-no">117</span><span id="line-117"> * Increment the count for a specific exception type. This is called for each exception type that</span>
<span class="source-line-no">118</span><span id="line-118"> * is returned to the thrift handler.</span>
<span class="source-line-no">119</span><span id="line-119"> * @param rawThrowable type of exception</span>
<span class="source-line-no">120</span><span id="line-120"> */</span>
<span class="source-line-no">121</span><span id="line-121"> public void exception(Throwable rawThrowable) {</span>
<span class="source-line-no">122</span><span id="line-122"> source.exception();</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> Throwable throwable = unwrap(rawThrowable);</span>
<span class="source-line-no">125</span><span id="line-125"> /**</span>
<span class="source-line-no">126</span><span id="line-126"> * Keep some metrics for commonly seen exceptions Try and put the most common types first. Place</span>
<span class="source-line-no">127</span><span id="line-127"> * child types before the parent type that they extend. If this gets much larger we might have</span>
<span class="source-line-no">128</span><span id="line-128"> * to go to a hashmap</span>
<span class="source-line-no">129</span><span id="line-129"> */</span>
<span class="source-line-no">130</span><span id="line-130"> if (throwable != null) {</span>
<span class="source-line-no">131</span><span id="line-131"> if (throwable instanceof OutOfOrderScannerNextException) {</span>
<span class="source-line-no">132</span><span id="line-132"> source.outOfOrderException();</span>
<span class="source-line-no">133</span><span id="line-133"> } else if (throwable instanceof RegionTooBusyException) {</span>
<span class="source-line-no">134</span><span id="line-134"> source.tooBusyException();</span>
<span class="source-line-no">135</span><span id="line-135"> } else if (throwable instanceof UnknownScannerException) {</span>
<span class="source-line-no">136</span><span id="line-136"> source.unknownScannerException();</span>
<span class="source-line-no">137</span><span id="line-137"> } else if (throwable instanceof ScannerResetException) {</span>
<span class="source-line-no">138</span><span id="line-138"> source.scannerResetException();</span>
<span class="source-line-no">139</span><span id="line-139"> } else if (throwable instanceof RegionMovedException) {</span>
<span class="source-line-no">140</span><span id="line-140"> source.movedRegionException();</span>
<span class="source-line-no">141</span><span id="line-141"> } else if (throwable instanceof NotServingRegionException) {</span>
<span class="source-line-no">142</span><span id="line-142"> source.notServingRegionException();</span>
<span class="source-line-no">143</span><span id="line-143"> } else if (throwable instanceof FailedSanityCheckException) {</span>
<span class="source-line-no">144</span><span id="line-144"> source.failedSanityException();</span>
<span class="source-line-no">145</span><span id="line-145"> } else if (throwable instanceof MultiActionResultTooLarge) {</span>
<span class="source-line-no">146</span><span id="line-146"> source.multiActionTooLargeException();</span>
<span class="source-line-no">147</span><span id="line-147"> } else if (throwable instanceof CallQueueTooBigException) {</span>
<span class="source-line-no">148</span><span id="line-148"> source.callQueueTooBigException();</span>
<span class="source-line-no">149</span><span id="line-149"> } else if (throwable instanceof QuotaExceededException) {</span>
<span class="source-line-no">150</span><span id="line-150"> source.quotaExceededException();</span>
<span class="source-line-no">151</span><span id="line-151"> } else if (throwable instanceof RpcThrottlingException) {</span>
<span class="source-line-no">152</span><span id="line-152"> source.rpcThrottlingException();</span>
<span class="source-line-no">153</span><span id="line-153"> } else if (throwable instanceof CallDroppedException) {</span>
<span class="source-line-no">154</span><span id="line-154"> source.callDroppedException();</span>
<span class="source-line-no">155</span><span id="line-155"> } else if (throwable instanceof RequestTooBigException) {</span>
<span class="source-line-no">156</span><span id="line-156"> source.requestTooBigException();</span>
<span class="source-line-no">157</span><span id="line-157"> } else {</span>
<span class="source-line-no">158</span><span id="line-158"> source.otherExceptions();</span>
<span class="source-line-no">159</span><span id="line-159"> if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">160</span><span id="line-160"> LOG.debug("Unknown exception type", throwable);</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"> }</span>
<span class="source-line-no">165</span><span id="line-165"></span>
<span class="source-line-no">166</span><span id="line-166"> protected static Throwable unwrap(Throwable t) {</span>
<span class="source-line-no">167</span><span id="line-167"> if (t == null) {</span>
<span class="source-line-no">168</span><span id="line-168"> return t;</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"> if (t instanceof TIOError || t instanceof IOError) {</span>
<span class="source-line-no">171</span><span id="line-171"> t = t.getCause();</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"> return ClientExceptionsUtil.findException(t);</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> public ThriftServerType getThriftServerType() {</span>
<span class="source-line-no">177</span><span id="line-177"> return thriftServerType;</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179">}</span>
</pre>
</div>
</main>
</body>
</html>