Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsAccessor.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsAccessor.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsAccessor.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsAccessor.html Tue Aug 23 17:38:58 2016 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsAccessor (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsAccessor (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsAccessor (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":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"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsAccessor.html" target="_top">Frames</a></li> -<li><a href="MetricsAccessor.html" target="_top">No Frames</a></li> +<li><a href="MetricsAccessor.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">MetricsAccessor</span></pre> +<pre>public interface <span class="typeNameLabel">MetricsAccessor</span></pre> <div class="block">A MetricsAccessor allows users to retrieve metric values, based on group name and metric name, though specific metrics system, such as JMX.</div> </li> @@ -98,33 +111,33 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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"> </span></caption> +<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Long></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getCounterValues(java.lang.String,%20java.lang.String)">getCounterValues</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getCounterValues-java.lang.String-java.lang.String-">getCounterValues</a></span>(java.lang.String group, java.lang.String counter)</code> <div class="block">Get the values of a counter</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><T> java.util.Map<java.lang.String,T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getGaugeValues(java.lang.String,%20java.lang.String)">getGaugeValues</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getGaugeValues-java.lang.String-java.lang.String-">getGaugeValues</a></span>(java.lang.String group, java.lang.String gauge)</code> <div class="block">Get the values of a gauge</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Double></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getTimerValues(java.lang.String,%20java.lang.String)">getTimerValues</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html#getTimerValues-java.lang.String-java.lang.String-">getTimerValues</a></span>(java.lang.String group, java.lang.String timer)</code> <div class="block">Get the values of a timer</div> </td> @@ -140,47 +153,64 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getCounterValues(java.lang.String, java.lang.String)"> +<a name="getCounterValues-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCounterValues</h4> <pre>java.util.Map<java.lang.String,java.lang.Long> getCounterValues(java.lang.String group, - java.lang.String counter)</pre> + java.lang.String counter)</pre> <div class="block">Get the values of a counter</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for the counter, e.g. org.apache.samza.container.SamzaContainerMetrics</dd><dd><code>counter</code> - Name of the counter, e.g. commit-calls</dd> -<dt><span class="strong">Returns:</span></dt><dd>A map of counter values, keyed by type, e.g. {"samza-container-0": 100L}</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for the counter, e.g. org.apache.samza.container.SamzaContainerMetrics</dd> +<dd><code>counter</code> - Name of the counter, e.g. commit-calls</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map of counter values, keyed by type, e.g. {"samza-container-0": 100L}</dd> +</dl> </li> </ul> -<a name="getGaugeValues(java.lang.String, java.lang.String)"> +<a name="getGaugeValues-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGaugeValues</h4> <pre><T> java.util.Map<java.lang.String,T> getGaugeValues(java.lang.String group, - java.lang.String gauge)</pre> + java.lang.String gauge)</pre> <div class="block">Get the values of a gauge</div> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type of the gauge value, e.g. Double</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for the gauge, e.g. org.apache.samza.container.SamzaContainerMetrics</dd><dd><code>gauge</code> - Name of the gauge, e.g. event-loop-utilization</dd> -<dt><span class="strong">Returns:</span></dt><dd>A map of gauge values, keyed by type, e.g. {"samza-container-0": 0.8}</dd></dl> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type of the gauge value, e.g. Double</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for the gauge, e.g. org.apache.samza.container.SamzaContainerMetrics</dd> +<dd><code>gauge</code> - Name of the gauge, e.g. event-loop-utilization</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map of gauge values, keyed by type, e.g. {"samza-container-0": 0.8}</dd> +</dl> </li> </ul> -<a name="getTimerValues(java.lang.String, java.lang.String)"> +<a name="getTimerValues-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getTimerValues</h4> <pre>java.util.Map<java.lang.String,java.lang.Double> getTimerValues(java.lang.String group, - java.lang.String timer)</pre> + java.lang.String timer)</pre> <div class="block">Get the values of a timer</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for the timer, e.g. org.apache.samza.container.SamzaContainerMetrics</dd><dd><code>timer</code> - Name of the timer, e.g. choose-ns</dd> -<dt><span class="strong">Returns:</span></dt><dd>A map of timer values, keyed by type, e.g. {"samza-container-0": 10.5}</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for the timer, e.g. org.apache.samza.container.SamzaContainerMetrics</dd> +<dd><code>timer</code> - Name of the timer, e.g. choose-ns</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map of timer values, keyed by type, e.g. {"samza-container-0": 10.5}</dd> +</dl> </li> </ul> </li> @@ -191,9 +221,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -208,15 +240,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsAccessor.html" target="_top">Frames</a></li> -<li><a href="MetricsAccessor.html" target="_top">No Frames</a></li> +<li><a href="MetricsAccessor.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -236,16 +268,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsRegistry.html Tue Aug 23 17:38:58 2016 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsRegistry (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsRegistry (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsRegistry (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="MetricsRegistry.html" target="_top">No Frames</a></li> +<li><a href="MetricsRegistry.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -95,7 +108,7 @@ </dl> <hr> <br> -<pre>public interface <span class="strong">MetricsRegistry</span></pre> +<pre>public interface <span class="typeNameLabel">MetricsRegistry</span></pre> <div class="block">A MetricsRegistry allows its users to create new <a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><code>Metric</code></a>s and have those metrics wired to specific metrics systems, such as JMX, provided by <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a>s. Those implementing Samza jobs use the MetricsRegistry to register metrics, which then handle @@ -111,55 +124,55 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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"> </span></caption> +<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-org.apache.samza.metrics.Counter-">newCounter</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter-java.lang.String-java.lang.String-">newCounter</a></span>(java.lang.String group, java.lang.String name)</code> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-org.apache.samza.metrics.Gauge-">newGauge</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</code> <div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> </td> </tr> -<tr class="rowColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge-java.lang.String-java.lang.String-T-">newGauge</a></span>(java.lang.String group, java.lang.String name, T value)</code> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> </td> </tr> -<tr class="altColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20java.lang.String)">newTimer</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-java.lang.String-">newTimer</a></span>(java.lang.String group, java.lang.String name)</code> <div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> </td> </tr> -<tr class="rowColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer(java.lang.String,%20org.apache.samza.metrics.Timer)">newTimer</a></strong>(java.lang.String group, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newTimer-java.lang.String-org.apache.samza.metrics.Timer-">newTimer</a></span>(java.lang.String group, <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</code> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> </td> @@ -175,89 +188,124 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="newCounter(java.lang.String, java.lang.String)"> +<a name="newCounter-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newCounter</h4> <pre><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - java.lang.String name)</pre> + java.lang.String name)</pre> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Counter</dd> +<dd><code>name</code> - Name of to-be-created Counter</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New Counter instance</dd> +</dl> </li> </ul> -<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)"> +<a name="newCounter-java.lang.String-org.apache.samza.metrics.Counter-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newCounter</h4> <pre><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre> + <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Counter</dd> +<dd><code>counter</code> - Existing Counter to register</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Counter that was registered</dd> +</dl> </li> </ul> -<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)"> +<a name="newGauge-java.lang.String-java.lang.String-java.lang.Object-"> <!-- --> -</a><a name="newGauge(java.lang.String, java.lang.String, T)"> +</a><a name="newGauge-java.lang.String-java.lang.String-T-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newGauge</h4> <pre><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - java.lang.String name, - T value)</pre> + java.lang.String name, + T value)</pre> <div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type the Gauge will be wrapping</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Gauge</dd> +<dd><code>name</code> - Name of to-be-created Gauge</dd> +<dd><code>value</code> - Initial value for the Gauge</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Gauge was created and registered</dd> +</dl> </li> </ul> -<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)"> +<a name="newGauge-java.lang.String-org.apache.samza.metrics.Gauge-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newGauge</h4> <pre><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</pre> + <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> value)</pre> <div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div> -<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd> -<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type the Gauge will be wrapping</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Gauge</dd> +<dd><code>value</code> - Initial value for the Gauge</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Gauge was registered</dd> +</dl> </li> </ul> -<a name="newTimer(java.lang.String, java.lang.String)"> +<a name="newTimer-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>newTimer</h4> <pre><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - java.lang.String name)</pre> + java.lang.String name)</pre> <div class="block">Create and Register a new <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>name</code> - Name of to-be-created Timer</dd> -<dt><span class="strong">Returns:</span></dt><dd>New Timer instance</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Timer</dd> +<dd><code>name</code> - Name of to-be-created Timer</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>New Timer instance</dd> +</dl> </li> </ul> -<a name="newTimer(java.lang.String, org.apache.samza.metrics.Timer)"> +<a name="newTimer-java.lang.String-org.apache.samza.metrics.Timer-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>newTimer</h4> <pre><a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> newTimer(java.lang.String group, - <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</pre> + <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a> timer)</pre> <div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics"><code>Timer</code></a> with this registry</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Timer</dd><dd><code>timer</code> - Existing Timer to register</dd> -<dt><span class="strong">Returns:</span></dt><dd>Timer that was registered</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>group</code> - Group for this Timer</dd> +<dd><code>timer</code> - Existing Timer to register</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Timer that was registered</dd> +</dl> </li> </ul> </li> @@ -268,9 +316,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -285,15 +335,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsRegistry.html" target="_top">Frames</a></li> -<li><a href="MetricsRegistry.html" target="_top">No Frames</a></li> +<li><a href="MetricsRegistry.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -313,16 +363,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporter.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporter.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporter.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporter.html Tue Aug 23 17:38:58 2016 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsReporter (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsReporter (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsReporter (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":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"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsReporter.html" target="_top">Frames</a></li> -<li><a href="MetricsReporter.html" target="_top">No Frames</a></li> +<li><a href="MetricsReporter.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">MetricsReporter</span></pre> +<pre>public interface <span class="typeNameLabel">MetricsReporter</span></pre> <div class="block">A MetricsReporter is the interface that different metrics sinks, such as JMX, implement to receive metrics from the Samza framework and Samza jobs.</div> </li> @@ -98,28 +111,28 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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"> </span></caption> +<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#register(java.lang.String,%20org.apache.samza.metrics.ReadableMetricsRegistry)">register</a></strong>(java.lang.String source, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#register-java.lang.String-org.apache.samza.metrics.ReadableMetricsRegistry-">register</a></span>(java.lang.String source, <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a> registry)</code> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#start()">start</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#start--">start</a></span>()</code> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#stop()">stop</a></strong>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsReporter.html#stop--">stop</a></span>()</code> </td> </tr> </table> </li> @@ -132,11 +145,11 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="start()"> +<a name="start--"> <!-- --> </a> <ul class="blockList"> @@ -145,17 +158,17 @@ <pre>void start()</pre> </li> </ul> -<a name="register(java.lang.String, org.apache.samza.metrics.ReadableMetricsRegistry)"> +<a name="register-java.lang.String-org.apache.samza.metrics.ReadableMetricsRegistry-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>register</h4> <pre>void register(java.lang.String source, - <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a> registry)</pre> + <a href="../../../../org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics">ReadableMetricsRegistry</a> registry)</pre> </li> </ul> -<a name="stop()"> +<a name="stop--"> <!-- --> </a> <ul class="blockListLast"> @@ -172,9 +185,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -189,15 +204,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsReporter.html" target="_top">Frames</a></li> -<li><a href="MetricsReporter.html" target="_top">No Frames</a></li> +<li><a href="MetricsReporter.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -217,16 +232,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsReporterFactory.html Tue Aug 23 17:38:58 2016 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsReporterFactory (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsReporterFactory (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsReporterFactory (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":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"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsReporterFactory.html" target="_top">Frames</a></li> -<li><a href="MetricsReporterFactory.html" target="_top">No Frames</a></li> +<li><a href="MetricsReporterFactory.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">MetricsReporterFactory</span></pre> +<pre>public interface <span class="typeNameLabel">MetricsReporterFactory</span></pre> <div class="block">Build a <a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><code>MetricsReporter</code></a></div> </li> </ul> @@ -97,19 +110,19 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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"> </span></caption> +<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html#getMetricsReporter(java.lang.String,%20java.lang.String,%20org.apache.samza.config.Config)">getMetricsReporter</a></strong>(java.lang.String name, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html#getMetricsReporter-java.lang.String-java.lang.String-org.apache.samza.config.Config-">getMetricsReporter</a></span>(java.lang.String name, java.lang.String containerName, <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> </tr> @@ -124,19 +137,19 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="getMetricsReporter(java.lang.String, java.lang.String, org.apache.samza.config.Config)"> +<a name="getMetricsReporter-java.lang.String-java.lang.String-org.apache.samza.config.Config-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getMetricsReporter</h4> <pre><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics">MetricsReporter</a> getMetricsReporter(java.lang.String name, - java.lang.String containerName, - <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> + java.lang.String containerName, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> </li> </ul> </li> @@ -147,9 +160,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -164,15 +179,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsReporterFactory.html" target="_top">Frames</a></li> -<li><a href="MetricsReporterFactory.html" target="_top">No Frames</a></li> +<li><a href="MetricsReporterFactory.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -192,16 +207,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidationFailureException.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidationFailureException.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidationFailureException.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidationFailureException.html Tue Aug 23 17:38:58 2016 @@ -2,15 +2,20 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsValidationFailureException (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsValidationFailureException (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsValidationFailureException (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> </script> @@ -18,9 +23,11 @@ <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +42,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsValidationFailureException.html" target="_top">Frames</a></li> -<li><a href="MetricsValidationFailureException.html" target="_top">No Frames</a></li> +<li><a href="MetricsValidationFailureException.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -62,17 +69,17 @@ <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> <li>Method</li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -109,10 +116,13 @@ </dl> <hr> <br> -<pre>public class <span class="strong">MetricsValidationFailureException</span> +<pre>public class <span class="typeNameLabel">MetricsValidationFailureException</span> extends java.lang.Exception</pre> <div class="block">Thrown when the metrics validation fails. See <a href="../../../../org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics"><code>MetricsValidator</code></a>.</div> -<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.samza.metrics.MetricsValidationFailureException">Serialized Form</a></dd></dl> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.samza.metrics.MetricsValidationFailureException">Serialized Form</a></dd> +</dl> </li> </ul> </div> @@ -121,20 +131,20 @@ extends java.lang.Exception</pre> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> +<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"> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html#MetricsValidationFailureException(java.lang.String)">MetricsValidationFailureException</a></strong>(java.lang.String message)</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html#MetricsValidationFailureException-java.lang.String-">MetricsValidationFailureException</a></span>(java.lang.String message)</code> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html#MetricsValidationFailureException(java.lang.String,%20java.lang.Throwable)">MetricsValidationFailureException</a></strong>(java.lang.String message, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html#MetricsValidationFailureException-java.lang.String-java.lang.Throwable-">MetricsValidationFailureException</a></span>(java.lang.String message, java.lang.Throwable cause)</code> </td> </tr> </table> @@ -142,19 +152,19 @@ extends java.lang.Exception</pre> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> <!-- --> </a> <h3>Methods inherited from class java.lang.Throwable</h3> <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> </ul> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> @@ -170,11 +180,11 @@ extends java.lang.Exception</pre> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> +<li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="MetricsValidationFailureException(java.lang.String)"> +<a name="MetricsValidationFailureException-java.lang.String-"> <!-- --> </a> <ul class="blockList"> @@ -183,14 +193,14 @@ extends java.lang.Exception</pre> <pre>public MetricsValidationFailureException(java.lang.String message)</pre> </li> </ul> -<a name="MetricsValidationFailureException(java.lang.String, java.lang.Throwable)"> +<a name="MetricsValidationFailureException-java.lang.String-java.lang.Throwable-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>MetricsValidationFailureException</h4> <pre>public MetricsValidationFailureException(java.lang.String message, - java.lang.Throwable cause)</pre> + java.lang.Throwable cause)</pre> </li> </ul> </li> @@ -201,9 +211,11 @@ extends java.lang.Exception</pre> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -218,15 +230,15 @@ extends java.lang.Exception</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidator.html" title="interface in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsValidationFailureException.html" target="_top">Frames</a></li> -<li><a href="MetricsValidationFailureException.html" target="_top">No Frames</a></li> +<li><a href="MetricsValidationFailureException.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -245,17 +257,17 @@ extends java.lang.Exception</pre> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> <li>Method</li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> Modified: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidator.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidator.html?rev=1757411&r1=1757410&r2=1757411&view=diff ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidator.html (original) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/metrics/MetricsValidator.html Tue Aug 23 17:38:58 2016 @@ -2,25 +2,38 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_67) on Tue Aug 09 11:12:11 PDT 2016 --> +<!-- Generated by javadoc (1.8.0_102) on Mon Aug 22 23:51:42 PDT 2016 --> <title>MetricsValidator (samza-api 0.10.1-SNAPSHOT API)</title> -<meta name="date" content="2016-08-09"> +<meta name="date" content="2016-08-22"> <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"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MetricsValidator (samza-api 0.10.1-SNAPSHOT API)"; + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MetricsValidator (samza-api 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { } //--> +var methods = {"i0":6,"i1":6,"i2":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"> +<div class="topNav"><a name="navbar.top"> <!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +</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"> @@ -35,15 +48,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsValidator.html" target="_top">Frames</a></li> -<li><a href="MetricsValidator.html" target="_top">No Frames</a></li> +<li><a href="MetricsValidator.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -63,16 +76,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_top"> +<a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -87,7 +100,7 @@ <li class="blockList"> <hr> <br> -<pre>public interface <span class="strong">MetricsValidator</span></pre> +<pre>public interface <span class="typeNameLabel">MetricsValidator</span></pre> <div class="block">A MetricsValidator reads the job's metrics values by using the <a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics"><code>MetricsAccessor</code></a>, and validate them.</div> </li> @@ -98,31 +111,31 @@ <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method_summary"> +<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"> </span></caption> +<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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></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"> +<tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#complete()">complete</a></strong>()</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#complete--">complete</a></span>()</code> <div class="block">Complete validation.</div> </td> </tr> -<tr class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#init(org.apache.samza.config.Config)">init</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#init-org.apache.samza.config.Config-">init</a></span>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> <div class="block">Initialize with config.</div> </td> </tr> -<tr class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#validate(org.apache.samza.metrics.MetricsAccessor)">validate</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics">MetricsAccessor</a> accessor)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/metrics/MetricsValidator.html#validate-org.apache.samza.metrics.MetricsAccessor-">validate</a></span>(<a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics">MetricsAccessor</a> accessor)</code> <div class="block">Validate the metrics values of a job</div> </td> </tr> @@ -137,11 +150,11 @@ <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method_detail"> +<li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="init(org.apache.samza.config.Config)"> +<a name="init-org.apache.samza.config.Config-"> <!-- --> </a> <ul class="blockList"> @@ -149,34 +162,42 @@ <h4>init</h4> <pre>void init(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> <div class="block">Initialize with config.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Job config</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>config</code> - Job config</dd> +</dl> </li> </ul> -<a name="validate(org.apache.samza.metrics.MetricsAccessor)"> +<a name="validate-org.apache.samza.metrics.MetricsAccessor-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>validate</h4> <pre>void validate(<a href="../../../../org/apache/samza/metrics/MetricsAccessor.html" title="interface in org.apache.samza.metrics">MetricsAccessor</a> accessor) - throws <a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></pre> + throws <a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></pre> <div class="block">Validate the metrics values of a job</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>accessor</code> - Accessor to get the metrics values through specific metrics system, e.g. JMX.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></code> - Exception when the validation fails.</dd></dl> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>accessor</code> - Accessor to get the metrics values through specific metrics system, e.g. JMX.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></code> - Exception when the validation fails.</dd> +</dl> </li> </ul> -<a name="complete()"> +<a name="complete--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>complete</h4> <pre>void complete() - throws <a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></pre> + throws <a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></pre> <div class="block">Complete validation. Final checks can be performed here.</div> -<dl><dt><span class="strong">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></code> - Exception when the validation fails.</dd></dl> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics">MetricsValidationFailureException</a></code> - Exception when the validation fails.</dd> +</dl> </li> </ul> </li> @@ -187,9 +208,11 @@ </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> +<div class="bottomNav"><a name="navbar.bottom"> <!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +</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"> @@ -204,15 +227,15 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsValidationFailureException.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/samza/metrics/MetricsValidator.html" target="_top">Frames</a></li> -<li><a href="MetricsValidator.html" target="_top">No Frames</a></li> +<li><a href="MetricsValidator.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -232,16 +255,16 @@ <li>Nested | </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_summary">Method</a></li> +<li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> -<li><a href="#method_detail">Method</a></li> +<li><a href="#method.detail">Method</a></li> </ul> </div> -<a name="skip-navbar_bottom"> +<a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
