| <!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, class: TestServerSideScanMetricsFromClientSide"> |
| <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;</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.junit.Assert.assertEquals;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertNotNull;</span> |
| <span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.assertTrue;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.ArrayList;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.List;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.Result;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.client.ResultScanner;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.client.Scan;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.client.Table;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.metrics.ScanMetrics;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.filter.BinaryComparator;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.filter.ColumnPrefixFilter;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.filter.Filter;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.filter.FilterList;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.filter.FilterList.Operator;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.filter.FirstKeyOnlyFilter;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.filter.RowFilter;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.filter.SingleColumnValueExcludeFilter;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.filter.SingleColumnValueFilter;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.testclassification.LargeTests;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.junit.AfterClass;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.junit.BeforeClass;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.junit.ClassRule;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.junit.Test;</span> |
| <span class="source-line-no">049</span><span id="line-49">import org.junit.experimental.categories.Category;</span> |
| <span class="source-line-no">050</span><span id="line-50">import org.slf4j.Logger;</span> |
| <span class="source-line-no">051</span><span id="line-51">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53">@Category(LargeTests.class)</span> |
| <span class="source-line-no">054</span><span id="line-54">public class TestServerSideScanMetricsFromClientSide {</span> |
| <span class="source-line-no">055</span><span id="line-55"> private static final Logger LOG =</span> |
| <span class="source-line-no">056</span><span id="line-56"> LoggerFactory.getLogger(TestServerSideScanMetricsFromClientSide.class);</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> @ClassRule</span> |
| <span class="source-line-no">059</span><span id="line-59"> public static final HBaseClassTestRule CLASS_RULE =</span> |
| <span class="source-line-no">060</span><span id="line-60"> HBaseClassTestRule.forClass(TestServerSideScanMetricsFromClientSide.class);</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> private final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> private static Table TABLE = null;</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Table configuration</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> private static TableName TABLE_NAME = TableName.valueOf("testTable");</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> private static int NUM_ROWS = 10;</span> |
| <span class="source-line-no">072</span><span id="line-72"> private static byte[] ROW = Bytes.toBytes("testRow");</span> |
| <span class="source-line-no">073</span><span id="line-73"> private static byte[][] ROWS = HTestConst.makeNAscii(ROW, NUM_ROWS);</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> // Should keep this value below 10 to keep generation of expected kv's simple. If above 10 then</span> |
| <span class="source-line-no">076</span><span id="line-76"> // table/row/cf1/... will be followed by table/row/cf10/... instead of table/row/cf2/... which</span> |
| <span class="source-line-no">077</span><span id="line-77"> // breaks the simple generation of expected kv's</span> |
| <span class="source-line-no">078</span><span id="line-78"> private static int NUM_FAMILIES = 1;</span> |
| <span class="source-line-no">079</span><span id="line-79"> private static byte[] FAMILY = Bytes.toBytes("testFamily");</span> |
| <span class="source-line-no">080</span><span id="line-80"> private static byte[][] FAMILIES = HTestConst.makeNAscii(FAMILY, NUM_FAMILIES);</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> private static int NUM_QUALIFIERS = 1;</span> |
| <span class="source-line-no">083</span><span id="line-83"> private static byte[] QUALIFIER = Bytes.toBytes("testQualifier");</span> |
| <span class="source-line-no">084</span><span id="line-84"> private static byte[][] QUALIFIERS = HTestConst.makeNAscii(QUALIFIER, NUM_QUALIFIERS);</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> private static int VALUE_SIZE = 10;</span> |
| <span class="source-line-no">087</span><span id="line-87"> private static byte[] VALUE = Bytes.createMaxByteArray(VALUE_SIZE);</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> private static int NUM_COLS = NUM_FAMILIES * NUM_QUALIFIERS;</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> // Approximation of how large the heap size of cells in our table. Should be accessed through</span> |
| <span class="source-line-no">092</span><span id="line-92"> // getCellHeapSize().</span> |
| <span class="source-line-no">093</span><span id="line-93"> private static long CELL_HEAP_SIZE = -1;</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> @BeforeClass</span> |
| <span class="source-line-no">096</span><span id="line-96"> public static void setUpBeforeClass() throws Exception {</span> |
| <span class="source-line-no">097</span><span id="line-97"> TEST_UTIL.startMiniCluster(3);</span> |
| <span class="source-line-no">098</span><span id="line-98"> TABLE = createTestTable(TABLE_NAME, ROWS, FAMILIES, QUALIFIERS, VALUE);</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> private static Table createTestTable(TableName name, byte[][] rows, byte[][] families,</span> |
| <span class="source-line-no">102</span><span id="line-102"> byte[][] qualifiers, byte[] cellValue) throws IOException {</span> |
| <span class="source-line-no">103</span><span id="line-103"> Table ht = TEST_UTIL.createTable(name, families);</span> |
| <span class="source-line-no">104</span><span id="line-104"> List<Put> puts = createPuts(rows, families, qualifiers, cellValue);</span> |
| <span class="source-line-no">105</span><span id="line-105"> ht.put(puts);</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> return ht;</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"> @AfterClass</span> |
| <span class="source-line-no">111</span><span id="line-111"> public static void tearDownAfterClass() throws Exception {</span> |
| <span class="source-line-no">112</span><span id="line-112"> TEST_UTIL.shutdownMiniCluster();</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</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"> * Make puts to put the input value into each combination of row, family, and qualifier</span> |
| <span class="source-line-no">117</span><span id="line-117"> * @param rows the rows to use</span> |
| <span class="source-line-no">118</span><span id="line-118"> * @param families the column families to use</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @param qualifiers the column qualifiers to use</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @param value the value to put</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @return the putted input values added in puts</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @throws IOException If an IO problem is encountered</span> |
| <span class="source-line-no">123</span><span id="line-123"> */</span> |
| <span class="source-line-no">124</span><span id="line-124"> private static ArrayList<Put> createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,</span> |
| <span class="source-line-no">125</span><span id="line-125"> byte[] value) throws IOException {</span> |
| <span class="source-line-no">126</span><span id="line-126"> Put put;</span> |
| <span class="source-line-no">127</span><span id="line-127"> ArrayList<Put> puts = new ArrayList<>();</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> for (int row = 0; row < rows.length; row++) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> put = new Put(rows[row]);</span> |
| <span class="source-line-no">131</span><span id="line-131"> for (int fam = 0; fam < families.length; fam++) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> for (int qual = 0; qual < qualifiers.length; qual++) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> KeyValue kv = new KeyValue(rows[row], families[fam], qualifiers[qual], qual, value);</span> |
| <span class="source-line-no">134</span><span id="line-134"> put.add(kv);</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"> puts.add(put);</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> return puts;</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> /**</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @return The approximate heap size of a cell in the test table. All cells should have</span> |
| <span class="source-line-no">145</span><span id="line-145"> * approximately the same heap size, so the value is cached to avoid repeating the</span> |
| <span class="source-line-no">146</span><span id="line-146"> * calculation</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @throws Exception on unexpected failure</span> |
| <span class="source-line-no">148</span><span id="line-148"> */</span> |
| <span class="source-line-no">149</span><span id="line-149"> private long getCellHeapSize() throws Exception {</span> |
| <span class="source-line-no">150</span><span id="line-150"> if (CELL_HEAP_SIZE == -1) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> // Do a partial scan that will return a single result with a single cell</span> |
| <span class="source-line-no">152</span><span id="line-152"> Scan scan = new Scan();</span> |
| <span class="source-line-no">153</span><span id="line-153"> scan.setMaxResultSize(1);</span> |
| <span class="source-line-no">154</span><span id="line-154"> scan.setAllowPartialResults(true);</span> |
| <span class="source-line-no">155</span><span id="line-155"> ResultScanner scanner = TABLE.getScanner(scan);</span> |
| <span class="source-line-no">156</span><span id="line-156"></span> |
| <span class="source-line-no">157</span><span id="line-157"> Result result = scanner.next();</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> assertTrue(result != null);</span> |
| <span class="source-line-no">160</span><span id="line-160"> assertTrue(result.rawCells() != null);</span> |
| <span class="source-line-no">161</span><span id="line-161"> assertTrue(result.rawCells().length == 1);</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> CELL_HEAP_SIZE = result.rawCells()[0].heapSize();</span> |
| <span class="source-line-no">164</span><span id="line-164"> scanner.close();</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> return CELL_HEAP_SIZE;</span> |
| <span class="source-line-no">168</span><span id="line-168"> }</span> |
| <span class="source-line-no">169</span><span id="line-169"></span> |
| <span class="source-line-no">170</span><span id="line-170"> @Test</span> |
| <span class="source-line-no">171</span><span id="line-171"> public void testRowsSeenMetric() throws Exception {</span> |
| <span class="source-line-no">172</span><span id="line-172"> // Base scan configuration</span> |
| <span class="source-line-no">173</span><span id="line-173"> Scan baseScan;</span> |
| <span class="source-line-no">174</span><span id="line-174"> baseScan = new Scan();</span> |
| <span class="source-line-no">175</span><span id="line-175"> baseScan.setScanMetricsEnabled(true);</span> |
| <span class="source-line-no">176</span><span id="line-176"> try {</span> |
| <span class="source-line-no">177</span><span id="line-177"> testRowsSeenMetric(baseScan);</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> // Test case that only a single result will be returned per RPC to the serer</span> |
| <span class="source-line-no">180</span><span id="line-180"> baseScan.setCaching(1);</span> |
| <span class="source-line-no">181</span><span id="line-181"> testRowsSeenMetric(baseScan);</span> |
| <span class="source-line-no">182</span><span id="line-182"></span> |
| <span class="source-line-no">183</span><span id="line-183"> // Test case that partial results are returned from the server. At most one cell will be</span> |
| <span class="source-line-no">184</span><span id="line-184"> // contained in each response</span> |
| <span class="source-line-no">185</span><span id="line-185"> baseScan.setMaxResultSize(1);</span> |
| <span class="source-line-no">186</span><span id="line-186"> testRowsSeenMetric(baseScan);</span> |
| <span class="source-line-no">187</span><span id="line-187"></span> |
| <span class="source-line-no">188</span><span id="line-188"> // Test case that size limit is set such that a few cells are returned per partial result from</span> |
| <span class="source-line-no">189</span><span id="line-189"> // the server</span> |
| <span class="source-line-no">190</span><span id="line-190"> baseScan.setCaching(NUM_ROWS);</span> |
| <span class="source-line-no">191</span><span id="line-191"> baseScan.setMaxResultSize(getCellHeapSize() * (NUM_COLS - 1));</span> |
| <span class="source-line-no">192</span><span id="line-192"> testRowsSeenMetric(baseScan);</span> |
| <span class="source-line-no">193</span><span id="line-193"> } catch (Throwable t) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> LOG.error("FAIL", t);</span> |
| <span class="source-line-no">195</span><span id="line-195"> throw t;</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198"></span> |
| <span class="source-line-no">199</span><span id="line-199"> @Test</span> |
| <span class="source-line-no">200</span><span id="line-200"> public void testFsReadTimeMetric() throws Exception {</span> |
| <span class="source-line-no">201</span><span id="line-201"> // write some new puts and flush, as an easy way to ensure the read blocks are not cached</span> |
| <span class="source-line-no">202</span><span id="line-202"> // so that we go into the fs write code path</span> |
| <span class="source-line-no">203</span><span id="line-203"> List<Put> puts = createPuts(ROWS, FAMILIES, QUALIFIERS, VALUE);</span> |
| <span class="source-line-no">204</span><span id="line-204"> TABLE.put(puts);</span> |
| <span class="source-line-no">205</span><span id="line-205"> TEST_UTIL.flush(TABLE_NAME);</span> |
| <span class="source-line-no">206</span><span id="line-206"> Scan scan = new Scan();</span> |
| <span class="source-line-no">207</span><span id="line-207"> scan.setScanMetricsEnabled(true);</span> |
| <span class="source-line-no">208</span><span id="line-208"> testMetric(scan, ServerSideScanMetrics.FS_READ_TIME_METRIC_NAME, 0, CompareOperator.GREATER);</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> |
| <span class="source-line-no">211</span><span id="line-211"> private void testRowsSeenMetric(Scan baseScan) throws Exception {</span> |
| <span class="source-line-no">212</span><span id="line-212"> Scan scan;</span> |
| <span class="source-line-no">213</span><span id="line-213"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">214</span><span id="line-214"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, NUM_ROWS);</span> |
| <span class="source-line-no">215</span><span id="line-215"></span> |
| <span class="source-line-no">216</span><span id="line-216"> for (int i = 0; i < ROWS.length - 1; i++) {</span> |
| <span class="source-line-no">217</span><span id="line-217"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">218</span><span id="line-218"> scan.withStartRow(ROWS[0]);</span> |
| <span class="source-line-no">219</span><span id="line-219"> scan.withStopRow(ROWS[i + 1]);</span> |
| <span class="source-line-no">220</span><span id="line-220"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, i + 1);</span> |
| <span class="source-line-no">221</span><span id="line-221"> }</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> for (int i = ROWS.length - 1; i > 0; i--) {</span> |
| <span class="source-line-no">224</span><span id="line-224"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">225</span><span id="line-225"> scan.withStartRow(ROWS[i - 1]);</span> |
| <span class="source-line-no">226</span><span id="line-226"> scan.withStopRow(ROWS[ROWS.length - 1]);</span> |
| <span class="source-line-no">227</span><span id="line-227"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME,</span> |
| <span class="source-line-no">228</span><span id="line-228"> ROWS.length - i);</span> |
| <span class="source-line-no">229</span><span id="line-229"> }</span> |
| <span class="source-line-no">230</span><span id="line-230"></span> |
| <span class="source-line-no">231</span><span id="line-231"> // The filter should filter out all rows, but we still expect to see every row.</span> |
| <span class="source-line-no">232</span><span id="line-232"> Filter filter =</span> |
| <span class="source-line-no">233</span><span id="line-233"> new RowFilter(CompareOperator.EQUAL, new BinaryComparator(Bytes.toBytes("xyz")));</span> |
| <span class="source-line-no">234</span><span id="line-234"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">235</span><span id="line-235"> scan.setFilter(filter);</span> |
| <span class="source-line-no">236</span><span id="line-236"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, ROWS.length);</span> |
| <span class="source-line-no">237</span><span id="line-237"></span> |
| <span class="source-line-no">238</span><span id="line-238"> // Filter should pass on all rows</span> |
| <span class="source-line-no">239</span><span id="line-239"> SingleColumnValueFilter singleColumnValueFilter =</span> |
| <span class="source-line-no">240</span><span id="line-240"> new SingleColumnValueFilter(FAMILIES[0], QUALIFIERS[0], CompareOperator.EQUAL, VALUE);</span> |
| <span class="source-line-no">241</span><span id="line-241"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">242</span><span id="line-242"> scan.setFilter(singleColumnValueFilter);</span> |
| <span class="source-line-no">243</span><span id="line-243"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, ROWS.length);</span> |
| <span class="source-line-no">244</span><span id="line-244"></span> |
| <span class="source-line-no">245</span><span id="line-245"> // Filter should filter out all rows</span> |
| <span class="source-line-no">246</span><span id="line-246"> singleColumnValueFilter =</span> |
| <span class="source-line-no">247</span><span id="line-247"> new SingleColumnValueFilter(FAMILIES[0], QUALIFIERS[0], CompareOperator.NOT_EQUAL, VALUE);</span> |
| <span class="source-line-no">248</span><span id="line-248"> scan = new Scan(baseScan);</span> |
| <span class="source-line-no">249</span><span id="line-249"> scan.setFilter(singleColumnValueFilter);</span> |
| <span class="source-line-no">250</span><span id="line-250"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, ROWS.length);</span> |
| <span class="source-line-no">251</span><span id="line-251"> }</span> |
| <span class="source-line-no">252</span><span id="line-252"></span> |
| <span class="source-line-no">253</span><span id="line-253"> @Test</span> |
| <span class="source-line-no">254</span><span id="line-254"> public void testRowsFilteredMetric() throws Exception {</span> |
| <span class="source-line-no">255</span><span id="line-255"> // Base scan configuration</span> |
| <span class="source-line-no">256</span><span id="line-256"> Scan baseScan;</span> |
| <span class="source-line-no">257</span><span id="line-257"> baseScan = new Scan();</span> |
| <span class="source-line-no">258</span><span id="line-258"> baseScan.setScanMetricsEnabled(true);</span> |
| <span class="source-line-no">259</span><span id="line-259"></span> |
| <span class="source-line-no">260</span><span id="line-260"> // Test case where scan uses default values</span> |
| <span class="source-line-no">261</span><span id="line-261"> testRowsFilteredMetric(baseScan);</span> |
| <span class="source-line-no">262</span><span id="line-262"></span> |
| <span class="source-line-no">263</span><span id="line-263"> // Test case where at most one Result is retrieved per RPC</span> |
| <span class="source-line-no">264</span><span id="line-264"> baseScan.setCaching(1);</span> |
| <span class="source-line-no">265</span><span id="line-265"> testRowsFilteredMetric(baseScan);</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> // Test case where size limit is very restrictive and partial results will be returned from</span> |
| <span class="source-line-no">268</span><span id="line-268"> // server</span> |
| <span class="source-line-no">269</span><span id="line-269"> baseScan.setMaxResultSize(1);</span> |
| <span class="source-line-no">270</span><span id="line-270"> testRowsFilteredMetric(baseScan);</span> |
| <span class="source-line-no">271</span><span id="line-271"></span> |
| <span class="source-line-no">272</span><span id="line-272"> // Test a case where max result size limits response from server to only a few cells (not all</span> |
| <span class="source-line-no">273</span><span id="line-273"> // cells from the row)</span> |
| <span class="source-line-no">274</span><span id="line-274"> baseScan.setCaching(NUM_ROWS);</span> |
| <span class="source-line-no">275</span><span id="line-275"> baseScan.setMaxResultSize(getCellHeapSize() * (NUM_COLS - 1));</span> |
| <span class="source-line-no">276</span><span id="line-276"> testRowsSeenMetric(baseScan);</span> |
| <span class="source-line-no">277</span><span id="line-277"> }</span> |
| <span class="source-line-no">278</span><span id="line-278"></span> |
| <span class="source-line-no">279</span><span id="line-279"> private void testRowsFilteredMetric(Scan baseScan) throws Exception {</span> |
| <span class="source-line-no">280</span><span id="line-280"> testRowsFilteredMetric(baseScan, null, 0);</span> |
| <span class="source-line-no">281</span><span id="line-281"></span> |
| <span class="source-line-no">282</span><span id="line-282"> // Row filter doesn't match any row key. All rows should be filtered</span> |
| <span class="source-line-no">283</span><span id="line-283"> Filter filter =</span> |
| <span class="source-line-no">284</span><span id="line-284"> new RowFilter(CompareOperator.EQUAL, new BinaryComparator(Bytes.toBytes("xyz")));</span> |
| <span class="source-line-no">285</span><span id="line-285"> testRowsFilteredMetric(baseScan, filter, ROWS.length);</span> |
| <span class="source-line-no">286</span><span id="line-286"></span> |
| <span class="source-line-no">287</span><span id="line-287"> // Filter will return results containing only the first key. Number of entire rows filtered</span> |
| <span class="source-line-no">288</span><span id="line-288"> // should be 0.</span> |
| <span class="source-line-no">289</span><span id="line-289"> filter = new FirstKeyOnlyFilter();</span> |
| <span class="source-line-no">290</span><span id="line-290"> testRowsFilteredMetric(baseScan, filter, 0);</span> |
| <span class="source-line-no">291</span><span id="line-291"></span> |
| <span class="source-line-no">292</span><span id="line-292"> // Column prefix will find some matching qualifier on each row. Number of entire rows filtered</span> |
| <span class="source-line-no">293</span><span id="line-293"> // should be 0</span> |
| <span class="source-line-no">294</span><span id="line-294"> filter = new ColumnPrefixFilter(QUALIFIERS[0]);</span> |
| <span class="source-line-no">295</span><span id="line-295"> testRowsFilteredMetric(baseScan, filter, 0);</span> |
| <span class="source-line-no">296</span><span id="line-296"></span> |
| <span class="source-line-no">297</span><span id="line-297"> // Column prefix will NOT find any matching qualifier on any row. All rows should be filtered</span> |
| <span class="source-line-no">298</span><span id="line-298"> filter = new ColumnPrefixFilter(Bytes.toBytes("xyz"));</span> |
| <span class="source-line-no">299</span><span id="line-299"> testRowsFilteredMetric(baseScan, filter, ROWS.length);</span> |
| <span class="source-line-no">300</span><span id="line-300"></span> |
| <span class="source-line-no">301</span><span id="line-301"> // Matching column value should exist in each row. No rows should be filtered.</span> |
| <span class="source-line-no">302</span><span id="line-302"> filter = new SingleColumnValueFilter(FAMILIES[0], QUALIFIERS[0], CompareOperator.EQUAL, VALUE);</span> |
| <span class="source-line-no">303</span><span id="line-303"> testRowsFilteredMetric(baseScan, filter, 0);</span> |
| <span class="source-line-no">304</span><span id="line-304"></span> |
| <span class="source-line-no">305</span><span id="line-305"> // No matching column value should exist in any row. Filter all rows</span> |
| <span class="source-line-no">306</span><span id="line-306"> filter =</span> |
| <span class="source-line-no">307</span><span id="line-307"> new SingleColumnValueFilter(FAMILIES[0], QUALIFIERS[0], CompareOperator.NOT_EQUAL, VALUE);</span> |
| <span class="source-line-no">308</span><span id="line-308"> testRowsFilteredMetric(baseScan, filter, ROWS.length);</span> |
| <span class="source-line-no">309</span><span id="line-309"></span> |
| <span class="source-line-no">310</span><span id="line-310"> List<Filter> filters = new ArrayList<>();</span> |
| <span class="source-line-no">311</span><span id="line-311"> filters.add(new RowFilter(CompareOperator.EQUAL, new BinaryComparator(ROWS[0])));</span> |
| <span class="source-line-no">312</span><span id="line-312"> filters.add(new RowFilter(CompareOperator.EQUAL, new BinaryComparator(ROWS[3])));</span> |
| <span class="source-line-no">313</span><span id="line-313"> int numberOfMatchingRowFilters = filters.size();</span> |
| <span class="source-line-no">314</span><span id="line-314"> filter = new FilterList(Operator.MUST_PASS_ONE, filters);</span> |
| <span class="source-line-no">315</span><span id="line-315"> testRowsFilteredMetric(baseScan, filter, ROWS.length - numberOfMatchingRowFilters);</span> |
| <span class="source-line-no">316</span><span id="line-316"> filters.clear();</span> |
| <span class="source-line-no">317</span><span id="line-317"></span> |
| <span class="source-line-no">318</span><span id="line-318"> // Add a single column value exclude filter for each column... The net effect is that all</span> |
| <span class="source-line-no">319</span><span id="line-319"> // columns will be excluded when scanning on the server side. This will result in an empty cell</span> |
| <span class="source-line-no">320</span><span id="line-320"> // array in RegionScanner#nextInternal which should be interpreted as a row being filtered.</span> |
| <span class="source-line-no">321</span><span id="line-321"> for (int family = 0; family < FAMILIES.length; family++) {</span> |
| <span class="source-line-no">322</span><span id="line-322"> for (int qualifier = 0; qualifier < QUALIFIERS.length; qualifier++) {</span> |
| <span class="source-line-no">323</span><span id="line-323"> filters.add(new SingleColumnValueExcludeFilter(FAMILIES[family], QUALIFIERS[qualifier],</span> |
| <span class="source-line-no">324</span><span id="line-324"> CompareOperator.EQUAL, VALUE));</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326"> }</span> |
| <span class="source-line-no">327</span><span id="line-327"> filter = new FilterList(Operator.MUST_PASS_ONE, filters);</span> |
| <span class="source-line-no">328</span><span id="line-328"> testRowsFilteredMetric(baseScan, filter, ROWS.length);</span> |
| <span class="source-line-no">329</span><span id="line-329"> }</span> |
| <span class="source-line-no">330</span><span id="line-330"></span> |
| <span class="source-line-no">331</span><span id="line-331"> private void testRowsFilteredMetric(Scan baseScan, Filter filter, int expectedNumFiltered)</span> |
| <span class="source-line-no">332</span><span id="line-332"> throws Exception {</span> |
| <span class="source-line-no">333</span><span id="line-333"> Scan scan = new Scan(baseScan);</span> |
| <span class="source-line-no">334</span><span id="line-334"> if (filter != null) {</span> |
| <span class="source-line-no">335</span><span id="line-335"> scan.setFilter(filter);</span> |
| <span class="source-line-no">336</span><span id="line-336"> }</span> |
| <span class="source-line-no">337</span><span id="line-337"> testMetric(scan, ServerSideScanMetrics.COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME,</span> |
| <span class="source-line-no">338</span><span id="line-338"> expectedNumFiltered);</span> |
| <span class="source-line-no">339</span><span id="line-339"> }</span> |
| <span class="source-line-no">340</span><span id="line-340"></span> |
| <span class="source-line-no">341</span><span id="line-341"> /**</span> |
| <span class="source-line-no">342</span><span id="line-342"> * Run the scan to completetion and check the metric against the specified value</span> |
| <span class="source-line-no">343</span><span id="line-343"> * @param scan The scan instance to use to record metrics</span> |
| <span class="source-line-no">344</span><span id="line-344"> * @param metricKey The metric key name</span> |
| <span class="source-line-no">345</span><span id="line-345"> * @param expectedValue The expected value of metric</span> |
| <span class="source-line-no">346</span><span id="line-346"> * @throws Exception on unexpected failure</span> |
| <span class="source-line-no">347</span><span id="line-347"> */</span> |
| <span class="source-line-no">348</span><span id="line-348"> private void testMetric(Scan scan, String metricKey, long expectedValue) throws Exception {</span> |
| <span class="source-line-no">349</span><span id="line-349"> testMetric(scan, metricKey, expectedValue, CompareOperator.EQUAL);</span> |
| <span class="source-line-no">350</span><span id="line-350"> }</span> |
| <span class="source-line-no">351</span><span id="line-351"></span> |
| <span class="source-line-no">352</span><span id="line-352"> private void testMetric(Scan scan, String metricKey, long expectedValue,</span> |
| <span class="source-line-no">353</span><span id="line-353"> CompareOperator compareOperator) throws Exception {</span> |
| <span class="source-line-no">354</span><span id="line-354"> assertTrue("Scan should be configured to record metrics", scan.isScanMetricsEnabled());</span> |
| <span class="source-line-no">355</span><span id="line-355"> ResultScanner scanner = TABLE.getScanner(scan);</span> |
| <span class="source-line-no">356</span><span id="line-356"> // Iterate through all the results</span> |
| <span class="source-line-no">357</span><span id="line-357"> while (scanner.next() != null) {</span> |
| <span class="source-line-no">358</span><span id="line-358"> continue;</span> |
| <span class="source-line-no">359</span><span id="line-359"> }</span> |
| <span class="source-line-no">360</span><span id="line-360"> scanner.close();</span> |
| <span class="source-line-no">361</span><span id="line-361"> ScanMetrics metrics = scanner.getScanMetrics();</span> |
| <span class="source-line-no">362</span><span id="line-362"> assertNotNull("Metrics are null", metrics);</span> |
| <span class="source-line-no">363</span><span id="line-363"> assertTrue("Metric : " + metricKey + " does not exist", metrics.hasCounter(metricKey));</span> |
| <span class="source-line-no">364</span><span id="line-364"> final long actualMetricValue = metrics.getCounter(metricKey).get();</span> |
| <span class="source-line-no">365</span><span id="line-365"> if (compareOperator == CompareOperator.EQUAL) {</span> |
| <span class="source-line-no">366</span><span id="line-366"> assertEquals(</span> |
| <span class="source-line-no">367</span><span id="line-367"> "Metric: " + metricKey + " Expected: " + expectedValue + " Actual: " + actualMetricValue,</span> |
| <span class="source-line-no">368</span><span id="line-368"> expectedValue, actualMetricValue);</span> |
| <span class="source-line-no">369</span><span id="line-369"> } else {</span> |
| <span class="source-line-no">370</span><span id="line-370"> assertTrue(</span> |
| <span class="source-line-no">371</span><span id="line-371"> "Metric: " + metricKey + " Expected: > " + expectedValue + " Actual: " + actualMetricValue,</span> |
| <span class="source-line-no">372</span><span id="line-372"> actualMetricValue > expectedValue);</span> |
| <span class="source-line-no">373</span><span id="line-373"> }</span> |
| <span class="source-line-no">374</span><span id="line-374"> }</span> |
| <span class="source-line-no">375</span><span id="line-375">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
