blob: 3c55217ad2e7d806df4ac25f5f63d7b2f0e25fcf [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: MetricsRegionSource">
<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 org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">/**</span>
<span class="source-line-no">023</span><span id="line-23"> * This interface will be implemented to allow single regions to push metrics into</span>
<span class="source-line-no">024</span><span id="line-24"> * MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.</span>
<span class="source-line-no">025</span><span id="line-25"> */</span>
<span class="source-line-no">026</span><span id="line-26">@InterfaceAudience.Private</span>
<span class="source-line-no">027</span><span id="line-27">public interface MetricsRegionSource extends Comparable&lt;MetricsRegionSource&gt; {</span>
<span class="source-line-no">028</span><span id="line-28"></span>
<span class="source-line-no">029</span><span id="line-29"> String OPS_SAMPLE_NAME = "ops";</span>
<span class="source-line-no">030</span><span id="line-30"> String SIZE_VALUE_NAME = "size";</span>
<span class="source-line-no">031</span><span id="line-31"> String COMPACTIONS_COMPLETED_COUNT = "compactionsCompletedCount";</span>
<span class="source-line-no">032</span><span id="line-32"> String COMPACTIONS_FAILED_COUNT = "compactionsFailedCount";</span>
<span class="source-line-no">033</span><span id="line-33"> String LAST_MAJOR_COMPACTION_AGE = "lastMajorCompactionAge";</span>
<span class="source-line-no">034</span><span id="line-34"> String COMPACTIONS_QUEUED_COUNT = "compactionsQueuedCount";</span>
<span class="source-line-no">035</span><span id="line-35"> String MAX_COMPACTION_QUEUE_SIZE = "maxCompactionQueueSize";</span>
<span class="source-line-no">036</span><span id="line-36"> String NUM_BYTES_COMPACTED_COUNT = "numBytesCompactedCount";</span>
<span class="source-line-no">037</span><span id="line-37"> String NUM_FILES_COMPACTED_COUNT = "numFilesCompactedCount";</span>
<span class="source-line-no">038</span><span id="line-38"> String FLUSHES_QUEUED_COUNT = "flushesQueuedCount";</span>
<span class="source-line-no">039</span><span id="line-39"> String MAX_FLUSH_QUEUE_SIZE = "maxFlushQueueSize";</span>
<span class="source-line-no">040</span><span id="line-40"> String COMPACTIONS_COMPLETED_DESC = "Number of compactions that have completed.";</span>
<span class="source-line-no">041</span><span id="line-41"> String COMPACTIONS_FAILED_DESC = "Number of compactions that have failed.";</span>
<span class="source-line-no">042</span><span id="line-42"> String LAST_MAJOR_COMPACTION_DESC = "Age of the last major compaction in milliseconds.";</span>
<span class="source-line-no">043</span><span id="line-43"> String COMPACTIONS_QUEUED_DESC = "Number of compactions that are queued/running for this region";</span>
<span class="source-line-no">044</span><span id="line-44"> String MAX_COMPACTION_QUEUE_DESC = "Max number of compactions queued for this region";</span>
<span class="source-line-no">045</span><span id="line-45"> String FLUSHES_QUEUED_DESC = "Number flushes requested/queued for this region";</span>
<span class="source-line-no">046</span><span id="line-46"> String MAX_FLUSH_QUEUE_DESC = "Max number of flushes queued for this region";</span>
<span class="source-line-no">047</span><span id="line-47"> String NUM_BYTES_COMPACTED_DESC =</span>
<span class="source-line-no">048</span><span id="line-48"> "Sum of filesize on all files entering a finished, successful or aborted, compaction";</span>
<span class="source-line-no">049</span><span id="line-49"> String NUM_FILES_COMPACTED_DESC =</span>
<span class="source-line-no">050</span><span id="line-50"> "Number of files that were input for finished, successful or aborted, compactions";</span>
<span class="source-line-no">051</span><span id="line-51"> String COPROCESSOR_EXECUTION_STATISTICS = "coprocessorExecutionStatistics";</span>
<span class="source-line-no">052</span><span id="line-52"> String COPROCESSOR_EXECUTION_STATISTICS_DESC = "Statistics for coprocessor execution times";</span>
<span class="source-line-no">053</span><span id="line-53"> String REPLICA_ID = "replicaid";</span>
<span class="source-line-no">054</span><span id="line-54"> String REPLICA_ID_DESC = "The replica ID of a region. 0 is primary, otherwise is secondary";</span>
<span class="source-line-no">055</span><span id="line-55"> String ROW_READS_ONLY_ON_MEMSTORE = "memstoreOnlyRowReadsCount";</span>
<span class="source-line-no">056</span><span id="line-56"> String ROW_READS_ONLY_ON_MEMSTORE_DESC = "Row reads happening completely out of memstore";</span>
<span class="source-line-no">057</span><span id="line-57"> String MIXED_ROW_READS = "mixedRowReadsCount";</span>
<span class="source-line-no">058</span><span id="line-58"> String MIXED_ROW_READS_ON_STORE_DESC = "Row reads happening out of files and memstore on store";</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> /**</span>
<span class="source-line-no">061</span><span id="line-61"> * Close the region's metrics as this region is closing.</span>
<span class="source-line-no">062</span><span id="line-62"> */</span>
<span class="source-line-no">063</span><span id="line-63"> void close();</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /**</span>
<span class="source-line-no">066</span><span id="line-66"> * Update related counts of puts.</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 updatePut();</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 related counts of deletes.</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 updateDelete();</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"> * Update related counts of gets</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> void updateGet();</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> /**</span>
<span class="source-line-no">081</span><span id="line-81"> * Update related counts of resultScanner.next().</span>
<span class="source-line-no">082</span><span id="line-82"> */</span>
<span class="source-line-no">083</span><span id="line-83"> void updateScan();</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> /**</span>
<span class="source-line-no">086</span><span id="line-86"> * Update related counts of increments.</span>
<span class="source-line-no">087</span><span id="line-87"> */</span>
<span class="source-line-no">088</span><span id="line-88"> void updateIncrement();</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> /**</span>
<span class="source-line-no">091</span><span id="line-91"> * Update related counts of appends.</span>
<span class="source-line-no">092</span><span id="line-92"> */</span>
<span class="source-line-no">093</span><span id="line-93"> void updateAppend();</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"> * Get the aggregate source to which this reports.</span>
<span class="source-line-no">097</span><span id="line-97"> */</span>
<span class="source-line-no">098</span><span id="line-98"> MetricsRegionAggregateSource getAggregateSource();</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>
</pre>
</div>
</main>
</body>
</html>