| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>BaseSource (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.metrics, interface: BaseSource"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.metrics</a></div> |
| <h1 title="Interface BaseSource" class="title">Interface BaseSource</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ExceptionTrackingSource.html" title="interface in org.apache.hadoop.hbase.metrics">ExceptionTrackingSource</a></code>, <code><a href="../master/MetricsAssignmentManagerSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsAssignmentManagerSource</a></code>, <code><a href="../master/balancer/MetricsBalancerSource.html" title="interface in org.apache.hadoop.hbase.master.balancer">MetricsBalancerSource</a></code>, <code><a href="../ipc/MetricsHBaseServerSource.html" title="interface in org.apache.hadoop.hbase.ipc">MetricsHBaseServerSource</a></code>, <code><a href="../regionserver/MetricsHeapMemoryManagerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSource</a></code>, <code><a href="../io/MetricsIOSource.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOSource</a></code>, <code><a href="../master/MetricsMasterFileSystemSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterFileSystemSource</a></code>, <code><a href="../master/MetricsMasterProcSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterProcSource</a></code>, <code><a href="../master/MetricsMasterQuotaSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterQuotaSource</a></code>, <code><a href="../master/MetricsMasterSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsMasterSource</a></code>, <code><a href="../regionserver/MetricsRegionAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionAggregateSource</a></code>, <code><a href="../regionserver/MetricsRegionServerQuotaSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerQuotaSource</a></code>, <code><a href="../regionserver/MetricsRegionServerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSource</a></code>, <code><a href="../replication/regionserver/MetricsReplicationGlobalSourceSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationGlobalSourceSource</a></code>, <code><a href="../replication/regionserver/MetricsReplicationSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSource</a></code>, <code><a href="../replication/regionserver/MetricsReplicationSourceSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceSource</a></code>, <code><a href="../replication/regionserver/MetricsReplicationTableSource.html" title="interface in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationTableSource</a></code>, <code><a href="../rest/MetricsRESTSource.html" title="interface in org.apache.hadoop.hbase.rest">MetricsRESTSource</a></code>, <code><a href="../master/MetricsSnapshotSource.html" title="interface in org.apache.hadoop.hbase.master">MetricsSnapshotSource</a></code>, <code><a href="../master/balancer/MetricsStochasticBalancerSource.html" title="interface in org.apache.hadoop.hbase.master.balancer">MetricsStochasticBalancerSource</a></code>, <code><a href="../regionserver/MetricsTableAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSource</a></code>, <code><a href="../thrift/MetricsThriftServerSource.html" title="interface in org.apache.hadoop.hbase.thrift">MetricsThriftServerSource</a></code>, <code><a href="../regionserver/MetricsUserAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSource</a></code>, <code><a href="../namequeues/MetricsWALEventTrackerSource.html" title="interface in org.apache.hadoop.hbase.namequeues">MetricsWALEventTrackerSource</a></code>, <code><a href="../regionserver/wal/MetricsWALSource.html" title="interface in org.apache.hadoop.hbase.regionserver.wal">MetricsWALSource</a></code>, <code><a href="../zookeeper/MetricsZooKeeperSource.html" title="interface in org.apache.hadoop.hbase.zookeeper">MetricsZooKeeperSource</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics">BaseSourceImpl</a></code>, <code><a href="ExceptionTrackingSourceImpl.html" title="class in org.apache.hadoop.hbase.metrics">ExceptionTrackingSourceImpl</a></code>, <code><a href="../master/MetricsAssignmentManagerSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsAssignmentManagerSourceImpl</a></code>, <code><a href="../master/balancer/MetricsBalancerSourceImpl.html" title="class in org.apache.hadoop.hbase.master.balancer">MetricsBalancerSourceImpl</a></code>, <code><a href="../ipc/MetricsHBaseServerSourceImpl.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServerSourceImpl</a></code>, <code><a href="../regionserver/MetricsHeapMemoryManagerSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSourceImpl</a></code>, <code><a href="../io/MetricsIOSourceImpl.html" title="class in org.apache.hadoop.hbase.io">MetricsIOSourceImpl</a></code>, <code><a href="../master/MetricsMasterFilesystemSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterFilesystemSourceImpl</a></code>, <code><a href="../master/MetricsMasterProcSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterProcSourceImpl</a></code>, <code><a href="../master/MetricsMasterQuotaSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterQuotaSourceImpl</a></code>, <code><a href="../master/MetricsMasterSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsMasterSourceImpl</a></code>, <code><a href="../regionserver/MetricsRegionAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionAggregateSourceImpl</a></code>, <code><a href="../regionserver/MetricsRegionServerQuotaSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionServerQuotaSourceImpl</a></code>, <code><a href="../regionserver/MetricsRegionServerSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSourceImpl</a></code>, <code><a href="../replication/regionserver/MetricsReplicationGlobalSourceSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationGlobalSourceSourceImpl</a></code>, <code><a href="../replication/regionserver/MetricsReplicationSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceImpl</a></code>, <code><a href="../replication/regionserver/MetricsReplicationSourceSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationSourceSourceImpl</a></code>, <code><a href="../replication/regionserver/MetricsReplicationTableSourceImpl.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsReplicationTableSourceImpl</a></code>, <code><a href="../rest/MetricsRESTSourceImpl.html" title="class in org.apache.hadoop.hbase.rest">MetricsRESTSourceImpl</a></code>, <code><a href="../master/MetricsSnapshotSourceImpl.html" title="class in org.apache.hadoop.hbase.master">MetricsSnapshotSourceImpl</a></code>, <code><a href="../replication/regionserver/MetricsSource.html" title="class in org.apache.hadoop.hbase.replication.regionserver">MetricsSource</a></code>, <code><a href="../master/balancer/MetricsStochasticBalancerSourceImpl.html" title="class in org.apache.hadoop.hbase.master.balancer">MetricsStochasticBalancerSourceImpl</a></code>, <code><a href="../regionserver/MetricsTableAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSourceImpl</a></code>, <code><a href="../thrift/MetricsThriftServerSourceImpl.html" title="class in org.apache.hadoop.hbase.thrift">MetricsThriftServerSourceImpl</a></code>, <code><a href="../regionserver/MetricsUserAggregateSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSourceImpl</a></code>, <code><a href="../namequeues/MetricsWALEventTrackerSourceImpl.html" title="class in org.apache.hadoop.hbase.namequeues">MetricsWALEventTrackerSourceImpl</a></code>, <code><a href="../regionserver/wal/MetricsWALSourceImpl.html" title="class in org.apache.hadoop.hbase.regionserver.wal">MetricsWALSourceImpl</a></code>, <code><a href="../zookeeper/MetricsZooKeeperSourceImpl.html" title="class in org.apache.hadoop.hbase.zookeeper">MetricsZooKeeperSourceImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-26">BaseSource</a></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#HBASE_METRICS_SYSTEM_NAME" class="member-name-link">HBASE_METRICS_SYSTEM_NAME</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#decGauge(java.lang.String,long)" class="member-name-link">decGauge</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long delta)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Subtract some amount from a gauge.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="MetricRegistryInfo.html" title="class in org.apache.hadoop.hbase.metrics">MetricRegistryInfo</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getMetricRegistryInfo()" class="member-name-link">getMetricRegistryInfo</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMetricsContext()" class="member-name-link">getMetricsContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the metrics context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMetricsDescription()" class="member-name-link">getMetricsDescription</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the description of what this source exposes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMetricsJmxContext()" class="member-name-link">getMetricsJmxContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the name of the context in JMX that this source will be exposed through.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMetricsName()" class="member-name-link">getMetricsName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the name of the metrics that are being exported by this source.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#incCounters(java.lang.String,long)" class="member-name-link">incCounters</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> counterName, |
| long delta)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Add some amount to a counter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#incGauge(java.lang.String,long)" class="member-name-link">incGauge</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long delta)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Add some amount to a gauge.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#init()" class="member-name-link">init</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Clear out the metrics and re-prepare the source.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeMetric(java.lang.String)" class="member-name-link">removeMetric</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Remove a metric and no longer announce it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setGauge(java.lang.String,long)" class="member-name-link">setGauge</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set a gauge to a specific value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updateHistogram(java.lang.String,long)" class="member-name-link">updateHistogram</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Add some value to a histogram.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="HBASE_METRICS_SYSTEM_NAME"> |
| <h3>HBASE_METRICS_SYSTEM_NAME</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-29">HBASE_METRICS_SYSTEM_NAME</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.metrics.BaseSource.HBASE_METRICS_SYSTEM_NAME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="init()"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-34">init</a></span>()</div> |
| <div class="block">Clear out the metrics and re-prepare the source.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setGauge(java.lang.String,long)"> |
| <h3>setGauge</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-41">setGauge</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long value)</span></div> |
| <div class="block">Set a gauge to a specific value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gaugeName</code> - the name of the gauge</dd> |
| <dd><code>value</code> - the value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="incGauge(java.lang.String,long)"> |
| <h3>incGauge</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-48">incGauge</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long delta)</span></div> |
| <div class="block">Add some amount to a gauge.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gaugeName</code> - the name of the gauge</dd> |
| <dd><code>delta</code> - the amount to change the gauge by.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="decGauge(java.lang.String,long)"> |
| <h3>decGauge</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-55">decGauge</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> gaugeName, |
| long delta)</span></div> |
| <div class="block">Subtract some amount from a gauge.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gaugeName</code> - the name of the gauge</dd> |
| <dd><code>delta</code> - the amount to change the gauge by.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeMetric(java.lang.String)"> |
| <h3>removeMetric</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-61">removeMetric</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key)</span></div> |
| <div class="block">Remove a metric and no longer announce it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - Name of the gauge to remove.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="incCounters(java.lang.String,long)"> |
| <h3>incCounters</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-68">incCounters</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> counterName, |
| long delta)</span></div> |
| <div class="block">Add some amount to a counter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>counterName</code> - the name of the counter</dd> |
| <dd><code>delta</code> - the amount to change the counter by.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateHistogram(java.lang.String,long)"> |
| <h3>updateHistogram</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-75">updateHistogram</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| long value)</span></div> |
| <div class="block">Add some value to a histogram.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the histogram</dd> |
| <dd><code>value</code> - the value to add to the histogram</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricsContext()"> |
| <h3>getMetricsContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-82">getMetricsContext</a></span>()</div> |
| <div class="block">Get the metrics context. For hadoop metrics2 system this is usually an all lowercased string. |
| eg. regionserver, master, thriftserver</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The string context used to register this source to hadoop's metrics2 system.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricsDescription()"> |
| <h3>getMetricsDescription</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-87">getMetricsDescription</a></span>()</div> |
| <div class="block">Get the description of what this source exposes.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricsJmxContext()"> |
| <h3>getMetricsJmxContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-93">getMetricsJmxContext</a></span>()</div> |
| <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 -> HBase</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricsName()"> |
| <h3>getMetricsName</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-98">getMetricsName</a></span>()</div> |
| <div class="block">Get the name of the metrics that are being exported by this source. Eg. IPC, GC, WAL</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricRegistryInfo()"> |
| <h3>getMetricRegistryInfo</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="MetricRegistryInfo.html" title="class in org.apache.hadoop.hbase.metrics">MetricRegistryInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/BaseSource.html#line-100">getMetricRegistryInfo</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
