blob: 7d16448a718cec5bd565e8390b440b965555d496 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>org.apache.heron.api.metric (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/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="../../../../../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.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.heron.api.metric (Heron Java 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-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.heron.api.metric</h1>
</div>
<div class="contentContainer">
<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="ICombiner.html" title="interface in org.apache.heron.api.metric">ICombiner</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Interface for classes that are able to combine multiple objects into one result.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IMetric.html" title="interface in org.apache.heron.api.metric">IMetric</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Interface for a metric that can be tracked</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IMetricsRegister.html" title="interface in org.apache.heron.api.metric">IMetricsRegister</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IReducer.html" title="interface in org.apache.heron.api.metric">IReducer</a>&lt;T,&#8203;U,&#8203;V&gt;</th>
<td class="colLast">
<div class="block">Apply an update to an accumulator for which a result can be extracted.</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="AssignableMetric.html" title="class in org.apache.heron.api.metric">AssignableMetric</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CombinedMetric.html" title="class in org.apache.heron.api.metric">CombinedMetric</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ConcurrentCountMetric.html" title="class in org.apache.heron.api.metric">ConcurrentCountMetric</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CountMetric.html" title="class in org.apache.heron.api.metric">CountMetric</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CountStatAndMetric.html" title="class in org.apache.heron.api.metric">CountStatAndMetric</a></th>
<td class="colLast">
<div class="block">Acts as a Count Metric, but also keeps track of approximate counts
for the last 10 mins, 3 hours, 1 day, and all time.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CountStatAndMetricTest.html" title="class in org.apache.heron.api.metric">CountStatAndMetricTest</a></th>
<td class="colLast">
<div class="block">Unit test for CountStatAndMetric</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CumulativeCountMetric.html" title="class in org.apache.heron.api.metric">CumulativeCountMetric</a></th>
<td class="colLast">
<div class="block">This is a different kind of counter that value is not
reset after fetched.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatencyStatAndMetric.html" title="class in org.apache.heron.api.metric">LatencyStatAndMetric</a></th>
<td class="colLast">
<div class="block">Acts as a Latency Metric, but also keeps track of approximate latency
for the last 10 mins, 3 hours, 1 day, and all time.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatencyStatAndMetricTest.html" title="class in org.apache.heron.api.metric">LatencyStatAndMetricTest</a></th>
<td class="colLast">
<div class="block">Unit test for LatencyStatAndMetric</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MeanReducer.html" title="class in org.apache.heron.api.metric">MeanReducer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MeanReducerState.html" title="class in org.apache.heron.api.metric">MeanReducerState</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultiAssignableMetric.html" title="class in org.apache.heron.api.metric">MultiAssignableMetric</a>&lt;T extends java.lang.Number&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MultiCountMetric.html" title="class in org.apache.heron.api.metric">MultiCountMetric</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultiReducedMetric.html" title="class in org.apache.heron.api.metric">MultiReducedMetric</a>&lt;T,&#8203;U,&#8203;V&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ReducedMetric.html" title="class in org.apache.heron.api.metric">ReducedMetric</a>&lt;T,&#8203;U,&#8203;V&gt;</th>
<td class="colLast">
<div class="block">Apply an update to an metric using an IReducer for which a result can be extracted.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GlobalMetrics.html" title="enum in org.apache.heron.api.metric">GlobalMetrics</a></th>
<td class="colLast">
<div class="block">Singleton class which exposes a simple globally available counter for heron jobs.</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-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>
</footer>
</body>
</html>