| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.kafka.common.metrics.stats (kafka 3.6.1 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.kafka.common.metrics.stats"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.kafka.common.metrics.stats" class="title">Package org.apache.kafka.common.metrics.stats</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.kafka.common.metrics.stats</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides methods of statistically aggregating metrics upon emission.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.kafka.common.metrics</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides the API used by Kafka clients to emit metrics which are then exposed using the * <a href="../MetricsReporter.html" title="interface in org.apache.kafka.common.metrics"><code>MetricsReporter</code></a> interface.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Avg.html" title="class in org.apache.kafka.common.metrics.stats">Avg</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats"><code>SampledStat</code></a> that maintains a simple average over its samples.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CumulativeCount.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeCount</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A non-sampled version of <a href="WindowedCount.html" title="class in org.apache.kafka.common.metrics.stats"><code>WindowedCount</code></a> maintained over all time.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CumulativeSum.html" title="class in org.apache.kafka.common.metrics.stats">CumulativeSum</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An non-sampled cumulative total maintained over all time.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Frequencies.html" title="class in org.apache.kafka.common.metrics.stats">Frequencies</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="../CompoundStat.html" title="interface in org.apache.kafka.common.metrics"><code>CompoundStat</code></a> that represents a normalized distribution with a <a href="Frequency.html" title="class in org.apache.kafka.common.metrics.stats"><code>Frequency</code></a> metric for each |
| bucketed value.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Frequency.html" title="class in org.apache.kafka.common.metrics.stats">Frequency</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Definition of a frequency metric used in a <a href="Frequencies.html" title="class in org.apache.kafka.common.metrics.stats"><code>Frequencies</code></a> compound statistic.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Histogram.html" title="class in org.apache.kafka.common.metrics.stats">Histogram</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Histogram.BinScheme.html" title="interface in org.apache.kafka.common.metrics.stats">Histogram.BinScheme</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">An algorithm for determining the bin in which a value is to be placed as well as calculating the upper end |
| of each bin.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Histogram.ConstantBinScheme.html" title="class in org.apache.kafka.common.metrics.stats">Histogram.ConstantBinScheme</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A scheme for calculating the bins where the width of each bin is a constant determined by the range of values |
| and the number of bins.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Histogram.LinearBinScheme.html" title="class in org.apache.kafka.common.metrics.stats">Histogram.LinearBinScheme</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A scheme for calculating the bins where the width of each bin is one more than the previous bin, and therefore |
| the bin widths are increasing at a linear rate.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Max.html" title="class in org.apache.kafka.common.metrics.stats">Max</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats"><code>SampledStat</code></a> that gives the max over its samples.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Meter.html" title="class in org.apache.kafka.common.metrics.stats">Meter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A compound stat that includes a rate metric and a cumulative total metric.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Min.html" title="class in org.apache.kafka.common.metrics.stats">Min</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats"><code>SampledStat</code></a> that gives the min over its samples.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Percentile.html" title="class in org.apache.kafka.common.metrics.stats">Percentile</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Percentiles.html" title="class in org.apache.kafka.common.metrics.stats">Percentiles</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A compound stat that reports one or more percentiles</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="Percentiles.BucketSizing.html" title="enum class in org.apache.kafka.common.metrics.stats">Percentiles.BucketSizing</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Rate.html" title="class in org.apache.kafka.common.metrics.stats">Rate</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The rate of the given quantity.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats">SampledStat</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A SampledStat records a single scalar value measured over one or more samples.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SampledStat.Sample.html" title="class in org.apache.kafka.common.metrics.stats">SampledStat.Sample</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SimpleRate.html" title="class in org.apache.kafka.common.metrics.stats">SimpleRate</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A simple rate the rate is incrementally calculated |
| based on the elapsed time between the earliest reading |
| and now.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TokenBucket.html" title="class in org.apache.kafka.common.metrics.stats">TokenBucket</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The <a href="TokenBucket.html" title="class in org.apache.kafka.common.metrics.stats"><code>TokenBucket</code></a> is a <a href="../MeasurableStat.html" title="interface in org.apache.kafka.common.metrics"><code>MeasurableStat</code></a> implementing a token bucket algorithm |
| that is usable within a <a href="../Sensor.html" title="class in org.apache.kafka.common.metrics"><code>Sensor</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Value.html" title="class in org.apache.kafka.common.metrics.stats">Value</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An instantaneous value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WindowedCount.html" title="class in org.apache.kafka.common.metrics.stats">WindowedCount</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats"><code>SampledStat</code></a> that maintains a simple count of what it has seen.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="WindowedSum.html" title="class in org.apache.kafka.common.metrics.stats">WindowedSum</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="SampledStat.html" title="class in org.apache.kafka.common.metrics.stats"><code>SampledStat</code></a> that maintains the sum of what it has seen.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
