| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MetricsRegionServerSourceFactory (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.regionserver, interface: MetricsRegionServerSourceFactory"> |
| <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/MetricsRegionServerSourceFactory.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </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.regionserver</a></div> |
| <h1 title="Interface MetricsRegionServerSourceFactory" class="title">Interface MetricsRegionServerSourceFactory</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="MetricsRegionServerSourceFactoryImpl.html" title="class in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSourceFactoryImpl</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/regionserver/MetricsRegionServerSourceFactory.html#line-27">MetricsRegionServerSourceFactory</a></span></div> |
| <div class="block">Interface of a factory to create Metrics Sources used inside of regionservers.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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></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><a href="../io/MetricsIOSource.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOSource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createIO(org.apache.hadoop.hbase.io.MetricsIOWrapper)" class="member-name-link">createIO</a><wbr>(<a href="../io/MetricsIOWrapper.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOWrapper</a> wrapper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a MetricsIOSource from a MetricsIOWrapper.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsRegionSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionSource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createRegion(org.apache.hadoop.hbase.regionserver.MetricsRegionWrapper)" class="member-name-link">createRegion</a><wbr>(<a href="MetricsRegionWrapper.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionWrapper</a> wrapper)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a MetricsRegionSource from a MetricsRegionWrapper.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsRegionServerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createServer(org.apache.hadoop.hbase.regionserver.MetricsRegionServerWrapper)" class="member-name-link">createServer</a><wbr>(<a href="MetricsRegionServerWrapper.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerWrapper</a> regionServerWrapper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Given a wrapper create a MetricsRegionServerSource.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsTableSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableSource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createTable(java.lang.String,org.apache.hadoop.hbase.regionserver.MetricsTableWrapperAggregate)" class="member-name-link">createTable</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> table, |
| <a href="MetricsTableWrapperAggregate.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableWrapperAggregate</a> wrapper)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a MetricsTableSource from a MetricsTableWrapper.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsUserSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserSource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createUser(java.lang.String)" class="member-name-link">createUser</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> shortUserName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a MetricsUserSource from a user</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsHeapMemoryManagerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHeapMemoryManager()" class="member-name-link">getHeapMemoryManager</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 a MetricsHeapMemoryManagerSource</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsTableAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTableAggregate()" class="member-name-link">getTableAggregate</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 a MetricsTableAggregateSource</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MetricsUserAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUserAggregate()" class="member-name-link">getUserAggregate</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return the singleton instance for MetricsUserAggregateSource</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createServer(org.apache.hadoop.hbase.regionserver.MetricsRegionServerWrapper)"> |
| <h3>createServer</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsRegionServerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-35">createServer</a></span><wbr><span class="parameters">(<a href="MetricsRegionServerWrapper.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionServerWrapper</a> regionServerWrapper)</span></div> |
| <div class="block">Given a wrapper create a MetricsRegionServerSource.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regionServerWrapper</code> - The wrapped region server</dd> |
| <dt>Returns:</dt> |
| <dd>a Metrics Source.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegion(org.apache.hadoop.hbase.regionserver.MetricsRegionWrapper)"> |
| <h3>createRegion</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsRegionSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-42">createRegion</a></span><wbr><span class="parameters">(<a href="MetricsRegionWrapper.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsRegionWrapper</a> wrapper)</span></div> |
| <div class="block">Create a MetricsRegionSource from a MetricsRegionWrapper.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>wrapper</code> - The wrapped region</dd> |
| <dt>Returns:</dt> |
| <dd>A metrics region source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createUser(java.lang.String)"> |
| <h3>createUser</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsUserSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-48">createUser</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> shortUserName)</span></div> |
| <div class="block">Create a MetricsUserSource from a user</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A metrics user source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUserAggregate()"> |
| <h3>getUserAggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsUserAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsUserAggregateSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-54">getUserAggregate</a></span>()</div> |
| <div class="block">Return the singleton instance for MetricsUserAggregateSource</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A metrics user aggregate source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTable(java.lang.String,org.apache.hadoop.hbase.regionserver.MetricsTableWrapperAggregate)"> |
| <h3>createTable</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsTableSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-62">createTable</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> table, |
| <a href="MetricsTableWrapperAggregate.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableWrapperAggregate</a> wrapper)</span></div> |
| <div class="block">Create a MetricsTableSource from a MetricsTableWrapper.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - The table name</dd> |
| <dd><code>wrapper</code> - The wrapped table aggregate</dd> |
| <dt>Returns:</dt> |
| <dd>A metrics table source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableAggregate()"> |
| <h3>getTableAggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsTableAggregateSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsTableAggregateSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-68">getTableAggregate</a></span>()</div> |
| <div class="block">Get a MetricsTableAggregateSource</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A metrics table aggregate source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapMemoryManager()"> |
| <h3>getHeapMemoryManager</h3> |
| <div class="member-signature"><span class="return-type"><a href="MetricsHeapMemoryManagerSource.html" title="interface in org.apache.hadoop.hbase.regionserver">MetricsHeapMemoryManagerSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-74">getHeapMemoryManager</a></span>()</div> |
| <div class="block">Get a MetricsHeapMemoryManagerSource</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A metrics heap memory manager source</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createIO(org.apache.hadoop.hbase.io.MetricsIOWrapper)"> |
| <h3>createIO</h3> |
| <div class="member-signature"><span class="return-type"><a href="../io/MetricsIOSource.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOSource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.html#line-80">createIO</a></span><wbr><span class="parameters">(<a href="../io/MetricsIOWrapper.html" title="interface in org.apache.hadoop.hbase.io">MetricsIOWrapper</a> wrapper)</span></div> |
| <div class="block">Create a MetricsIOSource from a MetricsIOWrapper.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A metrics IO source</dd> |
| </dl> |
| </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> |
