blob: 3226156d51379135345e60612242c268db6ef0cc [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>EventReporter (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="EventReporter (gobblin-metrics-base 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6};
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/ContextAwareScheduledReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/EventReporter.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/EventReporter.html" target="_top">Frames</a></li>
<li><a href="EventReporter.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="#field.summary">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><a href="#field.detail">Field</a>&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 EventReporter" class="title">Class EventReporter</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>com.codahale.metrics.ScheduledReporter</li>
<li>
<ul class="inheritance">
<li>gobblin.metrics.reporter.EventReporter</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../gobblin/metrics/reporter/OutputStreamEventReporter.html" title="class in gobblin.metrics.reporter">OutputStreamEventReporter</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">EventReporter</span>
extends com.codahale.metrics.ScheduledReporter
implements <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></pre>
<div class="block">Abstract class for reporting <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>s at a fixed schedule.
<p>
Subclasses should implement <a href="../../../gobblin/metrics/reporter/EventReporter.html#reportEventQueue-java.util.Queue-"><code>reportEventQueue(java.util.Queue&lt;gobblin.metrics.GobblinTrackingEvent&gt;)</code></a> to emit the events to the sink. Events will only be
reported once, and then removed from the event queue.
</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/EventReporter.Builder.html" title="class in gobblin.metrics.reporter">EventReporter.Builder</a>&lt;<a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="type parameter in EventReporter.Builder">T</a> extends <a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="class in gobblin.metrics.reporter">EventReporter.Builder</a>&lt;<a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="type parameter in EventReporter.Builder">T</a>&gt;&gt;</span></code>
<div class="block">Builder for <a href="../../../gobblin/metrics/reporter/EventReporter.html" title="class in gobblin.metrics.reporter"><code>EventReporter</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/io/Closer.html?is-external=true" title="class or interface in com.google.common.io">Closer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#closer">closer</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#EVENTS_QUALIFIER">EVENTS_QUALIFIER</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Joiner.html?is-external=true" title="class or interface in com.google.common.base">Joiner</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#JOINER">JOINER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#METRIC_KEY_PREFIX">METRIC_KEY_PREFIX</a></span></code>&nbsp;</td>
</tr>
</table>
</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/EventReporter.html#EventReporter-gobblin.metrics.reporter.EventReporter.Builder-">EventReporter</a></span>(<a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="class in gobblin.metrics.reporter">EventReporter.Builder</a>&nbsp;builder)</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#addEventToReportingQueue-gobblin.metrics.GobblinTrackingEvent-">addEventToReportingQueue</a></span>(<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics">GobblinTrackingEvent</a>&nbsp;event)</code>
<div class="block">Add <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a> to the events queue.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#getMetricName-java.util.Map-java.lang.String-">getMetricName</a></span>(<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/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;metadata,
<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;eventName)</code>
<div class="block">Constructs the metric key to be emitted.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#notificationCallback-gobblin.metrics.notification.Notification-">notificationCallback</a></span>(<a href="../../../gobblin/metrics/notification/Notification.html" title="interface in gobblin.metrics.notification">Notification</a>&nbsp;notification)</code>
<div class="block">Callback used by the <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> to notify the object of a new
<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#report--">report</a></span>()</code>
<div class="block">Report all <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>s in the queue.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-">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)</code>
<div class="block">NOOP because <code>ScheduledReporter</code> requires this method implemented.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/metrics/reporter/EventReporter.html#reportEventQueue-java.util.Queue-">reportEventQueue</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics">GobblinTrackingEvent</a>&gt;&nbsp;queue)</code>
<div class="block">Emit all <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a> in queue.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.codahale.metrics.ScheduledReporter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.codahale.metrics.ScheduledReporter</h3>
<code>convertDuration, convertRate, getDurationUnit, getRateUnit, start, stop</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JOINER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOINER</h4>
<pre>protected static final&nbsp;<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Joiner.html?is-external=true" title="class or interface in com.google.common.base">Joiner</a> JOINER</pre>
</li>
</ul>
<a name="METRIC_KEY_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>METRIC_KEY_PREFIX</h4>
<pre>protected static final&nbsp;<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> METRIC_KEY_PREFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#gobblin.metrics.reporter.EventReporter.METRIC_KEY_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EVENTS_QUALIFIER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EVENTS_QUALIFIER</h4>
<pre>protected static final&nbsp;<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> EVENTS_QUALIFIER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#gobblin.metrics.reporter.EventReporter.EVENTS_QUALIFIER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="closer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>closer</h4>
<pre>protected final&nbsp;<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/io/Closer.html?is-external=true" title="class or interface in com.google.common.io">Closer</a> closer</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EventReporter-gobblin.metrics.reporter.EventReporter.Builder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EventReporter</h4>
<pre>public&nbsp;EventReporter(<a href="../../../gobblin/metrics/reporter/EventReporter.Builder.html" title="class in gobblin.metrics.reporter">EventReporter.Builder</a>&nbsp;builder)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="notificationCallback-gobblin.metrics.notification.Notification-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notificationCallback</h4>
<pre>public&nbsp;void&nbsp;notificationCallback(<a href="../../../gobblin/metrics/notification/Notification.html" title="interface in gobblin.metrics.notification">Notification</a>&nbsp;notification)</pre>
<div class="block">Callback used by the <a href="../../../gobblin/metrics/MetricContext.html" title="class in gobblin.metrics"><code>MetricContext</code></a> to notify the object of a new
<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>notification</code> - <a href="../../../gobblin/metrics/notification/Notification.html" title="interface in gobblin.metrics.notification"><code>Notification</code></a> to process.</dd>
</dl>
</li>
</ul>
<a name="addEventToReportingQueue-gobblin.metrics.GobblinTrackingEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEventToReportingQueue</h4>
<pre>public&nbsp;void&nbsp;addEventToReportingQueue(<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics">GobblinTrackingEvent</a>&nbsp;event)</pre>
<div class="block">Add <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a> to the events queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a> to add to queue.</dd>
</dl>
</li>
</ul>
<a name="report--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>report</h4>
<pre>public&nbsp;void&nbsp;report()</pre>
<div class="block">Report all <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>s in the queue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>report</code>&nbsp;in class&nbsp;<code>com.codahale.metrics.ScheduledReporter</code></dd>
</dl>
</li>
</ul>
<a name="reportEventQueue-java.util.Queue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reportEventQueue</h4>
<pre>public abstract&nbsp;void&nbsp;reportEventQueue(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics">GobblinTrackingEvent</a>&gt;&nbsp;queue)</pre>
<div class="block">Emit all <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a> in queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queue</code> - <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> containing <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a>s that should be emitted.</dd>
</dl>
</li>
</ul>
<a name="report-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-java.util.SortedMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>report</h4>
<pre>public final&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)</pre>
<div class="block">NOOP because <code>ScheduledReporter</code> requires this method implemented.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>report</code>&nbsp;in class&nbsp;<code>com.codahale.metrics.ScheduledReporter</code></dd>
</dl>
</li>
</ul>
<a name="getMetricName-java.util.Map-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricName</h4>
<pre>protected&nbsp;<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;getMetricName(<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/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;metadata,
<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;eventName)</pre>
<div class="block">Constructs the metric key to be emitted.
The actual event name is enriched with the current job and task id to be able to keep track of its origin</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metadata</code> - metadata of the actual <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a></dd>
<dd><code>eventName</code> - name of the actual <a href="../../../gobblin/metrics/GobblinTrackingEvent.html" title="class in gobblin.metrics"><code>GobblinTrackingEvent</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>prefix of the metric key</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><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></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><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></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>com.codahale.metrics.ScheduledReporter</code></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/ContextAwareScheduledReporter.Builder.html" title="class in gobblin.metrics.reporter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/metrics/reporter/EventReporter.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/EventReporter.html" target="_top">Frames</a></li>
<li><a href="EventReporter.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="#field.summary">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><a href="#field.detail">Field</a>&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>