Google Git
Sign in
apache / hbase-site / a2a1a96078a496964bd779adfa357135655a68bc / . / devapidocs / src-html / org / apache / hadoop / hbase / client / trace / TableOperationSpanBuilder.html
blob: b9db86aa7189aadc57bda843fbf0a08a545e55c3 [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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client.trace;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.CONTAINER_DB_OPERATIONS_KEY;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.DB_OPERATION;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import io.opentelemetry.api.common.AttributeKey;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import io.opentelemetry.api.trace.Span;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import io.opentelemetry.api.trace.SpanBuilder;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import io.opentelemetry.api.trace.SpanKind;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Arrays;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Collection;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.HashMap;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.HashSet;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.Map;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.Set;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.function.Supplier;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.stream.Collectors;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.util.stream.Stream;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.TableName;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.Append;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.AsyncConnectionImpl;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.CheckAndMutate;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Delete;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.Get;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.Increment;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.client.Put;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.client.RegionCoprocessorServiceExec;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.client.Row;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.client.RowMutations;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.Operation;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.trace.TraceUtil;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>/**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Construct {@link Span} instances originating from "table operations" -- the verbs in our public<a name="line.54"></a>
<span class="sourceLineNo">055</span> * API that interact with data in tables.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span>@InterfaceAudience.Private<a name="line.57"></a>
<span class="sourceLineNo">058</span>public class TableOperationSpanBuilder implements Supplier&lt;Span&gt; {<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> // n.b. The results of this class are tested implicitly by way of the likes of<a name="line.60"></a>
<span class="sourceLineNo">061</span> // `TestAsyncTableTracing` and friends.<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final String unknown = "UNKNOWN";<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private TableName tableName;<a name="line.65"></a>
<span class="sourceLineNo">066</span> private final Map&lt;AttributeKey&lt;?&gt;, Object&gt; attributes = new HashMap&lt;&gt;();<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> public TableOperationSpanBuilder(final AsyncConnectionImpl conn) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> ConnectionSpanBuilder.populateConnectionAttributes(attributes, conn);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span> public Span get() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return build();<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> public TableOperationSpanBuilder setOperation(final Scan scan) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return setOperation(valueFrom(scan));<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> public TableOperationSpanBuilder setOperation(final Row row) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return setOperation(valueFrom(row));<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> @SuppressWarnings("unused")<a name="line.85"></a>
<span class="sourceLineNo">086</span> public TableOperationSpanBuilder setOperation(final Collection&lt;? extends Row&gt; operations) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return setOperation(Operation.BATCH);<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> public TableOperationSpanBuilder setOperation(final Operation operation) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> attributes.put(DB_OPERATION, operation.name());<a name="line.91"></a>
<span class="sourceLineNo">092</span> return this;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> // `setContainerOperations` perform a recursive descent expansion of all the operations<a name="line.95"></a>
<span class="sourceLineNo">096</span> // contained within the provided "batch" object.<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public TableOperationSpanBuilder setContainerOperations(final RowMutations mutations) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> final Operation[] ops = mutations.getMutations().stream()<a name="line.99"></a>
<span class="sourceLineNo">100</span> .flatMap(row -&gt; Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream()))<a name="line.100"></a>
<span class="sourceLineNo">101</span> .toArray(Operation[]::new);<a name="line.101"></a>
<span class="sourceLineNo">102</span> return setContainerOperations(ops);<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public TableOperationSpanBuilder setContainerOperations(final Row row) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> final Operation[] ops =<a name="line.106"></a>
<span class="sourceLineNo">107</span> Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream())<a name="line.107"></a>
<span class="sourceLineNo">108</span> .toArray(Operation[]::new);<a name="line.108"></a>
<span class="sourceLineNo">109</span> return setContainerOperations(ops);<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> public TableOperationSpanBuilder<a name="line.112"></a>
<span class="sourceLineNo">113</span> setContainerOperations(final Collection&lt;? extends Row&gt; operations) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> final Operation[] ops = operations.stream()<a name="line.114"></a>
<span class="sourceLineNo">115</span> .flatMap(row -&gt; Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream()))<a name="line.115"></a>
<span class="sourceLineNo">116</span> .toArray(Operation[]::new);<a name="line.116"></a>
<span class="sourceLineNo">117</span> return setContainerOperations(ops);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> private static Set&lt;Operation&gt; unpackRowOperations(final Row row) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> final Set&lt;Operation&gt; ops = new HashSet&lt;&gt;();<a name="line.121"></a>
<span class="sourceLineNo">122</span> if (row instanceof CheckAndMutate) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> final CheckAndMutate cam = (CheckAndMutate) row;<a name="line.123"></a>
<span class="sourceLineNo">124</span> ops.addAll(unpackRowOperations(cam));<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (row instanceof RowMutations) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> final RowMutations mutations = (RowMutations) row;<a name="line.127"></a>
<span class="sourceLineNo">128</span> final List&lt;Operation&gt; operations = mutations.getMutations().stream()<a name="line.128"></a>
<span class="sourceLineNo">129</span> .map(TableOperationSpanBuilder::valueFrom).collect(Collectors.toList());<a name="line.129"></a>
<span class="sourceLineNo">130</span> ops.addAll(operations);<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> return ops;<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> private static Set&lt;Operation&gt; unpackRowOperations(final CheckAndMutate cam) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> final Set&lt;Operation&gt; ops = new HashSet&lt;&gt;();<a name="line.136"></a>
<span class="sourceLineNo">137</span> final Operation op = valueFrom(cam.getAction());<a name="line.137"></a>
<span class="sourceLineNo">138</span> switch (op) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> case BATCH:<a name="line.139"></a>
<span class="sourceLineNo">140</span> case CHECK_AND_MUTATE:<a name="line.140"></a>
<span class="sourceLineNo">141</span> ops.addAll(unpackRowOperations(cam.getAction()));<a name="line.141"></a>
<span class="sourceLineNo">142</span> break;<a name="line.142"></a>
<span class="sourceLineNo">143</span> default:<a name="line.143"></a>
<span class="sourceLineNo">144</span> ops.add(op);<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> return ops;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> public TableOperationSpanBuilder setContainerOperations(final Operation... operations) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> final List&lt;String&gt; ops = Arrays.stream(operations).map(op -&gt; op == null ? unknown : op.name())<a name="line.150"></a>
<span class="sourceLineNo">151</span> .sorted().distinct().collect(Collectors.toList());<a name="line.151"></a>
<span class="sourceLineNo">152</span> attributes.put(CONTAINER_DB_OPERATIONS_KEY, ops);<a name="line.152"></a>
<span class="sourceLineNo">153</span> return this;<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> public TableOperationSpanBuilder setTableName(final TableName tableName) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> this.tableName = tableName;<a name="line.157"></a>
<span class="sourceLineNo">158</span> TableSpanBuilder.populateTableNameAttributes(attributes, tableName);<a name="line.158"></a>
<span class="sourceLineNo">159</span> return this;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> @SuppressWarnings("unchecked")<a name="line.162"></a>
<span class="sourceLineNo">163</span> public Span build() {<a name="line.163"></a>
<span class="sourceLineNo">164</span> final String name = attributes.getOrDefault(DB_OPERATION, unknown) + " "<a name="line.164"></a>
<span class="sourceLineNo">165</span> + (tableName != null ? tableName.getNameWithNamespaceInclAsString() : unknown);<a name="line.165"></a>
<span class="sourceLineNo">166</span> final SpanBuilder builder = TraceUtil.getGlobalTracer().spanBuilder(name)<a name="line.166"></a>
<span class="sourceLineNo">167</span> // TODO: what about clients embedded in Master/RegionServer/Gateways/&amp;c?<a name="line.167"></a>
<span class="sourceLineNo">168</span> .setSpanKind(SpanKind.CLIENT);<a name="line.168"></a>
<span class="sourceLineNo">169</span> attributes.forEach((k, v) -&gt; builder.setAttribute((AttributeKey&lt;? super Object&gt;) k, v));<a name="line.169"></a>
<span class="sourceLineNo">170</span> return builder.startSpan();<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> private static Operation valueFrom(final Scan scan) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if (scan == null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> return null;<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> return Operation.SCAN;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> private static Operation valueFrom(final Row row) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> if (row == null) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return null;<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span> if (row instanceof Append) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> return Operation.APPEND;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (row instanceof CheckAndMutate) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> return Operation.CHECK_AND_MUTATE;<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (row instanceof Delete) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> return Operation.DELETE;<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (row instanceof Get) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> return Operation.GET;<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (row instanceof Increment) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return Operation.INCREMENT;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> if (row instanceof Put) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> return Operation.PUT;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> if (row instanceof RegionCoprocessorServiceExec) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> return Operation.COPROC_EXEC;<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> if (row instanceof RowMutations) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> return Operation.BATCH;<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> return null;<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span>}<a name="line.210"></a>
</pre>
</div>
</body>
</html>