| <!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.metrics, class: ServerSideScanMetrics"> |
| <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.metrics;</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.HashMap;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.atomic.AtomicLong;</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"></span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Provides server side metrics related to scan operations.</span> |
| <span class="source-line-no">029</span><span id="line-29"> */</span> |
| <span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Public</span> |
| <span class="source-line-no">031</span><span id="line-31">@SuppressWarnings("checkstyle:VisibilityModifier") // See HBASE-27757</span> |
| <span class="source-line-no">032</span><span id="line-32">public class ServerSideScanMetrics {</span> |
| <span class="source-line-no">033</span><span id="line-33"> /**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Hash to hold the String -&gt; Atomic Long mappings for each metric</span> |
| <span class="source-line-no">035</span><span id="line-35"> */</span> |
| <span class="source-line-no">036</span><span id="line-36"> private final Map<String, AtomicLong> counters = new HashMap<>();</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Create a new counter with the specified name</span> |
| <span class="source-line-no">040</span><span id="line-40"> * @return {@link AtomicLong} instance for the counter with counterName</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> protected AtomicLong createCounter(String counterName) {</span> |
| <span class="source-line-no">043</span><span id="line-43"> AtomicLong c = new AtomicLong(0);</span> |
| <span class="source-line-no">044</span><span id="line-44"> counters.put(counterName, c);</span> |
| <span class="source-line-no">045</span><span id="line-45"> return c;</span> |
| <span class="source-line-no">046</span><span id="line-46"> }</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> public static final String COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME = "ROWS_SCANNED";</span> |
| <span class="source-line-no">049</span><span id="line-49"> public static final String COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME = "ROWS_FILTERED";</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final String BLOCK_BYTES_SCANNED_KEY_METRIC_NAME = "BLOCK_BYTES_SCANNED";</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> public static final String FS_READ_TIME_METRIC_NAME = "FS_READ_TIME";</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /**</span> |
| <span class="source-line-no">056</span><span id="line-56"> * number of rows filtered during scan RPC</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> public final AtomicLong countOfRowsFiltered =</span> |
| <span class="source-line-no">059</span><span id="line-59"> createCounter(COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * number of rows scanned during scan RPC. Not every row scanned will be returned to the client</span> |
| <span class="source-line-no">063</span><span id="line-63"> * since rows may be filtered.</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> public final AtomicLong countOfRowsScanned = createCounter(COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME);</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> public final AtomicLong countOfBlockBytesScanned =</span> |
| <span class="source-line-no">068</span><span id="line-68"> createCounter(BLOCK_BYTES_SCANNED_KEY_METRIC_NAME);</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> public final AtomicLong fsReadTime = createCounter(FS_READ_TIME_METRIC_NAME);</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> public void setCounter(String counterName, long value) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> AtomicLong c = this.counters.get(counterName);</span> |
| <span class="source-line-no">074</span><span id="line-74"> if (c != null) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> c.set(value);</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /** Returns true if a counter exists with the counterName */</span> |
| <span class="source-line-no">080</span><span id="line-80"> public boolean hasCounter(String counterName) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> return this.counters.containsKey(counterName);</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /** Returns {@link AtomicLong} instance for this counter name, null if counter does not exist. */</span> |
| <span class="source-line-no">085</span><span id="line-85"> public AtomicLong getCounter(String counterName) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> return this.counters.get(counterName);</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> public void addToCounter(String counterName, long delta) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> AtomicLong c = this.counters.get(counterName);</span> |
| <span class="source-line-no">091</span><span id="line-91"> if (c != null) {</span> |
| <span class="source-line-no">092</span><span id="line-92"> c.addAndGet(delta);</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"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Get all of the values since the last time this function was called. Calling this function will</span> |
| <span class="source-line-no">098</span><span id="line-98"> * reset all AtomicLongs in the instance back to 0.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @return A Map of String -&gt; Long for metrics</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> public Map<String, Long> getMetricsMap() {</span> |
| <span class="source-line-no">102</span><span id="line-102"> return getMetricsMap(true);</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"> /**</span> |
| <span class="source-line-no">106</span><span id="line-106"> * Get all of the values. If reset is true, we will reset the all AtomicLongs back to 0.</span> |
| <span class="source-line-no">107</span><span id="line-107"> * @param reset whether to reset the AtomicLongs to 0.</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @return A Map of String -&gt; Long for metrics</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 Map<String, Long> getMetricsMap(boolean reset) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> // Create a builder</span> |
| <span class="source-line-no">112</span><span id="line-112"> ImmutableMap.Builder<String, Long> builder = ImmutableMap.builder();</span> |
| <span class="source-line-no">113</span><span id="line-113"> for (Map.Entry<String, AtomicLong> e : this.counters.entrySet()) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> long value = reset ? e.getValue().getAndSet(0) : e.getValue().get();</span> |
| <span class="source-line-no">115</span><span id="line-115"> builder.put(e.getKey(), value);</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"> // Build the immutable map so that people can't mess around with it.</span> |
| <span class="source-line-no">118</span><span id="line-118"> return builder.build();</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
