blob: ba1928ab97495063a44d604524170bfcee68b2a4 [file] [log] [blame]
<!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.regionserver, interface: MetricsTableSource">
<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.regionserver;</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.io.Closeable;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">/**</span>
<span class="source-line-no">024</span><span id="line-24"> * This interface will be implemented to allow region server to push table metrics into</span>
<span class="source-line-no">025</span><span id="line-25"> * MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.</span>
<span class="source-line-no">026</span><span id="line-26"> */</span>
<span class="source-line-no">027</span><span id="line-27">@InterfaceAudience.Private</span>
<span class="source-line-no">028</span><span id="line-28">public interface MetricsTableSource extends Comparable&lt;MetricsTableSource&gt;, Closeable {</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30"> String TABLE_SIZE = "tableSize";</span>
<span class="source-line-no">031</span><span id="line-31"> String TABLE_SIZE_DESC = "Total size of the table in the region server";</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33"> String getTableName();</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> /**</span>
<span class="source-line-no">036</span><span id="line-36"> * Close the table's metrics as all the region are closing.</span>
<span class="source-line-no">037</span><span id="line-37"> */</span>
<span class="source-line-no">038</span><span id="line-38"> @Override</span>
<span class="source-line-no">039</span><span id="line-39"> void close();</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> void registerMetrics();</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> /**</span>
<span class="source-line-no">044</span><span id="line-44"> * Get the aggregate source to which this reports.</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46"> MetricsTableAggregateSource getAggregateSource();</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"> * Update the split transaction time histogram</span>
<span class="source-line-no">050</span><span id="line-50"> * @param t time it took, in milliseconds</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52"> void updateSplitTime(long t);</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /**</span>
<span class="source-line-no">055</span><span id="line-55"> * Increment number of a requested splits</span>
<span class="source-line-no">056</span><span id="line-56"> */</span>
<span class="source-line-no">057</span><span id="line-57"> void incrSplitRequest();</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> /**</span>
<span class="source-line-no">060</span><span id="line-60"> * Increment number of successful splits</span>
<span class="source-line-no">061</span><span id="line-61"> */</span>
<span class="source-line-no">062</span><span id="line-62"> void incrSplitSuccess();</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> /**</span>
<span class="source-line-no">065</span><span id="line-65"> * Update the flush time histogram</span>
<span class="source-line-no">066</span><span id="line-66"> * @param t time it took, in milliseconds</span>
<span class="source-line-no">067</span><span id="line-67"> */</span>
<span class="source-line-no">068</span><span id="line-68"> void updateFlushTime(long t);</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> /**</span>
<span class="source-line-no">071</span><span id="line-71"> * Update the flush memstore size histogram</span>
<span class="source-line-no">072</span><span id="line-72"> * @param bytes the number of bytes in the memstore</span>
<span class="source-line-no">073</span><span id="line-73"> */</span>
<span class="source-line-no">074</span><span id="line-74"> void updateFlushMemstoreSize(long bytes);</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"> * Update the flush output file size histogram</span>
<span class="source-line-no">078</span><span id="line-78"> * @param bytes the number of bytes in the output file</span>
<span class="source-line-no">079</span><span id="line-79"> */</span>
<span class="source-line-no">080</span><span id="line-80"> void updateFlushOutputSize(long bytes);</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> /**</span>
<span class="source-line-no">083</span><span id="line-83"> * Update the compaction time histogram, both major and minor</span>
<span class="source-line-no">084</span><span id="line-84"> * @param isMajor whether compaction is a major compaction</span>
<span class="source-line-no">085</span><span id="line-85"> * @param t time it took, in milliseconds</span>
<span class="source-line-no">086</span><span id="line-86"> */</span>
<span class="source-line-no">087</span><span id="line-87"> void updateCompactionTime(boolean isMajor, long t);</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"> * Update the compaction input number of files histogram</span>
<span class="source-line-no">091</span><span id="line-91"> * @param isMajor whether compaction is a major compaction</span>
<span class="source-line-no">092</span><span id="line-92"> * @param c number of files</span>
<span class="source-line-no">093</span><span id="line-93"> */</span>
<span class="source-line-no">094</span><span id="line-94"> void updateCompactionInputFileCount(boolean isMajor, long c);</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"> * Update the compaction total input file size histogram</span>
<span class="source-line-no">098</span><span id="line-98"> * @param isMajor whether compaction is a major compaction</span>
<span class="source-line-no">099</span><span id="line-99"> * @param bytes the number of bytes of the compaction input file</span>
<span class="source-line-no">100</span><span id="line-100"> */</span>
<span class="source-line-no">101</span><span id="line-101"> void updateCompactionInputSize(boolean isMajor, long bytes);</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> /**</span>
<span class="source-line-no">104</span><span id="line-104"> * Update the compaction output number of files histogram</span>
<span class="source-line-no">105</span><span id="line-105"> * @param isMajor whether compaction is a major compaction</span>
<span class="source-line-no">106</span><span id="line-106"> * @param c number of files</span>
<span class="source-line-no">107</span><span id="line-107"> */</span>
<span class="source-line-no">108</span><span id="line-108"> void updateCompactionOutputFileCount(boolean isMajor, long c);</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> /**</span>
<span class="source-line-no">111</span><span id="line-111"> * Update the compaction total output file size</span>
<span class="source-line-no">112</span><span id="line-112"> * @param isMajor whether compaction is a major compaction</span>
<span class="source-line-no">113</span><span id="line-113"> * @param bytes the number of bytes of the compaction input file</span>
<span class="source-line-no">114</span><span id="line-114"> */</span>
<span class="source-line-no">115</span><span id="line-115"> void updateCompactionOutputSize(boolean isMajor, long bytes);</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117">}</span>
</pre>
</div>
</main>
</body>
</html>