blob: 40e3043d44091774ffff6fdc9221a8caf5ff2de9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.avatica.metrics (Apache Calcite Avatica API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.avatica.metrics (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.avatica.metrics</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Metrics for the Avatica framework.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Counter.html" title="interface in org.apache.calcite.avatica.metrics">Counter</a></th>
<td class="colLast">
<div class="block">A mutable number.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Gauge.html" title="interface in org.apache.calcite.avatica.metrics">Gauge</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A metrics which measures a discrete value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Histogram.html" title="interface in org.apache.calcite.avatica.metrics">Histogram</a></th>
<td class="colLast">
<div class="block">A metric which measures the distribution of values.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Meter.html" title="interface in org.apache.calcite.avatica.metrics">Meter</a></th>
<td class="colLast">
<div class="block">A metric which measure the rate at which some operation is invoked.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Metric.html" title="interface in org.apache.calcite.avatica.metrics">Metric</a></th>
<td class="colLast">
<div class="block">Parent interface for all metrics.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></th>
<td class="colLast">
<div class="block">General purpose factory for creating various metrics.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A container used by a <a href="MetricsSystemFactory.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystemFactory</code></a> to create a <a href="MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetricsSystemFactory.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemFactory</a></th>
<td class="colLast">
<div class="block">A factory class for creating instances of <a href="MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Timer.html" title="interface in org.apache.calcite.avatica.metrics">Timer</a></th>
<td class="colLast">
<div class="block">A metric which encompasses a <a href="Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a> and <a href="Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Timer.Context.html" title="interface in org.apache.calcite.avatica.metrics">Timer.Context</a></th>
<td class="colLast">
<div class="block">A object that tracks an active timing state.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetricsSystemLoader.html" title="class in org.apache.calcite.avatica.metrics">MetricsSystemLoader</a></th>
<td class="colLast">
<div class="block">A utility encapsulating use of <code>ServiceLoader</code> to instantiate a <a href="MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PackageMarker.html" title="annotation in org.apache.calcite.avatica.metrics">PackageMarker</a></th>
<td class="colLast">
<div class="block">This is a dummy annotation that forces javac to produce output for
otherwise empty package-info.java.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>