Google Git
Sign in
apache / hbase-site / 16192eed0a42de99b0c0a5085fc488f0b4b5676a / . / devapidocs / src-html / org / apache / hadoop / hbase / master / MetricsMasterQuotaSource.html
blob: 76e7e5858f1362ab279e064d61c88ba73378120e [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>package org.apache.hadoop.hbase.master;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.metrics.BaseSource;<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> * A collection of exposed metrics for space quotas from the HBase Master.<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span>@InterfaceAudience.Private<a name="line.26"></a>
<span class="sourceLineNo">027</span>public interface MetricsMasterQuotaSource extends BaseSource {<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span> String METRICS_NAME = "Quotas";<a name="line.29"></a>
<span class="sourceLineNo">030</span> String METRICS_CONTEXT = "master";<a name="line.30"></a>
<span class="sourceLineNo">031</span> String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;<a name="line.31"></a>
<span class="sourceLineNo">032</span> String METRICS_DESCRIPTION = "Metrics about HBase Quotas by the Master";<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> String NUM_SPACE_QUOTAS_NAME = "numSpaceQuotas";<a name="line.34"></a>
<span class="sourceLineNo">035</span> String NUM_SPACE_QUOTAS_DESC = "Number of space quotas defined";<a name="line.35"></a>
<span class="sourceLineNo">036</span> String NUM_TABLES_QUOTA_VIOLATIONS_NAME = "numTablesInQuotaViolation";<a name="line.36"></a>
<span class="sourceLineNo">037</span> String NUM_TABLES_QUOTA_VIOLATIONS_DESC = "Number of tables violating space quotas";<a name="line.37"></a>
<span class="sourceLineNo">038</span> String NUM_NS_QUOTA_VIOLATIONS_NAME = "numNamespaceInQuotaViolation";<a name="line.38"></a>
<span class="sourceLineNo">039</span> String NUM_NS_QUOTA_VIOLATIONS_DESC = "Number of namespaces violating space quotas";<a name="line.39"></a>
<span class="sourceLineNo">040</span> String NUM_REGION_SIZE_REPORTS_NAME = "numRegionSizeReports";<a name="line.40"></a>
<span class="sourceLineNo">041</span> String NUM_REGION_SIZE_REPORTS_DESC = "Number of Region sizes reported";<a name="line.41"></a>
<span class="sourceLineNo">042</span> String QUOTA_OBSERVER_CHORE_TIME_NAME = "quotaObserverChoreTime";<a name="line.42"></a>
<span class="sourceLineNo">043</span> String QUOTA_OBSERVER_CHORE_TIME_DESC =<a name="line.43"></a>
<span class="sourceLineNo">044</span> "Histogram for the time in millis for the QuotaObserverChore";<a name="line.44"></a>
<span class="sourceLineNo">045</span> String SNAPSHOT_OBSERVER_CHORE_TIME_NAME = "snapshotQuotaObserverChoreTime";<a name="line.45"></a>
<span class="sourceLineNo">046</span> String SNAPSHOT_OBSERVER_CHORE_TIME_DESC =<a name="line.46"></a>
<span class="sourceLineNo">047</span> "Histogram for the time in millis for the SnapshotQuotaObserverChore";<a name="line.47"></a>
<span class="sourceLineNo">048</span> String SNAPSHOT_OBSERVER_SIZE_COMPUTATION_TIME_NAME = "snapshotObserverSizeComputationTime";<a name="line.48"></a>
<span class="sourceLineNo">049</span> String SNAPSHOT_OBSERVER_SIZE_COMPUTATION_TIME_DESC =<a name="line.49"></a>
<span class="sourceLineNo">050</span> "Histogram for the time in millis to compute the size of each snapshot";<a name="line.50"></a>
<span class="sourceLineNo">051</span> String SNAPSHOT_OBSERVER_FETCH_TIME_NAME = "snapshotObserverSnapshotFetchTime";<a name="line.51"></a>
<span class="sourceLineNo">052</span> String SNAPSHOT_OBSERVER_FETCH_TIME_DESC =<a name="line.52"></a>
<span class="sourceLineNo">053</span> "Histogram for the time in millis to fetch all snapshots from HBase";<a name="line.53"></a>
<span class="sourceLineNo">054</span> String TABLE_QUOTA_USAGE_NAME = "tableSpaceQuotaOverview";<a name="line.54"></a>
<span class="sourceLineNo">055</span> String TABLE_QUOTA_USAGE_DESC = "A JSON summary of the usage of all tables with space quotas";<a name="line.55"></a>
<span class="sourceLineNo">056</span> String NS_QUOTA_USAGE_NAME = "namespaceSpaceQuotaOverview";<a name="line.56"></a>
<span class="sourceLineNo">057</span> String NS_QUOTA_USAGE_DESC = "A JSON summary of the usage of all namespaces with space quotas";<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Updates the metric tracking the number of space quotas defined in the system.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param numSpaceQuotas The number of space quotas defined<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> void updateNumSpaceQuotas(long numSpaceQuotas);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Updates the metric tracking the number of tables the master has computed to be in violation of<a name="line.66"></a>
<span class="sourceLineNo">067</span> * their space quota.<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @param numTablesInViolation The number of tables violating a space quota<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> void updateNumTablesInSpaceQuotaViolation(long numTablesInViolation);<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Updates the metric tracking the number of namespaces the master has computed to be in violation<a name="line.73"></a>
<span class="sourceLineNo">074</span> * of their space quota.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param numNamespacesInViolation The number of namespaces violating a space quota<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> void updateNumNamespacesInSpaceQuotaViolation(long numNamespacesInViolation);<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Updates the metric tracking the number of region size reports the master is currently retaining<a name="line.80"></a>
<span class="sourceLineNo">081</span> * in memory.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param numCurrentRegionSizeReports The number of region size reports the master is holding in<a name="line.82"></a>
<span class="sourceLineNo">083</span> * memory<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> void updateNumCurrentSpaceQuotaRegionSizeReports(long numCurrentRegionSizeReports);<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> * Updates the metric tracking the amount of time taken by the {@code QuotaObserverChore} which<a name="line.88"></a>
<span class="sourceLineNo">089</span> * runs periodically.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @param time The execution time of the chore in milliseconds<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> void incrementSpaceQuotaObserverChoreTime(long time);<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}<a name="line.95"></a>
<span class="sourceLineNo">096</span> * which runs periodically.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> void incrementSnapshotObserverChoreTime(long time);<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}<a name="line.101"></a>
<span class="sourceLineNo">102</span> * to compute the size of one snapshot, relative to the files referenced by the originating table.<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> void incrementSnapshotObserverSnapshotComputationTime(long time);<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * Updates the metric tracking the amount of time taken by the {@code SnapshotQuotaObserverChore}<a name="line.107"></a>
<span class="sourceLineNo">108</span> * to fetch all snapshots.<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span> void incrementSnapshotObserverSnapshotFetchTime(long time);<a name="line.110"></a>
<span class="sourceLineNo">111</span>}<a name="line.111"></a>
</pre>
</div>
</body>
</html>