blob: e839cafdcb2e724e03f31b1e878a5585e3240071 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:15:50 PDT 2017 -->
<title>MetricReportReporter (gobblin-metrics-base 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetricReportReporter (gobblin-metrics-base 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/metrics/reporter/MetricReportReporter.html" target="_top">Frames</a></li>
<li><a href="MetricReportReporter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.metrics.reporter.ConfiguredScheduledReporter">Field</a>&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">gobblin.metrics.reporter</div>
<h2 title="Class MetricReportReporter" class="title">Class MetricReportReporter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter">gobblin.metrics.reporter.ContextAwareReporter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html" title="class in gobblin.metrics.reporter">gobblin.metrics.reporter.ScheduledReporter</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html" title="class in gobblin.metrics.reporter">gobblin.metrics.reporter.ConfiguredScheduledReporter</a></li>
<li>
<ul class="inheritance">
<li>gobblin.metrics.reporter.MetricReportReporter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.codahale.metrics.Reporter, <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">MetricReportReporter</span>
extends <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html" title="class in gobblin.metrics.reporter">ConfiguredScheduledReporter</a></pre>
<div class="block">Scheduled reporter based on <a href="../../../gobblin/metrics/MetricReport.html" title="class in gobblin.metrics"><code>MetricReport</code></a>.
<p>
This class will generate a metric report, and call <a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#emitReport-gobblin.metrics.MetricReport-"><code>emitReport(gobblin.metrics.MetricReport)</code></a> to actually emit the metrics.
</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="memberSummary" 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 class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="class in gobblin.metrics.reporter">MetricReportReporter.Builder</a>&lt;<a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="type parameter in MetricReportReporter.Builder">T</a> extends <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.Builder.html" title="class in gobblin.metrics.reporter">ConfiguredScheduledReporter.Builder</a>&lt;<a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="type parameter in MetricReportReporter.Builder">T</a>&gt;&gt;</span></code>
<div class="block">Builder for <a href="../../../gobblin/metrics/reporter/MetricReportReporter.html" title="class in gobblin.metrics.reporter"><code>MetricReportReporter</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.metrics.reporter.ConfiguredScheduledReporter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html" title="class in gobblin.metrics.reporter">ConfiguredScheduledReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#closer">closer</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#JOINER">JOINER</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#metricContextName">metricContextName</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#tags">tags</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.metrics.reporter.ScheduledReporter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ScheduledReporter.html" title="class in gobblin.metrics.reporter">ScheduledReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#DEFAULT_REPORTING_INTERVAL_PERIOD">DEFAULT_REPORTING_INTERVAL_PERIOD</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#PERIOD_FORMATTER">PERIOD_FORMATTER</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#REPORTING_INTERVAL">REPORTING_INTERVAL</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.metrics.reporter.ContextAwareReporter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter">ContextAwareReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#config">config</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#name">name</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#MetricReportReporter-gobblin.metrics.reporter.MetricReportReporter.Builder-com.typesafe.config.Config-">MetricReportReporter</a></span>(<a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="class in gobblin.metrics.reporter">MetricReportReporter.Builder</a>&lt;?&gt;&nbsp;builder,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;config)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#emitReport-gobblin.metrics.MetricReport-">emitReport</a></span>(<a href="../../../gobblin/metrics/MetricReport.html" title="class in gobblin.metrics">MetricReport</a>&nbsp;report)</code>
<div class="block">Emit the <a href="../../../gobblin/metrics/MetricReport.html" title="class in gobblin.metrics"><code>MetricReport</code></a> to the metrics sink.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.Map-">report</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Gauge&gt;&nbsp;gauges,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Counter&gt;&nbsp;counters,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Histogram&gt;&nbsp;histograms,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Meter&gt;&nbsp;meters,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Timer&gt;&nbsp;timers,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;tags)</code>
<div class="block">Serializes metrics and pushes the byte arrays to Kafka.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeCounter-java.lang.String-com.codahale.metrics.Counting-">serializeCounter</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Counting&nbsp;counter)</code>
<div class="block">Extracts metrics from <code>Counter</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeGauge-java.lang.String-com.codahale.metrics.Gauge-">serializeGauge</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Gauge&nbsp;gauge)</code>
<div class="block">Extracts metrics from <code>Gauge</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeMetered-java.lang.String-com.codahale.metrics.Metered-">serializeMetered</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Metered&nbsp;meter)</code>
<div class="block">Extracts metrics from <code>Metered</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeSingleValue-java.lang.String-java.lang.Number-java.lang.String...-">serializeSingleValue</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;path)</code>
<div class="block">Convert single value into list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeSnapshot-java.lang.String-com.codahale.metrics.Snapshot-">serializeSnapshot</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Snapshot&nbsp;snapshot)</code>
<div class="block">Extracts metrics from <code>Snapshot</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/MetricReportReporter.html#serializeValue-java.lang.String-java.lang.Number-java.lang.String...-">serializeValue</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;path)</code>
<div class="block">Converts a single key-value pair into a metric.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.metrics.reporter.ConfiguredScheduledReporter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html" title="class in gobblin.metrics.reporter">ConfiguredScheduledReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#close--">close</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#convertDuration-double-">convertDuration</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#convertRate-double-">convertRate</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#getMetricNamePrefix-java.util.Map-">getMetricNamePrefix</a>, <a href="../../../gobblin/metrics/reporter/ConfiguredScheduledReporter.html#report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.Map-boolean-">report</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.metrics.reporter.ScheduledReporter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ScheduledReporter.html" title="class in gobblin.metrics.reporter">ScheduledReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#removedMetricContext-gobblin.metrics.InnerMetricContext-">removedMetricContext</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report--">report</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report-boolean-">report</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report-gobblin.metrics.context.ReportableContext-">report</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report-gobblin.metrics.context.ReportableContext-boolean-">report</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#setReportingInterval-com.typesafe.config.Config-long-java.util.concurrent.TimeUnit-">setReportingInterval</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#setReportingInterval-java.util.Properties-long-java.util.concurrent.TimeUnit-">setReportingInterval</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#startImpl--">startImpl</a>, <a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#stopImpl--">stopImpl</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.metrics.reporter.ContextAwareReporter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.metrics.reporter.<a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html" title="class in gobblin.metrics.reporter">ContextAwareReporter</a></h3>
<code><a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#getMetricContextsToReport--">getMetricContextsToReport</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#isStarted--">isStarted</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#newMetricContext-gobblin.metrics.MetricContext-">newMetricContext</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#shouldReportInnerMetricContext-gobblin.metrics.InnerMetricContext-">shouldReportInnerMetricContext</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#start--">start</a>, <a href="../../../gobblin/metrics/reporter/ContextAwareReporter.html#stop--">stop</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="MetricReportReporter-gobblin.metrics.reporter.MetricReportReporter.Builder-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MetricReportReporter</h4>
<pre>public&nbsp;MetricReportReporter(<a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="class in gobblin.metrics.reporter">MetricReportReporter.Builder</a>&lt;?&gt;&nbsp;builder,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&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="report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>report</h4>
<pre>protected&nbsp;void&nbsp;report(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Gauge&gt;&nbsp;gauges,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Counter&gt;&nbsp;counters,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Histogram&gt;&nbsp;histograms,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Meter&gt;&nbsp;meters,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,com.codahale.metrics.Timer&gt;&nbsp;timers,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;tags)</pre>
<div class="block">Serializes metrics and pushes the byte arrays to Kafka. Uses the serialize* methods in <a href="../../../gobblin/metrics/reporter/MetricReportReporter.html" title="class in gobblin.metrics.reporter"><code>MetricReportReporter</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.Map-">report</a></code>&nbsp;in class&nbsp;<code><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html" title="class in gobblin.metrics.reporter">ScheduledReporter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>gauges</code> - map of <code>Gauge</code> to report and their name.</dd>
<dd><code>counters</code> - map of <code>Counter</code> to report and their name.</dd>
<dd><code>histograms</code> - map of <code>Histogram</code> to report and their name.</dd>
<dd><code>meters</code> - map of <code>Meter</code> to report and their name.</dd>
<dd><code>timers</code> - map of <code>Timer</code> to report and their name.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../gobblin/metrics/reporter/ScheduledReporter.html#report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.Map-"><code>ScheduledReporter.report(SortedMap, SortedMap, SortedMap, SortedMap, SortedMap, Map)</code></a></dd>
</dl>
</li>
</ul>
<a name="emitReport-gobblin.metrics.MetricReport-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitReport</h4>
<pre>protected abstract&nbsp;void&nbsp;emitReport(<a href="../../../gobblin/metrics/MetricReport.html" title="class in gobblin.metrics">MetricReport</a>&nbsp;report)</pre>
<div class="block">Emit the <a href="../../../gobblin/metrics/MetricReport.html" title="class in gobblin.metrics"><code>MetricReport</code></a> to the metrics sink.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>report</code> - metric report to emit.</dd>
</dl>
</li>
</ul>
<a name="serializeGauge-java.lang.String-com.codahale.metrics.Gauge-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeGauge</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;&nbsp;serializeGauge(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Gauge&nbsp;gauge)</pre>
<div class="block">Extracts metrics from <code>Gauge</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the <code>Gauge</code>.</dd>
<dd><code>gauge</code> - instance of <code>Gauge</code> to serialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serializeCounter-java.lang.String-com.codahale.metrics.Counting-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeCounter</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;&nbsp;serializeCounter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Counting&nbsp;counter)</pre>
<div class="block">Extracts metrics from <code>Counter</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the <code>Counter</code>.</dd>
<dd><code>counter</code> - instance of <code>Counter</code> to serialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serializeMetered-java.lang.String-com.codahale.metrics.Metered-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMetered</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;&nbsp;serializeMetered(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Metered&nbsp;meter)</pre>
<div class="block">Extracts metrics from <code>Metered</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the <code>Metered</code>.</dd>
<dd><code>meter</code> - instance of <code>Metered</code> to serialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serializeSnapshot-java.lang.String-com.codahale.metrics.Snapshot-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeSnapshot</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;&nbsp;serializeSnapshot(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
com.codahale.metrics.Snapshot&nbsp;snapshot)</pre>
<div class="block">Extracts metrics from <code>Snapshot</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the <code>Snapshot</code>.</dd>
<dd><code>snapshot</code> - instance of <code>Snapshot</code> to serialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serializeSingleValue-java.lang.String-java.lang.Number-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeSingleValue</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&gt;&nbsp;serializeSingleValue(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;path)</pre>
<div class="block">Convert single value into list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the metric.</dd>
<dd><code>value</code> - value of the metric.</dd>
<dd><code>path</code> - suffixes to more precisely identify the meaning of the reported value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Singleton list of <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serializeValue-java.lang.String-java.lang.Number-java.lang.String...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>serializeValue</h4>
<pre>protected&nbsp;<a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics">Metric</a>&nbsp;serializeValue(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;path)</pre>
<div class="block">Converts a single key-value pair into a metric.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the metric</dd>
<dd><code>value</code> - value of the metric to report</dd>
<dd><code>path</code> - additional suffixes to further identify the meaning of the reported value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../gobblin/metrics/Metric.html" title="class in gobblin.metrics"><code>Metric</code></a>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/MetricReportReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/metrics/reporter/MetricReportReporter.html" target="_top">Frames</a></li>
<li><a href="MetricReportReporter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.metrics.reporter.ConfiguredScheduledReporter">Field</a>&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>