blob: 9235d04439599f50f0970fac9f1fb6c0268371cd [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 (1.8.0_261) on Mon Dec 20 14:15:50 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MetricExporterSpi (Ignite 2.11.1)</title>
<meta name="date" content="2021-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetricExporterSpi (Ignite 2.11.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/MetricExporterSpi.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/ignite/spi/metric/Metric.html" title="interface in org.apache.ignite.spi.metric"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/ignite/spi/metric/ObjectMetric.html" title="interface in org.apache.ignite.spi.metric"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/spi/metric/MetricExporterSpi.html" target="_top">Frames</a></li>
<li><a href="MetricExporterSpi.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.ignite.spi.metric</div>
<h2 title="Interface MetricExporterSpi" class="title">Interface MetricExporterSpi</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/ignite/spi/metric/jmx/JmxMetricExporterSpi.html" title="class in org.apache.ignite.spi.metric.jmx">JmxMetricExporterSpi</a>, <a href="../../../../../org/apache/ignite/spi/metric/log/LogExporterSpi.html" title="class in org.apache.ignite.spi.metric.log">LogExporterSpi</a>, <a href="../../../../../org/apache/ignite/spi/metric/noop/NoopMetricExporterSpi.html" title="class in org.apache.ignite.spi.metric.noop">NoopMetricExporterSpi</a>, <a href="../../../../../org/apache/ignite/spi/metric/opencensus/OpenCensusMetricExporterSpi.html" title="class in org.apache.ignite.spi.metric.opencensus">OpenCensusMetricExporterSpi</a>, org.apache.ignite.internal.processors.metric.PushMetricsExporterAdapter</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MetricExporterSpi</span>
extends <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></pre>
<div class="block">Exporter of metric information to the external recipient.
Expected, that each implementation would support some specific protocol.
Implementation of this Spi should work by pull paradigm.
So after start SPI should respond to some incoming request.
HTTP servlet or JMX bean are good examples of expected implementations.
<p>
Ignite provides the following <code>MetricExporterSpi</code> implementation:
<ul>
<li><a href="../../../../../org/apache/ignite/spi/metric/jmx/JmxMetricExporterSpi.html" title="class in org.apache.ignite.spi.metric.jmx"><code>JmxMetricExporterSpi</code></a></li>
<li><a href="../../../../../org/apache/ignite/spi/metric/log/LogExporterSpi.html" title="class in org.apache.ignite.spi.metric.log"><code>LogExporterSpi</code></a></li>
<li><code>org.apache.ignite.internal.processors.metric.sql.SqlViewMetricExporterSpi</code></li>
<li><code>org.apache.ignite.spi.metric.opencensus.OpenCensusMetricExporterSpi</code></li>
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricManager.html" title="interface in org.apache.ignite.spi.metric"><code>ReadOnlyMetricManager</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricRegistry.html" title="interface in org.apache.ignite.spi.metric"><code>ReadOnlyMetricRegistry</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/Metric.html" title="interface in org.apache.ignite.spi.metric"><code>Metric</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/BooleanMetric.html" title="interface in org.apache.ignite.spi.metric"><code>BooleanMetric</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/DoubleMetric.html" title="interface in org.apache.ignite.spi.metric"><code>DoubleMetric</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/IntMetric.html" title="interface in org.apache.ignite.spi.metric"><code>IntMetric</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/LongMetric.html" title="interface in org.apache.ignite.spi.metric"><code>LongMetric</code></a>,
<a href="../../../../../org/apache/ignite/spi/metric/ObjectMetric.html" title="interface in org.apache.ignite.spi.metric"><code>ObjectMetric</code></a></dd>
</dl>
</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/metric/MetricExporterSpi.html#setExportFilter-java.util.function.Predicate-">setExportFilter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricRegistry.html" title="interface in org.apache.ignite.spi.metric">ReadOnlyMetricRegistry</a><span class='angle_bracket'>&gt;</span>&nbsp;filter)</code>
<div class="block">Sets export filter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/metric/MetricExporterSpi.html#setMetricRegistry-org.apache.ignite.spi.metric.ReadOnlyMetricManager-">setMetricRegistry</a></span>(<a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricManager.html" title="interface in org.apache.ignite.spi.metric">ReadOnlyMetricManager</a>&nbsp;registry)</code>
<div class="block">Sets metrics registry that SPI should export.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.spi.IgniteSpi">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.spi.<a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></h3>
<code><a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#getName--">getName</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#getNodeAttributes--">getNodeAttributes</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onClientDisconnected-org.apache.ignite.lang.IgniteFuture-">onClientDisconnected</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onClientReconnected-boolean-">onClientReconnected</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onContextDestroyed--">onContextDestroyed</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onContextInitialized-org.apache.ignite.spi.IgniteSpiContext-">onContextInitialized</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#spiStart-java.lang.String-">spiStart</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#spiStop--">spiStop</a></code></li>
</ul>
</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="setMetricRegistry-org.apache.ignite.spi.metric.ReadOnlyMetricManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricRegistry</h4>
<pre>void&nbsp;setMetricRegistry(<a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricManager.html" title="interface in org.apache.ignite.spi.metric">ReadOnlyMetricManager</a>&nbsp;registry)</pre>
<div class="block">Sets metrics registry that SPI should export.
This method called before <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#spiStart-java.lang.String-"><code>IgniteSpi.spiStart(String)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>registry</code> - Metric registry.</dd>
</dl>
</li>
</ul>
<a name="setExportFilter-java.util.function.Predicate-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setExportFilter</h4>
<pre>void&nbsp;setExportFilter(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/spi/metric/ReadOnlyMetricRegistry.html" title="interface in org.apache.ignite.spi.metric">ReadOnlyMetricRegistry</a><span class='angle_bracket'>&gt;</span>&nbsp;filter)</pre>
<div class="block">Sets export filter.
Metric registry that not satisfy <code>filter</code> shouldn't be exported.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - Filter.</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/MetricExporterSpi.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/ignite/spi/metric/Metric.html" title="interface in org.apache.ignite.spi.metric"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/ignite/spi/metric/ObjectMetric.html" title="interface in org.apache.ignite.spi.metric"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/spi/metric/MetricExporterSpi.html" target="_top">Frames</a></li>
<li><a href="MetricExporterSpi.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><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>