blob: 4a952fdb5811d94d14669277702c4ac64e41a7db [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 (version 1.7.0_67) on Thu Feb 04 13:28:43 CST 2016 -->
<title>ProcessorAggregator</title>
<meta name="date" content="2016-02-04">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProcessorAggregator";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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>Prev Class</li>
<li><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.Aggregator.html" title="interface in io.gearpump.streaming.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?io/gearpump/streaming/metrics/ProcessorAggregator.html" target="_top">Frames</a></li>
<li><a href="ProcessorAggregator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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">io.gearpump.streaming.metrics</div>
<h2 title="Class ProcessorAggregator" class="title">Class ProcessorAggregator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>io.gearpump.streaming.metrics.ProcessorAggregator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>io.gearpump.metrics.MetricsAggregator</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ProcessorAggregator</span>
extends java.lang.Object
implements io.gearpump.metrics.MetricsAggregator</pre>
<div class="block"><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html" title="class in io.gearpump.streaming.metrics"><code>ProcessorAggregator</code></a> does aggregation after grouping by these three attributes:
1. processorId
2. time section(represented as a index integer)
3. metricName(like sendThroughput)
<p>
It assumes for each <code>HistoryMetricsItem</code>, the name follow the format
app[appId].processor[processorId].task[taskId].[metricName]
<p>
It parses the name to get processorId and metricName. If the parsing fails, then current
<code>HistoryMetricsItem</code> will be skipped.
<p>
This class is optimized for performance.
<p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.Aggregator.html" title="interface in io.gearpump.streaming.metrics">ProcessorAggregator.Aggregator</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.AggregatorFactory.html" title="class in io.gearpump.streaming.metrics">ProcessorAggregator.AggregatorFactory</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.HistogramAggregator.html" title="class in io.gearpump.streaming.metrics">ProcessorAggregator.HistogramAggregator</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.MeterAggregator.html" title="class in io.gearpump.streaming.metrics">ProcessorAggregator.MeterAggregator</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.MultiLayerMap.html" title="class in io.gearpump.streaming.metrics">ProcessorAggregator.MultiLayerMap</a>&lt;<a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.MultiLayerMap.html" title="type parameter in ProcessorAggregator.MultiLayerMap">Value</a>&gt;</strong></code>
<div class="block">MultiLayerMap has multiple layers.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html#ProcessorAggregator(com.typesafe.config.Config)">ProcessorAggregator</a></strong>(com.typesafe.config.Config&nbsp;config)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html#ProcessorAggregator(io.gearpump.util.HistoryMetricsService.HistoryMetricsConfig)">ProcessorAggregator</a></strong>(io.gearpump.util.HistoryMetricsService.HistoryMetricsConfig&nbsp;historyMetricConfig)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.collection.immutable.List&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html#aggregate(scala.collection.immutable.Map,%20scala.collection.Iterator)">aggregate</a></strong>(scala.collection.immutable.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;options,
scala.collection.Iterator&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;inputs)</code>
<div class="block">Accept options:
key: "readOption", value: one of "readLatest", "readRecent", "readHistory"</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.collection.immutable.List&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html#aggregate(java.lang.String,%20scala.collection.Iterator,%20long)">aggregate</a></strong>(java.lang.String&nbsp;readOption,
scala.collection.Iterator&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;inputs,
long&nbsp;now)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.html#readOption()">readOption</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProcessorAggregator(io.gearpump.util.HistoryMetricsService.HistoryMetricsConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcessorAggregator</h4>
<pre>public&nbsp;ProcessorAggregator(io.gearpump.util.HistoryMetricsService.HistoryMetricsConfig&nbsp;historyMetricConfig)</pre>
</li>
</ul>
<a name="ProcessorAggregator(com.typesafe.config.Config)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProcessorAggregator</h4>
<pre>public&nbsp;ProcessorAggregator(com.typesafe.config.Config&nbsp;config)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="readOption()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readOption</h4>
<pre>public static&nbsp;java.lang.String&nbsp;readOption()</pre>
</li>
</ul>
<a name="aggregate(scala.collection.immutable.Map, scala.collection.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregate</h4>
<pre>public&nbsp;scala.collection.immutable.List&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;aggregate(scala.collection.immutable.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;options,
scala.collection.Iterator&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;inputs)</pre>
<div class="block">Accept options:
key: "readOption", value: one of "readLatest", "readRecent", "readHistory"
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>aggregate</code>&nbsp;in interface&nbsp;<code>io.gearpump.metrics.MetricsAggregator</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - (undocumented)</dd><dd><code>inputs</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="aggregate(java.lang.String, scala.collection.Iterator, long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>aggregate</h4>
<pre>public&nbsp;scala.collection.immutable.List&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;aggregate(java.lang.String&nbsp;readOption,
scala.collection.Iterator&lt;io.gearpump.cluster.MasterToClient.HistoryMetricsItem&gt;&nbsp;inputs,
long&nbsp;now)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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>Prev Class</li>
<li><a href="../../../../io/gearpump/streaming/metrics/ProcessorAggregator.Aggregator.html" title="interface in io.gearpump.streaming.metrics"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?io/gearpump/streaming/metrics/ProcessorAggregator.html" target="_top">Frames</a></li>
<li><a href="ProcessorAggregator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>