| <!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: MetricsRegionServerQuotaSource"> |
| <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.hadoop.hbase.metrics.BaseSource;</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"> * A collection of exposed metrics for space quotas from an HBase RegionServer.</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 MetricsRegionServerQuotaSource extends BaseSource {</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 METRICS_NAME = "Quotas";</span> |
| <span class="source-line-no">030</span><span id="line-30"> String METRICS_CONTEXT = "regionserver";</span> |
| <span class="source-line-no">031</span><span id="line-31"> String METRICS_DESCRIPTION = "Metrics about HBase RegionServer Quotas";</span> |
| <span class="source-line-no">032</span><span id="line-32"> String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> String NUM_TABLES_IN_VIOLATION_NAME = "numTablesInViolation";</span> |
| <span class="source-line-no">035</span><span id="line-35"> String NUM_SPACE_SNAPSHOTS_RECEIVED_NAME = "numSpaceSnapshotsReceived";</span> |
| <span class="source-line-no">036</span><span id="line-36"> String FILE_SYSTEM_UTILIZATION_CHORE_TIME = "fileSystemUtilizationChoreTime";</span> |
| <span class="source-line-no">037</span><span id="line-37"> String SPACE_QUOTA_REFRESHER_CHORE_TIME = "spaceQuotaRefresherChoreTime";</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> String NUM_REGION_SIZE_REPORT_NAME = "numRegionSizeReports";</span> |
| <span class="source-line-no">040</span><span id="line-40"> String REGION_SIZE_REPORTING_CHORE_TIME_NAME = "regionSizeReportingChoreTime";</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> /**</span> |
| <span class="source-line-no">043</span><span id="line-43"> * Updates the metric tracking how many tables this RegionServer has marked as in violation of</span> |
| <span class="source-line-no">044</span><span id="line-44"> * their space quota.</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 updateNumTablesInSpaceQuotaViolation(long tablesInViolation);</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"> * Updates the metric tracking how many tables this RegionServer has received</span> |
| <span class="source-line-no">050</span><span id="line-50"> * {@code SpaceQuotaSnapshot}s for.</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param numSnapshots The number of {@code SpaceQuotaSnapshot}s received from the Master.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> void updateNumTableSpaceQuotaSnapshots(long numSnapshots);</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"> * Updates the metric tracking how much time was spent scanning the filesystem to compute the size</span> |
| <span class="source-line-no">057</span><span id="line-57"> * of each region hosted by this RegionServer.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param time The execution time of the chore in milliseconds.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> void incrementSpaceQuotaFileSystemScannerChoreTime(long time);</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Updates the metric tracking how much time was spent updating the RegionServer with the latest</span> |
| <span class="source-line-no">064</span><span id="line-64"> * information on space quotas from the {@code hbase:quota} table.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param time The execution time of the chore in milliseconds.</span> |
| <span class="source-line-no">066</span><span id="line-66"> */</span> |
| <span class="source-line-no">067</span><span id="line-67"> void incrementSpaceQuotaRefresherChoreTime(long time);</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> /**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Updates the metric tracking how many region size reports were sent from this RegionServer to</span> |
| <span class="source-line-no">071</span><span id="line-71"> * the Master. These reports contain information on the size of each Region hosted locally.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param numReportsSent The number of region size reports sent</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 incrementNumRegionSizeReportsSent(long numReportsSent);</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"> * Updates the metric tracking how much time was spent sending region size reports to the Master</span> |
| <span class="source-line-no">078</span><span id="line-78"> * by the RegionSizeReportingChore.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param time The execution time in milliseconds.</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> void incrementRegionSizeReportingChoreTime(long time);</span> |
| <span class="source-line-no">082</span><span id="line-82">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
