opentelemetry-java/docs/openconsensus/metrics/package-summary.html

341 lines
15 KiB
HTML

<!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_181-google-v7) on Thu Apr 25 10:43:39 PDT 2019 -->
<title>openconsensus.metrics (openconsensus-api 0.1.0-SNAPSHOT API)</title>
<meta name="date" content="2019-04-25">
<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="openconsensus.metrics (openconsensus-api 0.1.0-SNAPSHOT API)";
}
}
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="../../openconsensus/context/propagation/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../openconsensus/resource/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/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;openconsensus.metrics</h1>
<div class="docSummary">
<div class="block">This package describes the Metrics API that can be used to record application Metrics.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</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="../../openconsensus/metrics/DerivedDoubleCumulative.html" title="interface in openconsensus.metrics">DerivedDoubleCumulative</a></td>
<td class="colLast">
<div class="block">Derived Double Cumulative metric, to report cumulative measurement of a double value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedDoubleCumulative.Builder.html" title="interface in openconsensus.metrics">DerivedDoubleCumulative.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DerivedDoubleCumulative.html" title="interface in openconsensus.metrics"><code>DerivedDoubleCumulative</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedDoubleGauge.html" title="interface in openconsensus.metrics">DerivedDoubleGauge</a></td>
<td class="colLast">
<div class="block">Derived Double Gauge metric, to report instantaneous measurement of a double value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedDoubleGauge.Builder.html" title="interface in openconsensus.metrics">DerivedDoubleGauge.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DerivedDoubleGauge.html" title="interface in openconsensus.metrics"><code>DerivedDoubleGauge</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedLongCumulative.html" title="interface in openconsensus.metrics">DerivedLongCumulative</a></td>
<td class="colLast">
<div class="block">Derived Long Cumulative metric, to report cumulative measurement of a long value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedLongCumulative.Builder.html" title="interface in openconsensus.metrics">DerivedLongCumulative.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DerivedLongCumulative.html" title="interface in openconsensus.metrics"><code>DerivedLongCumulative</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedLongGauge.html" title="interface in openconsensus.metrics">DerivedLongGauge</a></td>
<td class="colLast">
<div class="block">Derived Long Gauge metric, to report instantaneous measurement of an int64 value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DerivedLongGauge.Builder.html" title="interface in openconsensus.metrics">DerivedLongGauge.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DerivedLongGauge.html" title="interface in openconsensus.metrics"><code>DerivedLongGauge</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleCumulative.html" title="interface in openconsensus.metrics">DoubleCumulative</a></td>
<td class="colLast">
<div class="block">Double Cumulative metric, to report instantaneous measurement of a double value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleCumulative.Builder.html" title="interface in openconsensus.metrics">DoubleCumulative.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DoubleCumulative.html" title="interface in openconsensus.metrics"><code>DoubleCumulative</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleCumulative.DoublePoint.html" title="interface in openconsensus.metrics">DoubleCumulative.DoublePoint</a></td>
<td class="colLast">
<div class="block">The value of a single point in the Cumulative.TimeSeries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleGauge.html" title="interface in openconsensus.metrics">DoubleGauge</a></td>
<td class="colLast">
<div class="block">Double Gauge metric, to report instantaneous measurement of a double value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleGauge.Builder.html" title="interface in openconsensus.metrics">DoubleGauge.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/DerivedLongGauge.html" title="interface in openconsensus.metrics"><code>DerivedLongGauge</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a></td>
<td class="colLast">
<div class="block">The value of a single point in the Gauge.TimeSeries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongCumulative.html" title="interface in openconsensus.metrics">LongCumulative</a></td>
<td class="colLast">
<div class="block">Long Cumulative metric, to report instantaneous measurement of a long value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongCumulative.Builder.html" title="interface in openconsensus.metrics">LongCumulative.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/LongCumulative.html" title="interface in openconsensus.metrics"><code>LongCumulative</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongCumulative.LongPoint.html" title="interface in openconsensus.metrics">LongCumulative.LongPoint</a></td>
<td class="colLast">
<div class="block">The value of a single point in the Cumulative.TimeSeries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongGauge.html" title="interface in openconsensus.metrics">LongGauge</a></td>
<td class="colLast">
<div class="block">Long Gauge metric, to report instantaneous measurement of an int64 value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongGauge.Builder.html" title="interface in openconsensus.metrics">LongGauge.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for <a href="../../openconsensus/metrics/LongGauge.html" title="interface in openconsensus.metrics"><code>LongGauge</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LongGauge.LongPoint.html" title="interface in openconsensus.metrics">LongGauge.LongPoint</a></td>
<td class="colLast">
<div class="block">The value of a single point in the Gauge.TimeSeries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/Meter.html" title="interface in openconsensus.metrics">Meter</a></td>
<td class="colLast">
<div class="block">Entry point fot metrics API, this object allows to create new <a href="../../openconsensus/metrics/MetricRegistry.html" title="interface in openconsensus.metrics"><code>MetricRegistry</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/Metric.html" title="interface in openconsensus.metrics">Metric</a></td>
<td class="colLast">
<div class="block">Base interface for all metrics defined in this package.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/Metric.Builder.html" title="interface in openconsensus.metrics">Metric.Builder</a>&lt;B extends <a href="../../openconsensus/metrics/Metric.Builder.html" title="interface in openconsensus.metrics">Metric.Builder</a>&lt;B,V&gt;,V&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/MetricRegistry.html" title="interface in openconsensus.metrics">MetricRegistry</a></td>
<td class="colLast">
<div class="block">Creates and manages a set of metrics for a library/application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/MetricRegistry.Builder.html" title="interface in openconsensus.metrics">MetricRegistry.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for the <a href="../../openconsensus/metrics/MetricRegistry.html" title="interface in openconsensus.metrics"><code>MetricRegistry</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/ToDoubleFunction.html" title="interface in openconsensus.metrics">ToDoubleFunction</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Represents a function that produces a double-valued result.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/ToLongFunction.html" title="interface in openconsensus.metrics">ToLongFunction</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Represents a function that produces a long-valued 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="../../openconsensus/metrics/LabelKey.html" title="class in openconsensus.metrics">LabelKey</a></td>
<td class="colLast">
<div class="block">The key of a <code>Label</code> associated with a <code>MetricDescriptor</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/LabelValue.html" title="class in openconsensus.metrics">LabelValue</a></td>
<td class="colLast">
<div class="block">The value of a <code>Label</code> associated with a <code>TimeSeries</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../openconsensus/metrics/Metrics.html" title="class in openconsensus.metrics">Metrics</a></td>
<td class="colLast">
<div class="block">Class for accessing the default <a href="../../openconsensus/metrics/Meter.html" title="interface in openconsensus.metrics"><code>Meter</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../openconsensus/metrics/NoopMetrics.html" title="class in openconsensus.metrics">NoopMetrics</a></td>
<td class="colLast">
<div class="block">No-op implementations of metrics classes.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package openconsensus.metrics Description">Package openconsensus.metrics Description</h2>
<div class="block">This package describes the Metrics API that can be used to record application Metrics.</div>
</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="../../openconsensus/context/propagation/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../openconsensus/resource/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/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>