Google Git
Sign in
apache / hbase-site / 03b765b44d7f220e28d9ea78367df882726f2ec9 / . / devapidocs / org / apache / hadoop / hbase / metrics / BaseSource.html
blob: a96aa3ce40dbd0e51fc6349ebc397dd36c19db0f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BaseSource (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BaseSource (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseSource.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/metrics/BaseSource.html" target="_top">Frames</a></li>
<li><a href="BaseSource.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.metrics</div>
<h2 title="Interface BaseSource" class="title">Interface BaseSource</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/metrics/ExceptionTrackingSource.html" title="interface in org.apache.hadoop.hbase.metrics">ExceptionTrackingSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsAssignmentManagerSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsAssignmentManagerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/balancer/MetricsBalancerSource.html" title="interface in org.apache.hadoop.hbase.master.balancer">MetricsBalancerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/ipc/MetricsHBaseServerSource.html" title="interface in org.apache.hadoop.hbase.ipc">MetricsHBaseServerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsHeapMemoryManagerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/io/MetricsIOSource.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterFileSystemSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterFileSystemSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterProcSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterProcSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterQuotaSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterQuotaSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionAggregateSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionServerQuotaSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerQuotaSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionServerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationGlobalSourceSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationGlobalSourceSource</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSource</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationSourceSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceSource</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationTableSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationTableSource</a>, <a href="../../../../../org/apache/hadoop/hbase/rest/MetricsRESTSource.html" title="interface in org.apache.hadoop.hbase.rest">MetricsRESTSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsSnapshotSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsSnapshotSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/balancer/MetricsStochasticBalancerSource.html" title="interface in org.apache.hadoop.hbase.master.balancer">MetricsStochasticBalancerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsTableAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSource</a>, <a href="../../../../../org/apache/hadoop/hbase/thrift/MetricsThriftServerSource.html" title="interface in org.apache.hadoop.hbase.thrift">MetricsThriftServerSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsUserAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSource</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/wal/MetricsWALSource.html" title="interface in org.apache.hadoop.hbase.regionserver.wal">MetricsWALSource</a>, <a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetricsZooKeeperSource.html" title="interface in org.apache.hadoop.hbase.zookeeper">MetricsZooKeeperSource</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics">BaseSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/metrics/ExceptionTrackingSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics">ExceptionTrackingSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsAssignmentManagerSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsAssignmentManagerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/balancer/MetricsBalancerSourceImpl.html" title="class in org.apache.hadoop.hbase.master.balancer">MetricsBalancerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/ipc/MetricsHBaseServerSourceImpl.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsHeapMemoryManagerSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/io/MetricsIOSourceImpl.html" title="class in org.apache.hadoop.hbase.io">MetricsIOSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterFilesystemSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterFilesystemSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterProcSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterProcSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterQuotaSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterQuotaSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsMasterSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionAggregateSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionServerQuotaSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionServerQuotaSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationGlobalSourceSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationGlobalSourceSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationSourceSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsReplicationTableSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationTableSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/rest/MetricsRESTSourceImpl.html" title="class in org.apache.hadoop.hbase.rest">MetricsRESTSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/master/MetricsSnapshotSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsSnapshotSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/replication/regionserver/MetricsSource.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsSource</a>, <a href="../../../../../org/apache/hadoop/hbase/master/balancer/MetricsStochasticBalancerSourceImpl.html" title="class in org.apache.hadoop.hbase.master.balancer">MetricsStochasticBalancerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsTableAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsTableLatenciesImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsTableLatenciesImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/thrift/MetricsThriftServerSourceImpl.html" title="class in org.apache.hadoop.hbase.thrift">MetricsThriftServerSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/MetricsUserAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/wal/MetricsWALSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver.wal">MetricsWALSourceImpl</a>, <a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetricsZooKeeperSourceImpl.html" title="class in org.apache.hadoop.hbase.zookeeper">MetricsZooKeeperSourceImpl</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.28">BaseSource</a></pre>
<div class="block">BaseSource for dynamic metrics to announce to Metrics2.
In hbase-hadoop{1|2}-compat there is an implementation of this interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#HBASE_METRICS_SYSTEM_NAME">HBASE_METRICS_SYSTEM_NAME</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#decGauge-java.lang.String-long-">decGauge</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;delta)</code>
<div class="block">Subtract some amount from a gauge.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/metrics/MetricRegistryInfo.html" title="class in org.apache.hadoop.hbase.metrics">MetricRegistryInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#getMetricRegistryInfo--">getMetricRegistryInfo</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#getMetricsContext--">getMetricsContext</a></span>()</code>
<div class="block">Get the metrics context.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#getMetricsDescription--">getMetricsDescription</a></span>()</code>
<div class="block">Get the description of what this source exposes.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#getMetricsJmxContext--">getMetricsJmxContext</a></span>()</code>
<div class="block">Get the name of the context in JMX that this source will be exposed through.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#getMetricsName--">getMetricsName</a></span>()</code>
<div class="block">Get the name of the metrics that are being exported by this source.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#incCounters-java.lang.String-long-">incCounters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;counterName,
long&nbsp;delta)</code>
<div class="block">Add some amount to a counter.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#incGauge-java.lang.String-long-">incGauge</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;delta)</code>
<div class="block">Add some amount to a gauge.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#init--">init</a></span>()</code>
<div class="block">Clear out the metrics and re-prepare the source.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#removeMetric-java.lang.String-">removeMetric</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>
<div class="block">Remove a metric and no longer announce it.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#setGauge-java.lang.String-long-">setGauge</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;value)</code>
<div class="block">Set a gauge to a specific value.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSource.html#updateHistogram-java.lang.String-long-">updateHistogram</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
long&nbsp;value)</code>
<div class="block">Add some value to a histogram.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="HBASE_METRICS_SYSTEM_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HBASE_METRICS_SYSTEM_NAME</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.30">HBASE_METRICS_SYSTEM_NAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.metrics.BaseSource.HBASE_METRICS_SYSTEM_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.35">init</a>()</pre>
<div class="block">Clear out the metrics and re-prepare the source.</div>
</li>
</ul>
<a name="setGauge-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGauge</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.43">setGauge</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;value)</pre>
<div class="block">Set a gauge to a specific value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gaugeName</code> - the name of the gauge</dd>
<dd><code>value</code> - the value</dd>
</dl>
</li>
</ul>
<a name="incGauge-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incGauge</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.51">incGauge</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;delta)</pre>
<div class="block">Add some amount to a gauge.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gaugeName</code> - the name of the gauge</dd>
<dd><code>delta</code> - the amount to change the gauge by.</dd>
</dl>
</li>
</ul>
<a name="decGauge-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decGauge</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.59">decGauge</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;gaugeName,
long&nbsp;delta)</pre>
<div class="block">Subtract some amount from a gauge.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gaugeName</code> - the name of the gauge</dd>
<dd><code>delta</code> - the amount to change the gauge by.</dd>
</dl>
</li>
</ul>
<a name="removeMetric-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMetric</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.66">removeMetric</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">Remove a metric and no longer announce it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Name of the gauge to remove.</dd>
</dl>
</li>
</ul>
<a name="incCounters-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incCounters</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.74">incCounters</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;counterName,
long&nbsp;delta)</pre>
<div class="block">Add some amount to a counter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>counterName</code> - the name of the counter</dd>
<dd><code>delta</code> - the amount to change the counter by.</dd>
</dl>
</li>
</ul>
<a name="updateHistogram-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateHistogram</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.82">updateHistogram</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
long&nbsp;value)</pre>
<div class="block">Add some value to a histogram.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the histogram</dd>
<dd><code>value</code> - the value to add to the histogram</dd>
</dl>
</li>
</ul>
<a name="getMetricsContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsContext</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.91">getMetricsContext</a>()</pre>
<div class="block">Get the metrics context. For hadoop metrics2 system this is usually an all lowercased string.
eg. regionserver, master, thriftserver</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The string context used to register this source to hadoop's metrics2 system.</dd>
</dl>
</li>
</ul>
<a name="getMetricsDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsDescription</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.96">getMetricsDescription</a>()</pre>
<div class="block">Get the description of what this source exposes.</div>
</li>
</ul>
<a name="getMetricsJmxContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsJmxContext</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.102">getMetricsJmxContext</a>()</pre>
<div class="block">Get the name of the context in JMX that this source will be exposed through.
This is in ObjectName format. With the default context being Hadoop -&gt; HBase</div>
</li>
</ul>
<a name="getMetricsName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricsName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.108">getMetricsName</a>()</pre>
<div class="block">Get the name of the metrics that are being exported by this source.
Eg. IPC, GC, WAL</div>
</li>
</ul>
<a name="getMetricRegistryInfo--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMetricRegistryInfo</h4>
<pre>default&nbsp;<a href="../../../../../org/apache/hadoop/hbase/metrics/MetricRegistryInfo.html" title="class in org.apache.hadoop.hbase.metrics">MetricRegistryInfo</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line.110">getMetricRegistryInfo</a>()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseSource.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/metrics/BaseSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/metrics/BaseSource.html" target="_top">Frames</a></li>
<li><a href="BaseSource.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>