blob: 4bd6cd96bba103d3102c83c1cc7f2927d211417d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.regionserver;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * This interface will be implemented to allow single regions to push metrics into<a name="line.24"></a>
<span class="sourceLineNo">025</span> * MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>@InterfaceAudience.Private<a name="line.27"></a>
<span class="sourceLineNo">028</span>public interface MetricsRegionSource extends Comparable&lt;MetricsRegionSource&gt; {<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span> String OPS_SAMPLE_NAME = "ops";<a name="line.30"></a>
<span class="sourceLineNo">031</span> String SIZE_VALUE_NAME = "size";<a name="line.31"></a>
<span class="sourceLineNo">032</span> String COMPACTIONS_COMPLETED_COUNT = "compactionsCompletedCount";<a name="line.32"></a>
<span class="sourceLineNo">033</span> String COMPACTIONS_FAILED_COUNT = "compactionsFailedCount";<a name="line.33"></a>
<span class="sourceLineNo">034</span> String LAST_MAJOR_COMPACTION_AGE = "lastMajorCompactionAge";<a name="line.34"></a>
<span class="sourceLineNo">035</span> String COMPACTIONS_QUEUED_COUNT = "compactionsQueuedCount";<a name="line.35"></a>
<span class="sourceLineNo">036</span> String MAX_COMPACTION_QUEUE_SIZE = "maxCompactionQueueSize";<a name="line.36"></a>
<span class="sourceLineNo">037</span> String NUM_BYTES_COMPACTED_COUNT = "numBytesCompactedCount";<a name="line.37"></a>
<span class="sourceLineNo">038</span> String NUM_FILES_COMPACTED_COUNT = "numFilesCompactedCount";<a name="line.38"></a>
<span class="sourceLineNo">039</span> String FLUSHES_QUEUED_COUNT = "flushesQueuedCount";<a name="line.39"></a>
<span class="sourceLineNo">040</span> String MAX_FLUSH_QUEUE_SIZE = "maxFlushQueueSize";<a name="line.40"></a>
<span class="sourceLineNo">041</span> String COMPACTIONS_COMPLETED_DESC = "Number of compactions that have completed.";<a name="line.41"></a>
<span class="sourceLineNo">042</span> String COMPACTIONS_FAILED_DESC = "Number of compactions that have failed.";<a name="line.42"></a>
<span class="sourceLineNo">043</span> String LAST_MAJOR_COMPACTION_DESC = "Age of the last major compaction in milliseconds.";<a name="line.43"></a>
<span class="sourceLineNo">044</span> String COMPACTIONS_QUEUED_DESC = "Number of compactions that are queued/running for this region";<a name="line.44"></a>
<span class="sourceLineNo">045</span> String MAX_COMPACTION_QUEUE_DESC = "Max number of compactions queued for this region";<a name="line.45"></a>
<span class="sourceLineNo">046</span> String FLUSHES_QUEUED_DESC = "Number flushes requested/queued for this region";<a name="line.46"></a>
<span class="sourceLineNo">047</span> String MAX_FLUSH_QUEUE_DESC = "Max number of flushes queued for this region";<a name="line.47"></a>
<span class="sourceLineNo">048</span> String NUM_BYTES_COMPACTED_DESC =<a name="line.48"></a>
<span class="sourceLineNo">049</span> "Sum of filesize on all files entering a finished, successful or aborted, compaction";<a name="line.49"></a>
<span class="sourceLineNo">050</span> String NUM_FILES_COMPACTED_DESC =<a name="line.50"></a>
<span class="sourceLineNo">051</span> "Number of files that were input for finished, successful or aborted, compactions";<a name="line.51"></a>
<span class="sourceLineNo">052</span> String COPROCESSOR_EXECUTION_STATISTICS = "coprocessorExecutionStatistics";<a name="line.52"></a>
<span class="sourceLineNo">053</span> String COPROCESSOR_EXECUTION_STATISTICS_DESC = "Statistics for coprocessor execution times";<a name="line.53"></a>
<span class="sourceLineNo">054</span> String REPLICA_ID = "replicaid";<a name="line.54"></a>
<span class="sourceLineNo">055</span> String REPLICA_ID_DESC = "The replica ID of a region. 0 is primary, otherwise is secondary";<a name="line.55"></a>
<span class="sourceLineNo">056</span> String ROW_READS_ONLY_ON_MEMSTORE = "memstoreOnlyRowReadsCount";<a name="line.56"></a>
<span class="sourceLineNo">057</span> String ROW_READS_ONLY_ON_MEMSTORE_DESC = "Row reads happening completely out of memstore";<a name="line.57"></a>
<span class="sourceLineNo">058</span> String MIXED_ROW_READS = "mixedRowReadsCount";<a name="line.58"></a>
<span class="sourceLineNo">059</span> String MIXED_ROW_READS_ON_STORE_DESC = "Row reads happening out of files and memstore on store";<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Close the region's metrics as this region is closing.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> void close();<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Update related counts of puts.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> void updatePut();<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Update related counts of deletes.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> void updateDelete();<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Update time of gets<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param mills time for this get operation.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> void updateGet(long mills);<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Update time used of resultScanner.next().<a name="line.83"></a>
<span class="sourceLineNo">084</span> * */<a name="line.84"></a>
<span class="sourceLineNo">085</span> void updateScanTime(long mills);<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Update related counts of increments.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> void updateIncrement();<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Update related counts of appends.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> void updateAppend();<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
<span class="sourceLineNo">098</span> * Get the aggregate source to which this reports.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> MetricsRegionAggregateSource getAggregateSource();<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>}<a name="line.103"></a>
</pre>
</div>
</body>
</html>