blob: 6121c23dc3a9d1324d3085ab60efecf6f6536c08 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.calcite.avatica.metrics.MetricsSystemConfiguration (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="Uses of Interface org.apache.calcite.avatica.metrics.MetricsSystemConfiguration (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><a href="../package-summary.html">Package</a></li>
<li><a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">Class</a></li>
<li class="navBarCell1Rev">Use</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">
<h2 title="Uses of Interface org.apache.calcite.avatica.metrics.MetricsSystemConfiguration" class="title">Uses of Interface<br>org.apache.calcite.avatica.metrics.MetricsSystemConfiguration</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.avatica.metrics">org.apache.calcite.avatica.metrics</a></th>
<td class="colLast">
<div class="block">Metrics for the Avatica framework.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.avatica.metrics.dropwizard">org.apache.calcite.avatica.metrics.dropwizard</a></th>
<td class="colLast">
<div class="block">Dropwizard-Metrics (v3) implementation of the Avatica Metrics framework.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.avatica.metrics.noop">org.apache.calcite.avatica.metrics.noop</a></th>
<td class="colLast">
<div class="block">No-operation implementation for the Avatica Metrics framework.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.avatica.server">org.apache.calcite.avatica.server</a></th>
<td class="colLast">
<div class="block">Avatica server that listens for HTTP requests.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.calcite.avatica.metrics">
<!-- -->
</a>
<h3>Uses of <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a> in <a href="../package-summary.html">org.apache.calcite.avatica.metrics</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.calcite.avatica.metrics</a> with parameters of type <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">MetricsSystemFactory.</span><code><span class="memberNameLink"><a href="../MetricsSystemFactory.html#create(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">create</a></span>&#8203;(<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Creates an instance of a <a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystem</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">MetricsSystemLoader.</span><code><span class="memberNameLink"><a href="../MetricsSystemLoader.html#load(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">load</a></span>&#8203;(<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Creates a <a href="../MetricsSystem.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystem</code></a> instance using the corresponding <a href="../MetricsSystemFactory.html" title="interface in org.apache.calcite.avatica.metrics"><code>MetricsSystemFactory</code></a>
available to <code>ServiceLoader</code> on the classpath.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.calcite.avatica.metrics.dropwizard">
<!-- -->
</a>
<h3>Uses of <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a> in <a href="../dropwizard/package-summary.html">org.apache.calcite.avatica.metrics.dropwizard</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../dropwizard/package-summary.html">org.apache.calcite.avatica.metrics.dropwizard</a> that implement <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../dropwizard/DropwizardMetricsSystemConfiguration.html" title="class in org.apache.calcite.avatica.metrics.dropwizard">DropwizardMetricsSystemConfiguration</a></span></code></th>
<td class="colLast">
<div class="block">A container which provides a <code>MetricRegistry</code> to a <a href="../dropwizard/DropwizardMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.dropwizard"><code>DropwizardMetricsSystem</code></a>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../dropwizard/package-summary.html">org.apache.calcite.avatica.metrics.dropwizard</a> with parameters of type <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../dropwizard/DropwizardMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.dropwizard">DropwizardMetricsSystem</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">DropwizardMetricsSystemFactory.</span><code><span class="memberNameLink"><a href="../dropwizard/DropwizardMetricsSystemFactory.html#create(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">create</a></span>&#8203;(<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.calcite.avatica.metrics.noop">
<!-- -->
</a>
<h3>Uses of <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a> in <a href="../noop/package-summary.html">org.apache.calcite.avatica.metrics.noop</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../noop/package-summary.html">org.apache.calcite.avatica.metrics.noop</a> that implement <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../noop/NoopMetricsSystemConfiguration.html" title="class in org.apache.calcite.avatica.metrics.noop">NoopMetricsSystemConfiguration</a></span></code></th>
<td class="colLast">
<div class="block">An empty configuration for the <a href="../noop/NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop"><code>NoopMetricsSystem</code></a>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../noop/package-summary.html">org.apache.calcite.avatica.metrics.noop</a> with parameters of type <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../noop/NoopMetricsSystem.html" title="class in org.apache.calcite.avatica.metrics.noop">NoopMetricsSystem</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">NoopMetricsSystemFactory.</span><code><span class="memberNameLink"><a href="../noop/NoopMetricsSystemFactory.html#create(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">create</a></span>&#8203;(<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.calcite.avatica.server">
<!-- -->
</a>
<h3>Uses of <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a> in <a href="../../server/package-summary.html">org.apache.calcite.avatica.server</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../../server/package-summary.html">org.apache.calcite.avatica.server</a> with parameters of type <a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../server/AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../../server/HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization,org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization,
<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;metricsConfig)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method with metrics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../server/AvaticaHandler.html" title="interface in org.apache.calcite.avatica.server">AvaticaHandler</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandlerFactory.</span><code><span class="memberNameLink"><a href="../../server/HandlerFactory.html#getHandler(org.apache.calcite.avatica.remote.Service,org.apache.calcite.avatica.remote.Driver.Serialization,org.apache.calcite.avatica.metrics.MetricsSystemConfiguration,org.apache.calcite.avatica.server.AvaticaServerConfiguration)">getHandler</a></span>&#8203;(<a href="../../remote/Service.html" title="interface in org.apache.calcite.avatica.remote">Service</a>&nbsp;service,
<a href="../../remote/Driver.Serialization.html" title="enum in org.apache.calcite.avatica.remote">Driver.Serialization</a>&nbsp;serialization,
<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;metricsConfig,
<a href="../../server/AvaticaServerConfiguration.html" title="interface in org.apache.calcite.avatica.server">AvaticaServerConfiguration</a>&nbsp;serverConfig)</code></th>
<td class="colLast">
<div class="block">Constructs the desired implementation for the given serialization method and server
configuration with metrics.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../server/HttpServer.Builder.html" title="class in org.apache.calcite.avatica.server">HttpServer.Builder</a>&lt;<a href="../../server/HttpServer.Builder.html" title="type parameter in HttpServer.Builder">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HttpServer.Builder.</span><code><span class="memberNameLink"><a href="../../server/HttpServer.Builder.html#withMetricsConfiguration(org.apache.calcite.avatica.metrics.MetricsSystemConfiguration)">withMetricsConfiguration</a></span>&#8203;(<a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">MetricsSystemConfiguration</a>&lt;?&gt;&nbsp;metricsConfig)</code></th>
<td class="colLast">
<div class="block">Sets the given configuration to enable metrics collection in the server.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../MetricsSystemConfiguration.html" title="interface in org.apache.calcite.avatica.metrics">Class</a></li>
<li class="navBarCell1Rev">Use</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>