| <!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.test, interface: MetricsAssertHelper"> |
| <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.test;</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 org.apache.hadoop.hbase.metrics.BaseSource;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">/** Interface of a class to make assertions about metrics values. */</span> |
| <span class="source-line-no">023</span><span id="line-23">public interface MetricsAssertHelper {</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25"> /**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * Init helper. This method will make sure that the metrics system is set up for tests.</span> |
| <span class="source-line-no">027</span><span id="line-27"> */</span> |
| <span class="source-line-no">028</span><span id="line-28"> void init();</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30"> /**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * Assert that a tag exists and has a given value.</span> |
| <span class="source-line-no">032</span><span id="line-32"> * @param name The name of the tag.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * @param expected The expected value</span> |
| <span class="source-line-no">034</span><span id="line-34"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">035</span><span id="line-35"> * counters.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37"> void assertTag(String name, String expected, BaseSource source);</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> /**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Assert that a gauge exists and that it's value is equal to the expected value.</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @param name The name of the gauge</span> |
| <span class="source-line-no">042</span><span id="line-42"> * @param expected The expected value of the gauge.</span> |
| <span class="source-line-no">043</span><span id="line-43"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">044</span><span id="line-44"> * counters.</span> |
| <span class="source-line-no">045</span><span id="line-45"> */</span> |
| <span class="source-line-no">046</span><span id="line-46"> void assertGauge(String name, long expected, BaseSource source);</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> /**</span> |
| <span class="source-line-no">049</span><span id="line-49"> * Assert that a gauge exists and it's value is greater than a given value</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @param name The name of the gauge</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param expected Value that the gauge is expected to be greater than</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">053</span><span id="line-53"> * counters.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> void assertGaugeGt(String name, long expected, BaseSource source);</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Assert that a gauge exists and it's value is less than a given value</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @param name The name of the gauge</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param expected Value that the gauge is expected to be less than</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">062</span><span id="line-62"> * counters.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> void assertGaugeLt(String name, long expected, BaseSource source);</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"> * Assert that a gauge exists and that it's value is equal to the expected value.</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @param name The name of the gauge</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @param expected The expected value of the gauge.</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">071</span><span id="line-71"> * counters.</span> |
| <span class="source-line-no">072</span><span id="line-72"> */</span> |
| <span class="source-line-no">073</span><span id="line-73"> void assertGauge(String name, double expected, BaseSource source);</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Assert that a gauge exists and it's value is greater than a given value</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param name The name of the gauge</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param expected Value that the gauge is expected to be greater than</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">080</span><span id="line-80"> * counters.</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> void assertGaugeGt(String name, double expected, BaseSource source);</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"> * Assert that a gauge exists and it's value is less than a given value</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param name The name of the gauge</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @param expected Value that the gauge is expected to be less than</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">089</span><span id="line-89"> * counters.</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> void assertGaugeLt(String name, double expected, BaseSource source);</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Assert that a counter exists and that it's value is equal to the expected value.</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @param name The name of the counter.</span> |
| <span class="source-line-no">096</span><span id="line-96"> * @param expected The expected value</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">098</span><span id="line-98"> * counters.</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> void assertCounter(String name, long expected, BaseSource source);</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Assert that a counter exists and that it's value is greater than the given value.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @param name The name of the counter.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param expected The value the counter is expected to be greater than.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">107</span><span id="line-107"> * counters.</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> void assertCounterGt(String name, long expected, BaseSource source);</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"> * Assert that a counter exists and that it's value is less than the given value.</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @param name The name of the counter.</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @param expected The value the counter is expected to be less than.</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">116</span><span id="line-116"> * counters.</span> |
| <span class="source-line-no">117</span><span id="line-117"> */</span> |
| <span class="source-line-no">118</span><span id="line-118"> void assertCounterLt(String name, long expected, BaseSource source);</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> |
| <span class="source-line-no">121</span><span id="line-121"> * Get the value of a counter.</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @param name name of the counter.</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">124</span><span id="line-124"> * counters.</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @return long value of the counter.</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> long getCounter(String name, BaseSource source);</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Check if a dynamic counter exists.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @param name name of the counter.</span> |
| <span class="source-line-no">132</span><span id="line-132"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">133</span><span id="line-133"> * counters.</span> |
| <span class="source-line-no">134</span><span id="line-134"> * @return boolean true if counter metric exists.</span> |
| <span class="source-line-no">135</span><span id="line-135"> */</span> |
| <span class="source-line-no">136</span><span id="line-136"> boolean checkCounterExists(String name, BaseSource source);</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> /**</span> |
| <span class="source-line-no">139</span><span id="line-139"> * Check if a gauge exists.</span> |
| <span class="source-line-no">140</span><span id="line-140"> * @param name name of the gauge.</span> |
| <span class="source-line-no">141</span><span id="line-141"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">142</span><span id="line-142"> * counters.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @return boolean true if gauge metric exists.</span> |
| <span class="source-line-no">144</span><span id="line-144"> */</span> |
| <span class="source-line-no">145</span><span id="line-145"> boolean checkGaugeExists(String name, BaseSource source);</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Get the value of a gauge as a double.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @param name name of the gauge.</span> |
| <span class="source-line-no">150</span><span id="line-150"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">151</span><span id="line-151"> * counters.</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @return double value of the gauge.</span> |
| <span class="source-line-no">153</span><span id="line-153"> */</span> |
| <span class="source-line-no">154</span><span id="line-154"> double getGaugeDouble(String name, BaseSource source);</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> /**</span> |
| <span class="source-line-no">157</span><span id="line-157"> * Get the value of a gauge as a long.</span> |
| <span class="source-line-no">158</span><span id="line-158"> * @param name name of the gauge.</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @param source The BaseSource{@link BaseSource} that will provide the tags, gauges, and</span> |
| <span class="source-line-no">160</span><span id="line-160"> * counters.</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @return long value of the gauge.</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> long getGaugeLong(String name, BaseSource source);</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> /**</span> |
| <span class="source-line-no">166</span><span id="line-166"> * Generates a representation of all metrics exported by the given {@code source}.</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @param source The {@link BaseSource} that will provide the metrics.</span> |
| <span class="source-line-no">168</span><span id="line-168"> * @return A representation of the metrics as a String.</span> |
| <span class="source-line-no">169</span><span id="line-169"> */</span> |
| <span class="source-line-no">170</span><span id="line-170"> String toDebugString(BaseSource source);</span> |
| <span class="source-line-no">171</span><span id="line-171">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
