| <!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.master, interface: MetricsMasterQuotaSource"> |
| <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.master;</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 the HBase Master.</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 MetricsMasterQuotaSource 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 = "master";</span> |
| <span class="source-line-no">031</span><span id="line-31"> String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;</span> |
| <span class="source-line-no">032</span><span id="line-32"> String METRICS_DESCRIPTION = "Metrics about HBase Quotas by the Master";</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_SPACE_QUOTAS_NAME = "numSpaceQuotas";</span> |
| <span class="source-line-no">035</span><span id="line-35"> String NUM_SPACE_QUOTAS_DESC = "Number of space quotas defined";</span> |
| <span class="source-line-no">036</span><span id="line-36"> String NUM_TABLES_QUOTA_VIOLATIONS_NAME = "numTablesInQuotaViolation";</span> |
| <span class="source-line-no">037</span><span id="line-37"> String NUM_TABLES_QUOTA_VIOLATIONS_DESC = "Number of tables violating space quotas";</span> |
| <span class="source-line-no">038</span><span id="line-38"> String NUM_NS_QUOTA_VIOLATIONS_NAME = "numNamespaceInQuotaViolation";</span> |
| <span class="source-line-no">039</span><span id="line-39"> String NUM_NS_QUOTA_VIOLATIONS_DESC = "Number of namespaces violating space quotas";</span> |
| <span class="source-line-no">040</span><span id="line-40"> String NUM_REGION_SIZE_REPORTS_NAME = "numRegionSizeReports";</span> |
| <span class="source-line-no">041</span><span id="line-41"> String NUM_REGION_SIZE_REPORTS_DESC = "Number of Region sizes reported";</span> |
| <span class="source-line-no">042</span><span id="line-42"> String QUOTA_OBSERVER_CHORE_TIME_NAME = "quotaObserverChoreTime";</span> |
| <span class="source-line-no">043</span><span id="line-43"> String QUOTA_OBSERVER_CHORE_TIME_DESC =</span> |
| <span class="source-line-no">044</span><span id="line-44"> "Histogram for the time in millis for the QuotaObserverChore";</span> |
| <span class="source-line-no">045</span><span id="line-45"> String SNAPSHOT_OBSERVER_CHORE_TIME_NAME = "snapshotQuotaObserverChoreTime";</span> |
| <span class="source-line-no">046</span><span id="line-46"> String SNAPSHOT_OBSERVER_CHORE_TIME_DESC =</span> |
| <span class="source-line-no">047</span><span id="line-47"> "Histogram for the time in millis for the SnapshotQuotaObserverChore";</span> |
| <span class="source-line-no">048</span><span id="line-48"> String SNAPSHOT_OBSERVER_SIZE_COMPUTATION_TIME_NAME = "snapshotObserverSizeComputationTime";</span> |
| <span class="source-line-no">049</span><span id="line-49"> String SNAPSHOT_OBSERVER_SIZE_COMPUTATION_TIME_DESC =</span> |
| <span class="source-line-no">050</span><span id="line-50"> "Histogram for the time in millis to compute the size of each snapshot";</span> |
| <span class="source-line-no">051</span><span id="line-51"> String SNAPSHOT_OBSERVER_FETCH_TIME_NAME = "snapshotObserverSnapshotFetchTime";</span> |
| <span class="source-line-no">052</span><span id="line-52"> String SNAPSHOT_OBSERVER_FETCH_TIME_DESC =</span> |
| <span class="source-line-no">053</span><span id="line-53"> "Histogram for the time in millis to fetch all snapshots from HBase";</span> |
| <span class="source-line-no">054</span><span id="line-54"> String TABLE_QUOTA_USAGE_NAME = "tableSpaceQuotaOverview";</span> |
| <span class="source-line-no">055</span><span id="line-55"> String TABLE_QUOTA_USAGE_DESC = "A JSON summary of the usage of all tables with space quotas";</span> |
| <span class="source-line-no">056</span><span id="line-56"> String NS_QUOTA_USAGE_NAME = "namespaceSpaceQuotaOverview";</span> |
| <span class="source-line-no">057</span><span id="line-57"> String NS_QUOTA_USAGE_DESC = "A JSON summary of the usage of all namespaces with space quotas";</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"> * Updates the metric tracking the number of space quotas defined in the system.</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @param numSpaceQuotas The number of space quotas defined</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 updateNumSpaceQuotas(long numSpaceQuotas);</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"> * Updates the metric tracking the number of tables the master has computed to be in violation of</span> |
| <span class="source-line-no">067</span><span id="line-67"> * their space quota.</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @param numTablesInViolation The number of tables violating a space quota</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> void updateNumTablesInSpaceQuotaViolation(long numTablesInViolation);</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Updates the metric tracking the number of namespaces the master has computed to be in violation</span> |
| <span class="source-line-no">074</span><span id="line-74"> * of their space quota.</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param numNamespacesInViolation The number of namespaces violating a space quota</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> void updateNumNamespacesInSpaceQuotaViolation(long numNamespacesInViolation);</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /**</span> |
| <span class="source-line-no">080</span><span id="line-80"> * Updates the metric tracking the number of region size reports the master is currently retaining</span> |
| <span class="source-line-no">081</span><span id="line-81"> * in memory.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param numCurrentRegionSizeReports The number of region size reports the master is holding in</span> |
| <span class="source-line-no">083</span><span id="line-83"> * memory</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> void updateNumCurrentSpaceQuotaRegionSizeReports(long numCurrentRegionSizeReports);</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Updates the metric tracking the amount of time taken by the {@code QuotaObserverChore} which</span> |
| <span class="source-line-no">089</span><span id="line-89"> * runs periodically.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param time The execution time of the chore in milliseconds</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> void incrementSpaceQuotaObserverChoreTime(long time);</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /**</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}</span> |
| <span class="source-line-no">096</span><span id="line-96"> * which runs periodically.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> void incrementSnapshotObserverChoreTime(long time);</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> |
| <span class="source-line-no">101</span><span id="line-101"> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}</span> |
| <span class="source-line-no">102</span><span id="line-102"> * to compute the size of one snapshot, relative to the files referenced by the originating table.</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> void incrementSnapshotObserverSnapshotComputationTime(long time);</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /**</span> |
| <span class="source-line-no">107</span><span id="line-107"> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}</span> |
| <span class="source-line-no">108</span><span id="line-108"> * to fetch all snapshots.</span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> void incrementSnapshotObserverSnapshotFetchTime(long time);</span> |
| <span class="source-line-no">111</span><span id="line-111">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
