| <!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.client.trace, class: TableOperationSpanBuilder"> |
| <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.client.trace;</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 static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.CONTAINER_DB_OPERATIONS_KEY;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.DB_OPERATION;</span> |
| <span class="source-line-no">022</span><span id="line-22"></span> |
| <span class="source-line-no">023</span><span id="line-23">import io.opentelemetry.api.common.AttributeKey;</span> |
| <span class="source-line-no">024</span><span id="line-24">import io.opentelemetry.api.trace.Span;</span> |
| <span class="source-line-no">025</span><span id="line-25">import io.opentelemetry.api.trace.SpanBuilder;</span> |
| <span class="source-line-no">026</span><span id="line-26">import io.opentelemetry.api.trace.SpanKind;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Arrays;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.Collection;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.HashMap;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.HashSet;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.List;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.Map;</span> |
| <span class="source-line-no">033</span><span id="line-33">import java.util.Set;</span> |
| <span class="source-line-no">034</span><span id="line-34">import java.util.function.Supplier;</span> |
| <span class="source-line-no">035</span><span id="line-35">import java.util.stream.Collectors;</span> |
| <span class="source-line-no">036</span><span id="line-36">import java.util.stream.Stream;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.Append;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.client.AsyncConnectionImpl;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.client.CheckAndMutate;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.client.Delete;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.client.Get;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.client.Increment;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.client.RegionCoprocessorServiceExec;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.client.Row;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.client.RowMutations;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.client.Scan;</span> |
| <span class="source-line-no">049</span><span id="line-49">import org.apache.hadoop.hbase.trace.HBaseSemanticAttributes.Operation;</span> |
| <span class="source-line-no">050</span><span id="line-50">import org.apache.hadoop.hbase.trace.TraceUtil;</span> |
| <span class="source-line-no">051</span><span id="line-51">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53">/**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Construct {@link Span} instances originating from "table operations" -- the verbs in our public</span> |
| <span class="source-line-no">055</span><span id="line-55"> * API that interact with data in tables.</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57">@InterfaceAudience.Private</span> |
| <span class="source-line-no">058</span><span id="line-58">public class TableOperationSpanBuilder implements Supplier<Span> {</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> // n.b. The results of this class are tested implicitly by way of the likes of</span> |
| <span class="source-line-no">061</span><span id="line-61"> // `TestAsyncTableTracing` and friends.</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> private static final String unknown = "UNKNOWN";</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> private TableName tableName;</span> |
| <span class="source-line-no">066</span><span id="line-66"> private final Map<AttributeKey<?>, Object> attributes = new HashMap<>();</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> public TableOperationSpanBuilder(final AsyncConnectionImpl conn) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> ConnectionSpanBuilder.populateConnectionAttributes(attributes, conn);</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> @Override</span> |
| <span class="source-line-no">073</span><span id="line-73"> public Span get() {</span> |
| <span class="source-line-no">074</span><span id="line-74"> return build();</span> |
| <span class="source-line-no">075</span><span id="line-75"> }</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> public TableOperationSpanBuilder setOperation(final Scan scan) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> return setOperation(valueFrom(scan));</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"> public TableOperationSpanBuilder setOperation(final Row row) {</span> |
| <span class="source-line-no">082</span><span id="line-82"> return setOperation(valueFrom(row));</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> @SuppressWarnings("unused")</span> |
| <span class="source-line-no">086</span><span id="line-86"> public TableOperationSpanBuilder setOperation(final Collection<? extends Row> operations) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> return setOperation(Operation.BATCH);</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 TableOperationSpanBuilder setOperation(final Operation operation) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> attributes.put(DB_OPERATION, operation.name());</span> |
| <span class="source-line-no">092</span><span id="line-92"> return this;</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"> // `setContainerOperations` perform a recursive descent expansion of all the operations</span> |
| <span class="source-line-no">096</span><span id="line-96"> // contained within the provided "batch" object.</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 TableOperationSpanBuilder setContainerOperations(final RowMutations mutations) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> final Operation[] ops = mutations.getMutations().stream()</span> |
| <span class="source-line-no">100</span><span id="line-100"> .flatMap(row -> Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream()))</span> |
| <span class="source-line-no">101</span><span id="line-101"> .toArray(Operation[]::new);</span> |
| <span class="source-line-no">102</span><span id="line-102"> return setContainerOperations(ops);</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> public TableOperationSpanBuilder setContainerOperations(final Row row) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> final Operation[] ops =</span> |
| <span class="source-line-no">107</span><span id="line-107"> Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream())</span> |
| <span class="source-line-no">108</span><span id="line-108"> .toArray(Operation[]::new);</span> |
| <span class="source-line-no">109</span><span id="line-109"> return setContainerOperations(ops);</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 TableOperationSpanBuilder</span> |
| <span class="source-line-no">113</span><span id="line-113"> setContainerOperations(final Collection<? extends Row> operations) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> final Operation[] ops = operations.stream()</span> |
| <span class="source-line-no">115</span><span id="line-115"> .flatMap(row -> Stream.concat(Stream.of(valueFrom(row)), unpackRowOperations(row).stream()))</span> |
| <span class="source-line-no">116</span><span id="line-116"> .toArray(Operation[]::new);</span> |
| <span class="source-line-no">117</span><span id="line-117"> return setContainerOperations(ops);</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> private static Set<Operation> unpackRowOperations(final Row row) {</span> |
| <span class="source-line-no">121</span><span id="line-121"> final Set<Operation> ops = new HashSet<>();</span> |
| <span class="source-line-no">122</span><span id="line-122"> if (row instanceof CheckAndMutate) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> final CheckAndMutate cam = (CheckAndMutate) row;</span> |
| <span class="source-line-no">124</span><span id="line-124"> ops.addAll(unpackRowOperations(cam));</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"> if (row instanceof RowMutations) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> final RowMutations mutations = (RowMutations) row;</span> |
| <span class="source-line-no">128</span><span id="line-128"> final List<Operation> operations = mutations.getMutations().stream()</span> |
| <span class="source-line-no">129</span><span id="line-129"> .map(TableOperationSpanBuilder::valueFrom).collect(Collectors.toList());</span> |
| <span class="source-line-no">130</span><span id="line-130"> ops.addAll(operations);</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> return ops;</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> |
| <span class="source-line-no">135</span><span id="line-135"> private static Set<Operation> unpackRowOperations(final CheckAndMutate cam) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> final Set<Operation> ops = new HashSet<>();</span> |
| <span class="source-line-no">137</span><span id="line-137"> final Operation op = valueFrom(cam.getAction());</span> |
| <span class="source-line-no">138</span><span id="line-138"> switch (op) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> case BATCH:</span> |
| <span class="source-line-no">140</span><span id="line-140"> case CHECK_AND_MUTATE:</span> |
| <span class="source-line-no">141</span><span id="line-141"> ops.addAll(unpackRowOperations(cam.getAction()));</span> |
| <span class="source-line-no">142</span><span id="line-142"> break;</span> |
| <span class="source-line-no">143</span><span id="line-143"> default:</span> |
| <span class="source-line-no">144</span><span id="line-144"> ops.add(op);</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"> return ops;</span> |
| <span class="source-line-no">147</span><span id="line-147"> }</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> public TableOperationSpanBuilder setContainerOperations(final Operation... operations) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> final List<String> ops = Arrays.stream(operations).map(op -> op == null ? unknown : op.name())</span> |
| <span class="source-line-no">151</span><span id="line-151"> .sorted().distinct().collect(Collectors.toList());</span> |
| <span class="source-line-no">152</span><span id="line-152"> attributes.put(CONTAINER_DB_OPERATIONS_KEY, ops);</span> |
| <span class="source-line-no">153</span><span id="line-153"> return this;</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> public TableOperationSpanBuilder setTableName(final TableName tableName) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> this.tableName = tableName;</span> |
| <span class="source-line-no">158</span><span id="line-158"> TableSpanBuilder.populateTableNameAttributes(attributes, tableName);</span> |
| <span class="source-line-no">159</span><span id="line-159"> return this;</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> @SuppressWarnings("unchecked")</span> |
| <span class="source-line-no">163</span><span id="line-163"> public Span build() {</span> |
| <span class="source-line-no">164</span><span id="line-164"> final String name = attributes.getOrDefault(DB_OPERATION, unknown) + " "</span> |
| <span class="source-line-no">165</span><span id="line-165"> + (tableName != null ? tableName.getNameWithNamespaceInclAsString() : unknown);</span> |
| <span class="source-line-no">166</span><span id="line-166"> final SpanBuilder builder = TraceUtil.getGlobalTracer().spanBuilder(name)</span> |
| <span class="source-line-no">167</span><span id="line-167"> // TODO: what about clients embedded in Master/RegionServer/Gateways/&c?</span> |
| <span class="source-line-no">168</span><span id="line-168"> .setSpanKind(SpanKind.CLIENT);</span> |
| <span class="source-line-no">169</span><span id="line-169"> attributes.forEach((k, v) -> builder.setAttribute((AttributeKey<? super Object>) k, v));</span> |
| <span class="source-line-no">170</span><span id="line-170"> return builder.startSpan();</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> private static Operation valueFrom(final Scan scan) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> if (scan == null) {</span> |
| <span class="source-line-no">175</span><span id="line-175"> return null;</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"> return Operation.SCAN;</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> |
| <span class="source-line-no">180</span><span id="line-180"> private static Operation valueFrom(final Row row) {</span> |
| <span class="source-line-no">181</span><span id="line-181"> if (row == null) {</span> |
| <span class="source-line-no">182</span><span id="line-182"> return null;</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"> if (row instanceof Append) {</span> |
| <span class="source-line-no">185</span><span id="line-185"> return Operation.APPEND;</span> |
| <span class="source-line-no">186</span><span id="line-186"> }</span> |
| <span class="source-line-no">187</span><span id="line-187"> if (row instanceof CheckAndMutate) {</span> |
| <span class="source-line-no">188</span><span id="line-188"> return Operation.CHECK_AND_MUTATE;</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"> if (row instanceof Delete) {</span> |
| <span class="source-line-no">191</span><span id="line-191"> return Operation.DELETE;</span> |
| <span class="source-line-no">192</span><span id="line-192"> }</span> |
| <span class="source-line-no">193</span><span id="line-193"> if (row instanceof Get) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> return Operation.GET;</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"> if (row instanceof Increment) {</span> |
| <span class="source-line-no">197</span><span id="line-197"> return Operation.INCREMENT;</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"> if (row instanceof Put) {</span> |
| <span class="source-line-no">200</span><span id="line-200"> return Operation.PUT;</span> |
| <span class="source-line-no">201</span><span id="line-201"> }</span> |
| <span class="source-line-no">202</span><span id="line-202"> if (row instanceof RegionCoprocessorServiceExec) {</span> |
| <span class="source-line-no">203</span><span id="line-203"> return Operation.COPROC_EXEC;</span> |
| <span class="source-line-no">204</span><span id="line-204"> }</span> |
| <span class="source-line-no">205</span><span id="line-205"> if (row instanceof RowMutations) {</span> |
| <span class="source-line-no">206</span><span id="line-206"> return Operation.BATCH;</span> |
| <span class="source-line-no">207</span><span id="line-207"> }</span> |
| <span class="source-line-no">208</span><span id="line-208"> return null;</span> |
| <span class="source-line-no">209</span><span id="line-209"> }</span> |
| <span class="source-line-no">210</span><span id="line-210">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |