blob: 35b5aace8e96ec443b53c467f73a44c097616778 [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 -->
<title>org.apache.iceberg.metrics</title>
<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="org.apache.iceberg.metrics";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/iceberg/mapping/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/iceberg/mr/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/metrics/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.iceberg.metrics</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/CommitMetricsResult.html" title="interface in org.apache.iceberg.metrics">CommitMetricsResult</a></td>
<td class="colLast">
<div class="block">A serializable version of <a href="../../../../org/apache/iceberg/metrics/CommitMetrics.html" title="class in org.apache.iceberg.metrics"><code>CommitMetrics</code></a> that carries its results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/CommitReport.html" title="interface in org.apache.iceberg.metrics">CommitReport</a></td>
<td class="colLast">
<div class="block">A commit report that contains all relevant information from a Snapshot.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/Counter.html" title="interface in org.apache.iceberg.metrics">Counter</a></td>
<td class="colLast">
<div class="block">Generalized Counter interface for creating telemetry-related instances when counting events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/CounterResult.html" title="interface in org.apache.iceberg.metrics">CounterResult</a></td>
<td class="colLast">
<div class="block">A serializable version of a <a href="../../../../org/apache/iceberg/metrics/Counter.html" title="interface in org.apache.iceberg.metrics"><code>Counter</code></a> that carries its result.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/Histogram.html" title="interface in org.apache.iceberg.metrics">Histogram</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/Histogram.Statistics.html" title="interface in org.apache.iceberg.metrics">Histogram.Statistics</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a></td>
<td class="colLast">
<div class="block">Generalized interface for creating telemetry related instances for tracking operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/MetricsContext.Counter.html" title="interface in org.apache.iceberg.metrics">MetricsContext.Counter</a>&lt;T extends java.lang.Number&gt;</td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">will be removed in 2.0.0, use <a href="../../../../org/apache/iceberg/metrics/Counter.html" title="interface in org.apache.iceberg.metrics"><code>Counter</code></a> instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/MetricsReport.html" title="interface in org.apache.iceberg.metrics">MetricsReport</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics">MetricsReporter</a></td>
<td class="colLast">
<div class="block">This interface defines the basic API for reporting metrics for operations to a Table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/ScanMetricsResult.html" title="interface in org.apache.iceberg.metrics">ScanMetricsResult</a></td>
<td class="colLast">
<div class="block">A serializable version of <a href="../../../../org/apache/iceberg/metrics/ScanMetrics.html" title="class in org.apache.iceberg.metrics"><code>ScanMetrics</code></a> that carries its results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/ScanReport.html" title="interface in org.apache.iceberg.metrics">ScanReport</a></td>
<td class="colLast">
<div class="block">A Table Scan report that contains all relevant information from a Table Scan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/Timer.html" title="interface in org.apache.iceberg.metrics">Timer</a></td>
<td class="colLast">
<div class="block">Generalized Timer interface for creating telemetry related instances for measuring duration of
operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/Timer.Timed.html" title="interface in org.apache.iceberg.metrics">Timer.Timed</a></td>
<td class="colLast">
<div class="block">A timing sample that carries internal state about the Timer's start position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/TimerResult.html" title="interface in org.apache.iceberg.metrics">TimerResult</a></td>
<td class="colLast">
<div class="block">A serializable version of a <a href="../../../../org/apache/iceberg/metrics/Timer.html" title="interface in org.apache.iceberg.metrics"><code>Timer</code></a> that carries its result.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/CommitMetrics.html" title="class in org.apache.iceberg.metrics">CommitMetrics</a></td>
<td class="colLast">
<div class="block">Carries all metrics for a particular commit</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/CommitReportParser.html" title="class in org.apache.iceberg.metrics">CommitReportParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/DefaultCounter.html" title="class in org.apache.iceberg.metrics">DefaultCounter</a></td>
<td class="colLast">
<div class="block">A default <a href="../../../../org/apache/iceberg/metrics/Counter.html" title="interface in org.apache.iceberg.metrics"><code>Counter</code></a> implementation that uses an <code>AtomicLong</code> to count events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/DefaultMetricsContext.html" title="class in org.apache.iceberg.metrics">DefaultMetricsContext</a></td>
<td class="colLast">
<div class="block">A default <a href="../../../../org/apache/iceberg/metrics/MetricsContext.html" title="interface in org.apache.iceberg.metrics"><code>MetricsContext</code></a> implementation that uses native Java counters/timers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/DefaultTimer.html" title="class in org.apache.iceberg.metrics">DefaultTimer</a></td>
<td class="colLast">
<div class="block">A default <a href="../../../../org/apache/iceberg/metrics/Timer.html" title="interface in org.apache.iceberg.metrics"><code>Timer</code></a> implementation that uses a <code>Stopwatch</code> instance internally to
measure time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/FixedReservoirHistogram.html" title="class in org.apache.iceberg.metrics">FixedReservoirHistogram</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/iceberg/metrics/Histogram.html" title="interface in org.apache.iceberg.metrics"><code>Histogram</code></a> implementation with reservoir sampling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/LoggingMetricsReporter.html" title="class in org.apache.iceberg.metrics">LoggingMetricsReporter</a></td>
<td class="colLast">
<div class="block">A default <a href="../../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> implementation that logs the <a href="../../../../org/apache/iceberg/metrics/MetricsReport.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReport</code></a> to the log
file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/ScanMetrics.html" title="class in org.apache.iceberg.metrics">ScanMetrics</a></td>
<td class="colLast">
<div class="block">Carries all metrics for a particular scan</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/ScanReportParser.html" title="class in org.apache.iceberg.metrics">ScanReportParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/iceberg/metrics/MetricsContext.Unit.html" title="enum in org.apache.iceberg.metrics">MetricsContext.Unit</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/iceberg/mapping/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/iceberg/mr/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/metrics/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>