UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

398 lines (397 loc) 16.6 kB
<!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 (version 1.7.0_67) on Sun Sep 07 15:29:28 CEST 2014 --> <title>CompactionMetrics (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="CompactionMetrics (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/CompactionMetrics.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><a href="../../../../org/apache/cassandra/metrics/CommitLogMetrics.html" title="class in org.apache.cassandra.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/metrics/ConnectionMetrics.html" title="class in org.apache.cassandra.metrics"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/metrics/CompactionMetrics.html" target="_top">Frames</a></li> <li><a href="CompactionMetrics.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All 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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.cassandra.metrics</div> <h2 title="Class CompactionMetrics" class="title">Class CompactionMetrics</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.metrics.CompactionMetrics</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">CompactionMetrics</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a></pre> <div class="block">Metrics for compaction.</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="overviewSummary" 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>com.yammer.metrics.core.Counter</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#bytesCompacted">bytesCompacted</a></strong></code> <div class="block">Total number of bytes compacted since server [re]start</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>com.yammer.metrics.core.Gauge&lt;java.lang.Long&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#completedTasks">completedTasks</a></strong></code> <div class="block">Number of completed compactions since server [re]start</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/metrics/MetricNameFactory.html" title="interface in org.apache.cassandra.metrics">MetricNameFactory</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#factory">factory</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>com.yammer.metrics.core.Gauge&lt;java.lang.Integer&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#pendingTasks">pendingTasks</a></strong></code> <div class="block">Estimated number of compactions remaining to perform</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>com.yammer.metrics.core.Meter</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#totalCompactionsCompleted">totalCompactionsCompleted</a></strong></code> <div class="block">Total number of compactions since server [re]start</div> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#CompactionMetrics(java.util.concurrent.ThreadPoolExecutor...)">CompactionMetrics</a></strong>(java.util.concurrent.ThreadPoolExecutor...&nbsp;collectors)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#beginCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)">beginCompaction</a></strong>(<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&nbsp;ci)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#finishCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)">finishCompaction</a></strong>(<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&nbsp;ci)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.List&lt;<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/metrics/CompactionMetrics.html#getCompactions()">getCompactions</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </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="factory"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>factory</h4> <pre>public static final&nbsp;<a href="../../../../org/apache/cassandra/metrics/MetricNameFactory.html" title="interface in org.apache.cassandra.metrics">MetricNameFactory</a> factory</pre> </li> </ul> <a name="pendingTasks"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>pendingTasks</h4> <pre>public final&nbsp;com.yammer.metrics.core.Gauge&lt;java.lang.Integer&gt; pendingTasks</pre> <div class="block">Estimated number of compactions remaining to perform</div> </li> </ul> <a name="completedTasks"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>completedTasks</h4> <pre>public final&nbsp;com.yammer.metrics.core.Gauge&lt;java.lang.Long&gt; completedTasks</pre> <div class="block">Number of completed compactions since server [re]start</div> </li> </ul> <a name="totalCompactionsCompleted"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>totalCompactionsCompleted</h4> <pre>public final&nbsp;com.yammer.metrics.core.Meter totalCompactionsCompleted</pre> <div class="block">Total number of compactions since server [re]start</div> </li> </ul> <a name="bytesCompacted"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>bytesCompacted</h4> <pre>public final&nbsp;com.yammer.metrics.core.Counter bytesCompacted</pre> <div class="block">Total number of bytes compacted since server [re]start</div> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="CompactionMetrics(java.util.concurrent.ThreadPoolExecutor...)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompactionMetrics</h4> <pre>public&nbsp;CompactionMetrics(java.util.concurrent.ThreadPoolExecutor...&nbsp;collectors)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="beginCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>beginCompaction</h4> <pre>public&nbsp;void&nbsp;beginCompaction(<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&nbsp;ci)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html#beginCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)">beginCompaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a></code></dd> </dl> </li> </ul> <a name="finishCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>finishCompaction</h4> <pre>public&nbsp;void&nbsp;finishCompaction(<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&nbsp;ci)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html#finishCompaction(org.apache.cassandra.db.compaction.CompactionInfo.Holder)">finishCompaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a></code></dd> </dl> </li> </ul> <a name="getCompactions()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getCompactions</h4> <pre>public static&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a>&gt;&nbsp;getCompactions()</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/CompactionMetrics.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><a href="../../../../org/apache/cassandra/metrics/CommitLogMetrics.html" title="class in org.apache.cassandra.metrics"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/metrics/ConnectionMetrics.html" title="class in org.apache.cassandra.metrics"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/metrics/CompactionMetrics.html" target="_top">Frames</a></li> <li><a href="CompactionMetrics.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All 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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>