blob: 212397f5bdbc7b26c2b979a858b08ebf59e310ec [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.namequeues, class: RpcLogDetails">
<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.namequeues;</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 java.util.Map;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.commons.lang3.builder.ToStringBuilder;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.ipc.RpcCall;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24">import org.slf4j.Logger;</span>
<span class="source-line-no">025</span><span id="line-25">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * RpcCall details that would be passed on to ring buffer of slow log responses</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
<span class="source-line-no">034</span><span id="line-34">public class RpcLogDetails extends NamedQueuePayload {</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> public static final int SLOW_LOG_EVENT = 0;</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38"> private static final Logger LOG = LoggerFactory.getLogger(RpcLogDetails.class.getName());</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> private final RpcCall rpcCall;</span>
<span class="source-line-no">041</span><span id="line-41"> private Message param;</span>
<span class="source-line-no">042</span><span id="line-42"> private final String clientAddress;</span>
<span class="source-line-no">043</span><span id="line-43"> private final long responseSize;</span>
<span class="source-line-no">044</span><span id="line-44"> private final long blockBytesScanned;</span>
<span class="source-line-no">045</span><span id="line-45"> private final long fsReadTime;</span>
<span class="source-line-no">046</span><span id="line-46"> private final String className;</span>
<span class="source-line-no">047</span><span id="line-47"> private final boolean isSlowLog;</span>
<span class="source-line-no">048</span><span id="line-48"> private final boolean isLargeLog;</span>
<span class="source-line-no">049</span><span id="line-49"> private final Map&lt;String, byte[]&gt; connectionAttributes;</span>
<span class="source-line-no">050</span><span id="line-50"> private final Map&lt;String, byte[]&gt; requestAttributes;</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> public RpcLogDetails(RpcCall rpcCall, Message param, String clientAddress, long responseSize,</span>
<span class="source-line-no">053</span><span id="line-53"> long blockBytesScanned, long fsReadTime, String className, boolean isSlowLog,</span>
<span class="source-line-no">054</span><span id="line-54"> boolean isLargeLog) {</span>
<span class="source-line-no">055</span><span id="line-55"> super(SLOW_LOG_EVENT);</span>
<span class="source-line-no">056</span><span id="line-56"> this.rpcCall = rpcCall;</span>
<span class="source-line-no">057</span><span id="line-57"> this.clientAddress = clientAddress;</span>
<span class="source-line-no">058</span><span id="line-58"> this.responseSize = responseSize;</span>
<span class="source-line-no">059</span><span id="line-59"> this.blockBytesScanned = blockBytesScanned;</span>
<span class="source-line-no">060</span><span id="line-60"> this.fsReadTime = fsReadTime;</span>
<span class="source-line-no">061</span><span id="line-61"> this.className = className;</span>
<span class="source-line-no">062</span><span id="line-62"> this.isSlowLog = isSlowLog;</span>
<span class="source-line-no">063</span><span id="line-63"> this.isLargeLog = isLargeLog;</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> // it's important to call getConnectionAttributes and getRequestAttributes here</span>
<span class="source-line-no">066</span><span id="line-66"> // because otherwise the buffers may get released before the log details are processed which</span>
<span class="source-line-no">067</span><span id="line-67"> // would result in corrupted attributes</span>
<span class="source-line-no">068</span><span id="line-68"> this.connectionAttributes = rpcCall.getConnectionAttributes();</span>
<span class="source-line-no">069</span><span id="line-69"> this.requestAttributes = rpcCall.getRequestAttributes();</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> // We also need to deep copy the message because the CodedInputStream may be</span>
<span class="source-line-no">072</span><span id="line-72"> // overwritten before this slow log is consumed. Such overwriting could</span>
<span class="source-line-no">073</span><span id="line-73"> // cause the slow log payload to be corrupt</span>
<span class="source-line-no">074</span><span id="line-74"> try {</span>
<span class="source-line-no">075</span><span id="line-75"> this.param = param.newBuilderForType().mergeFrom(param.toByteArray()).build();</span>
<span class="source-line-no">076</span><span id="line-76"> } catch (InvalidProtocolBufferException e) {</span>
<span class="source-line-no">077</span><span id="line-77"> LOG.error("Failed to parse protobuf for message {}", param, e);</span>
<span class="source-line-no">078</span><span id="line-78"> this.param = param;</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"> public RpcCall getRpcCall() {</span>
<span class="source-line-no">083</span><span id="line-83"> return rpcCall;</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> public String getClientAddress() {</span>
<span class="source-line-no">087</span><span id="line-87"> return clientAddress;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> public long getResponseSize() {</span>
<span class="source-line-no">091</span><span id="line-91"> return responseSize;</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"> public long getBlockBytesScanned() {</span>
<span class="source-line-no">095</span><span id="line-95"> return blockBytesScanned;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> public long getFsReadTime() {</span>
<span class="source-line-no">099</span><span id="line-99"> return fsReadTime;</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> public String getClassName() {</span>
<span class="source-line-no">103</span><span id="line-103"> return className;</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> public boolean isSlowLog() {</span>
<span class="source-line-no">107</span><span id="line-107"> return isSlowLog;</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> public boolean isLargeLog() {</span>
<span class="source-line-no">111</span><span id="line-111"> return isLargeLog;</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> public Message getParam() {</span>
<span class="source-line-no">115</span><span id="line-115"> return param;</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> public Map&lt;String, byte[]&gt; getConnectionAttributes() {</span>
<span class="source-line-no">119</span><span id="line-119"> return connectionAttributes;</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> public Map&lt;String, byte[]&gt; getRequestAttributes() {</span>
<span class="source-line-no">123</span><span id="line-123"> return requestAttributes;</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> @Override</span>
<span class="source-line-no">127</span><span id="line-127"> public String toString() {</span>
<span class="source-line-no">128</span><span id="line-128"> return new ToStringBuilder(this).append("rpcCall", rpcCall).append("param", param)</span>
<span class="source-line-no">129</span><span id="line-129"> .append("clientAddress", clientAddress).append("responseSize", responseSize)</span>
<span class="source-line-no">130</span><span id="line-130"> .append("className", className).append("isSlowLog", isSlowLog)</span>
<span class="source-line-no">131</span><span id="line-131"> .append("isLargeLog", isLargeLog).append("connectionAttributes", connectionAttributes)</span>
<span class="source-line-no">132</span><span id="line-132"> .append("requestAttributes", requestAttributes).toString();</span>
<span class="source-line-no">133</span><span id="line-133"> }</span>
<span class="source-line-no">134</span><span id="line-134">}</span>
</pre>
</div>
</main>
</body>
</html>