blob: 9e31c585f3ce772bb02eb5464181e9d1cc579432 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.iceberg.metrics</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.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) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<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">
<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">
<th class="colFirst" scope="row"><a href="CommitMetricsResult.html" title="interface in org.apache.iceberg.metrics">CommitMetricsResult</a></th>
<td class="colLast">
<div class="block">A serializable version of <a href="CommitMetrics.html" title="class in org.apache.iceberg.metrics"><code>CommitMetrics</code></a> that carries its results.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CommitReport.html" title="interface in org.apache.iceberg.metrics">CommitReport</a></th>
<td class="colLast">
<div class="block">A commit report that contains all relevant information from a Snapshot.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Counter.html" title="interface in org.apache.iceberg.metrics">Counter</a></th>
<td class="colLast">
<div class="block">Generalized Counter interface for creating telemetry-related instances when counting events.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CounterResult.html" title="interface in org.apache.iceberg.metrics">CounterResult</a></th>
<td class="colLast">
<div class="block">A serializable version of a <a href="Counter.html" title="interface in org.apache.iceberg.metrics"><code>Counter</code></a> that carries its result.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Histogram.html" title="interface in org.apache.iceberg.metrics">Histogram</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Histogram.Statistics.html" title="interface in org.apache.iceberg.metrics">Histogram.Statistics</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetricsContext.html" title="interface in org.apache.iceberg.metrics">MetricsContext</a></th>
<td class="colLast">
<div class="block">Generalized interface for creating telemetry related instances for tracking operations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetricsContext.Counter.html" title="interface in org.apache.iceberg.metrics">MetricsContext.Counter</a>&lt;T extends java.lang.Number&gt;</th>
<td class="colLast">Deprecated.
<div class="deprecationComment">will be removed in 2.0.0, use <a href="Counter.html" title="interface in org.apache.iceberg.metrics"><code>Counter</code></a> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetricsReport.html" title="interface in org.apache.iceberg.metrics">MetricsReport</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MetricsReporter.html" title="interface in org.apache.iceberg.metrics">MetricsReporter</a></th>
<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">
<th class="colFirst" scope="row"><a href="ScanMetricsResult.html" title="interface in org.apache.iceberg.metrics">ScanMetricsResult</a></th>
<td class="colLast">
<div class="block">A serializable version of <a href="ScanMetrics.html" title="class in org.apache.iceberg.metrics"><code>ScanMetrics</code></a> that carries its results.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScanReport.html" title="interface in org.apache.iceberg.metrics">ScanReport</a></th>
<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">
<th class="colFirst" scope="row"><a href="Timer.html" title="interface in org.apache.iceberg.metrics">Timer</a></th>
<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">
<th class="colFirst" scope="row"><a href="Timer.Timed.html" title="interface in org.apache.iceberg.metrics">Timer.Timed</a></th>
<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">
<th class="colFirst" scope="row"><a href="TimerResult.html" title="interface in org.apache.iceberg.metrics">TimerResult</a></th>
<td class="colLast">
<div class="block">A serializable version of a <a href="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">
<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">
<th class="colFirst" scope="row"><a href="CommitMetrics.html" title="class in org.apache.iceberg.metrics">CommitMetrics</a></th>
<td class="colLast">
<div class="block">Carries all metrics for a particular commit</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CommitReportParser.html" title="class in org.apache.iceberg.metrics">CommitReportParser</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultCounter.html" title="class in org.apache.iceberg.metrics">DefaultCounter</a></th>
<td class="colLast">
<div class="block">A default <a href="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">
<th class="colFirst" scope="row"><a href="DefaultMetricsContext.html" title="class in org.apache.iceberg.metrics">DefaultMetricsContext</a></th>
<td class="colLast">
<div class="block">A default <a href="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">
<th class="colFirst" scope="row"><a href="DefaultTimer.html" title="class in org.apache.iceberg.metrics">DefaultTimer</a></th>
<td class="colLast">
<div class="block">A default <a href="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">
<th class="colFirst" scope="row"><a href="FixedReservoirHistogram.html" title="class in org.apache.iceberg.metrics">FixedReservoirHistogram</a></th>
<td class="colLast">
<div class="block">A <a href="Histogram.html" title="interface in org.apache.iceberg.metrics"><code>Histogram</code></a> implementation with reservoir sampling.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InMemoryMetricsReporter.html" title="class in org.apache.iceberg.metrics">InMemoryMetricsReporter</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LoggingMetricsReporter.html" title="class in org.apache.iceberg.metrics">LoggingMetricsReporter</a></th>
<td class="colLast">
<div class="block">A default <a href="MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> implementation that logs the <a href="MetricsReport.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReport</code></a> to the log
file.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MetricsReporters.html" title="class in org.apache.iceberg.metrics">MetricsReporters</a></th>
<td class="colLast">
<div class="block">Utility class that allows combining two given <a href="MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScanMetrics.html" title="class in org.apache.iceberg.metrics">ScanMetrics</a></th>
<td class="colLast">
<div class="block">Carries all metrics for a particular scan</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ScanMetricsUtil.html" title="class in org.apache.iceberg.metrics">ScanMetricsUtil</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ScanReportParser.html" title="class in org.apache.iceberg.metrics">ScanReportParser</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="MetricsContext.Unit.html" title="enum in org.apache.iceberg.metrics">MetricsContext.Unit</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>