Google Git
Sign in
apache / calcite-site / 77e17bff6417d5bb4e3575811347366ded5fbdc5 / . / avatica / apidocs / org / apache / calcite / avatica / metrics / MetricsSystem.html
blob: 7086a87bc7b0549570cea566832220b3877ee943 [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MetricsSystem (Apache Calcite Avatica API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetricsSystem (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/MetricsSystem.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/calcite/avatica/metrics/Metric.html" title="interface in org.apache.calcite.avatica.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/metrics/MetricsSystem.html" target="_top">Frames</a></li>
<li><a href="MetricsSystem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.calcite.avatica.metrics</div>
<h2 title="Interface MetricsSystem" class="title">Interface MetricsSystem</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/calcite/avatica/metrics/dropwizard/DropwizardMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.dropwizard">DropwizardMetricsSystem</a>, <a href="../../../../../org/apache/calcite/avatica/metrics/noop/NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop">NoopMetricsSystem</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MetricsSystem</span></pre>
<div class="block">General purpose factory for creating various metrics. Modeled off of the Dropwizard Metrics API.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/metrics/Counter.html" title="interface in org.apache.calcite.avatica.metrics">Counter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html#getCounter-java.lang.String-">getCounter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a> used to track a mutable number.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics">Histogram</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html#getHistogram-java.lang.String-">getHistogram</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a> used to measure a distribution of values.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/metrics/Meter.html" title="interface in org.apache.calcite.avatica.metrics">Meter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html#getMeter-java.lang.String-">getMeter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a> used to measure durations and report distributions (a
combination of a <a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> and a <a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics">Timer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html#getTimer-java.lang.String-">getTimer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> used to measure durations and report rates.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html#register-java.lang.String-org.apache.calcite.avatica.metrics.Gauge-">register</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../../org/apache/calcite/avatica/metrics/Gauge.html" title="interface in org.apache.calcite.avatica.metrics">Gauge</a>&lt;T&gt;&nbsp;gauge)</code>
<div class="block">Register a <a href="../../../../../org/apache/calcite/avatica/metrics/Gauge.html" title="interface in org.apache.calcite.avatica.metrics"><code>Gauge</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTimer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimer</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics">Timer</a>&nbsp;getTimer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> used to measure durations and report rates.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Timer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getHistogram-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHistogram</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics">Histogram</a>&nbsp;getHistogram(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a> used to measure a distribution of values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Histogram.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getMeter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMeter</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/metrics/Meter.html" title="interface in org.apache.calcite.avatica.metrics">Meter</a>&nbsp;getMeter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a> used to measure durations and report distributions (a
combination of a <a href="../../../../../org/apache/calcite/avatica/metrics/Timer.html" title="interface in org.apache.calcite.avatica.metrics"><code>Timer</code></a> and a <a href="../../../../../org/apache/calcite/avatica/metrics/Histogram.html" title="interface in org.apache.calcite.avatica.metrics"><code>Histogram</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Meter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../../../../../org/apache/calcite/avatica/metrics/Meter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Meter</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getCounter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCounter</h4>
<pre><a href="../../../../../org/apache/calcite/avatica/metrics/Counter.html" title="interface in org.apache.calcite.avatica.metrics">Counter</a>&nbsp;getCounter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Get or construct a <a href="../../../../../org/apache/calcite/avatica/metrics/Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a> used to track a mutable number.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Counter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An instance of <a href="../../../../../org/apache/calcite/avatica/metrics/Counter.html" title="interface in org.apache.calcite.avatica.metrics"><code>Counter</code></a>.</dd>
</dl>
</li>
</ul>
<a name="register-java.lang.String-org.apache.calcite.avatica.metrics.Gauge-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>register</h4>
<pre>&lt;T&gt;&nbsp;void&nbsp;register(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../../org/apache/calcite/avatica/metrics/Gauge.html" title="interface in org.apache.calcite.avatica.metrics">Gauge</a>&lt;T&gt;&nbsp;gauge)</pre>
<div class="block">Register a <a href="../../../../../org/apache/calcite/avatica/metrics/Gauge.html" title="interface in org.apache.calcite.avatica.metrics"><code>Gauge</code></a>. The Gauge will be invoked at a period defined by the implementation
of <a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the Gauge.</dd>
<dd><code>gauge</code> - A callback to compute the current value.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/MetricsSystem.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/calcite/avatica/metrics/Metric.html" title="interface in org.apache.calcite.avatica.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/avatica/metrics/MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/avatica/metrics/MetricsSystem.html" target="_top">Frames</a></li>
<li><a href="MetricsSystem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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 &#169; 2012&#x2013;2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>