blob: dd9da44b5069a3e310f839ddf2ada5978e11b7ff [file] [log] [blame]
<!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>package org.apache.hadoop.hbase.slowlog;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.ArrayList;<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.Random;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HConstants;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.Durability;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Put;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Table;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.TooSlowLog;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.Logger;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.slf4j.LoggerFactory;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>/**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Slowlog Accessor to record slow/large RPC log identified at each RegionServer RpcServer level.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * This can be done only optionally to record the entire history of slow/large rpc calls<a name="line.44"></a>
<span class="sourceLineNo">045</span> * since RingBuffer can handle only limited latest records.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>@InterfaceAudience.Private<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class SlowLogTableAccessor {<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final Logger LOG = LoggerFactory.getLogger(SlowLogTableAccessor.class);<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final Random RANDOM = new Random();<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private static Connection connection;<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> * hbase:slowlog table name - can be enabled<a name="line.57"></a>
<span class="sourceLineNo">058</span> * with config - hbase.regionserver.slowlog.systable.enabled<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static final TableName SLOW_LOG_TABLE_NAME =<a name="line.60"></a>
<span class="sourceLineNo">061</span> TableName.valueOf(NamespaceDescriptor.SYSTEM_NAMESPACE_NAME_STR, "slowlog");<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private static void doPut(final Connection connection, final List&lt;Put&gt; puts)<a name="line.63"></a>
<span class="sourceLineNo">064</span> throws IOException {<a name="line.64"></a>
<span class="sourceLineNo">065</span> try (Table table = connection.getTable(SLOW_LOG_TABLE_NAME)) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> table.put(puts);<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><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Add slow/large log records to hbase:slowlog table<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param slowLogPayloads List of SlowLogPayload to process<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param configuration Configuration to use for connection<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public static void addSlowLogRecords(final List&lt;TooSlowLog.SlowLogPayload&gt; slowLogPayloads,<a name="line.75"></a>
<span class="sourceLineNo">076</span> final Configuration configuration) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> List&lt;Put&gt; puts = new ArrayList&lt;&gt;(slowLogPayloads.size());<a name="line.77"></a>
<span class="sourceLineNo">078</span> for (TooSlowLog.SlowLogPayload slowLogPayload : slowLogPayloads) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> final byte[] rowKey = getRowKey(slowLogPayload);<a name="line.79"></a>
<span class="sourceLineNo">080</span> final Put put = new Put(rowKey).setDurability(Durability.SKIP_WAL)<a name="line.80"></a>
<span class="sourceLineNo">081</span> .setPriority(HConstants.NORMAL_QOS)<a name="line.81"></a>
<span class="sourceLineNo">082</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("call_details"),<a name="line.82"></a>
<span class="sourceLineNo">083</span> Bytes.toBytes(slowLogPayload.getCallDetails()))<a name="line.83"></a>
<span class="sourceLineNo">084</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("client_address"),<a name="line.84"></a>
<span class="sourceLineNo">085</span> Bytes.toBytes(slowLogPayload.getClientAddress()))<a name="line.85"></a>
<span class="sourceLineNo">086</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("method_name"),<a name="line.86"></a>
<span class="sourceLineNo">087</span> Bytes.toBytes(slowLogPayload.getMethodName()))<a name="line.87"></a>
<span class="sourceLineNo">088</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("param"),<a name="line.88"></a>
<span class="sourceLineNo">089</span> Bytes.toBytes(slowLogPayload.getParam()))<a name="line.89"></a>
<span class="sourceLineNo">090</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("processing_time"),<a name="line.90"></a>
<span class="sourceLineNo">091</span> Bytes.toBytes(Integer.toString(slowLogPayload.getProcessingTime())))<a name="line.91"></a>
<span class="sourceLineNo">092</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("queue_time"),<a name="line.92"></a>
<span class="sourceLineNo">093</span> Bytes.toBytes(Integer.toString(slowLogPayload.getQueueTime())))<a name="line.93"></a>
<span class="sourceLineNo">094</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("region_name"),<a name="line.94"></a>
<span class="sourceLineNo">095</span> Bytes.toBytes(slowLogPayload.getRegionName()))<a name="line.95"></a>
<span class="sourceLineNo">096</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("response_size"),<a name="line.96"></a>
<span class="sourceLineNo">097</span> Bytes.toBytes(Long.toString(slowLogPayload.getResponseSize())))<a name="line.97"></a>
<span class="sourceLineNo">098</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("server_class"),<a name="line.98"></a>
<span class="sourceLineNo">099</span> Bytes.toBytes(slowLogPayload.getServerClass()))<a name="line.99"></a>
<span class="sourceLineNo">100</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("start_time"),<a name="line.100"></a>
<span class="sourceLineNo">101</span> Bytes.toBytes(Long.toString(slowLogPayload.getStartTime())))<a name="line.101"></a>
<span class="sourceLineNo">102</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("type"),<a name="line.102"></a>
<span class="sourceLineNo">103</span> Bytes.toBytes(slowLogPayload.getType().name()))<a name="line.103"></a>
<span class="sourceLineNo">104</span> .addColumn(HConstants.SLOWLOG_INFO_FAMILY, Bytes.toBytes("username"),<a name="line.104"></a>
<span class="sourceLineNo">105</span> Bytes.toBytes(slowLogPayload.getUserName()));<a name="line.105"></a>
<span class="sourceLineNo">106</span> puts.add(put);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> try {<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (connection == null) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> createConnection(configuration);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> doPut(connection, puts);<a name="line.112"></a>
<span class="sourceLineNo">113</span> } catch (Exception e) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> LOG.warn("Failed to add slow/large log records to hbase:slowlog table.", e);<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> private static synchronized void createConnection(Configuration configuration)<a name="line.118"></a>
<span class="sourceLineNo">119</span> throws IOException {<a name="line.119"></a>
<span class="sourceLineNo">120</span> Configuration conf = new Configuration(configuration);<a name="line.120"></a>
<span class="sourceLineNo">121</span> // rpc timeout: 20s<a name="line.121"></a>
<span class="sourceLineNo">122</span> conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, 20000);<a name="line.122"></a>
<span class="sourceLineNo">123</span> // retry count: 5<a name="line.123"></a>
<span class="sourceLineNo">124</span> conf.setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 5);<a name="line.124"></a>
<span class="sourceLineNo">125</span> conf.setInt(HConstants.HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER, 1);<a name="line.125"></a>
<span class="sourceLineNo">126</span> connection = ConnectionFactory.createConnection(conf);<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Create rowKey: currentTimeMillis APPEND slowLogPayload.hashcode<a name="line.130"></a>
<span class="sourceLineNo">131</span> * Scan on slowlog table should keep records with sorted order of time, however records<a name="line.131"></a>
<span class="sourceLineNo">132</span> * added at the very same time (currentTimeMillis) could be in random order.<a name="line.132"></a>
<span class="sourceLineNo">133</span> *<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @param slowLogPayload SlowLogPayload to process<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @return rowKey byte[]<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> private static byte[] getRowKey(final TooSlowLog.SlowLogPayload slowLogPayload) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> String hashcode = String.valueOf(slowLogPayload.hashCode());<a name="line.138"></a>
<span class="sourceLineNo">139</span> String lastFiveDig =<a name="line.139"></a>
<span class="sourceLineNo">140</span> hashcode.substring((hashcode.length() &gt; 5) ? (hashcode.length() - 5) : 0);<a name="line.140"></a>
<span class="sourceLineNo">141</span> if (lastFiveDig.startsWith("-")) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> lastFiveDig = String.valueOf(RANDOM.nextInt(99999));<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> final long currentTimeMillis = EnvironmentEdgeManager.currentTime();<a name="line.144"></a>
<span class="sourceLineNo">145</span> final String timeAndHashcode = currentTimeMillis + lastFiveDig;<a name="line.145"></a>
<span class="sourceLineNo">146</span> final long rowKeyLong = Long.parseLong(timeAndHashcode);<a name="line.146"></a>
<span class="sourceLineNo">147</span> return Bytes.toBytes(rowKeyLong);<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>}<a name="line.150"></a>
</pre>
</div>
</body>
</html>