356 lines
15 KiB
HTML
356 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:38 PDT 2019 -->
|
|
<title>DoubleGauge (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="DoubleGauge (openconsensus-api 0.1.0-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../openconsensus/metrics/DoubleCumulative.DoublePoint.html" title="interface in openconsensus.metrics"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../openconsensus/metrics/DoubleGauge.Builder.html" title="interface in openconsensus.metrics"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?openconsensus/metrics/DoubleGauge.html" target="_top">Frames</a></li>
|
|
<li><a href="DoubleGauge.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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">openconsensus.metrics</div>
|
|
<h2 title="Interface DoubleGauge" class="title">Interface DoubleGauge</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd><a href="../../openconsensus/metrics/Metric.html" title="interface in openconsensus.metrics">Metric</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/concurrent.ThreadSafe.html?is-external=true" title="class or interface in javax.annotation">@ThreadSafe</a>
|
|
public interface <span class="typeNameLabel">DoubleGauge</span>
|
|
extends <a href="../../openconsensus/metrics/Metric.html" title="interface in openconsensus.metrics">Metric</a></pre>
|
|
<div class="block">Double Gauge metric, to report instantaneous measurement of a double value. Gauges can go both up
|
|
and down. The gauges values can be negative.
|
|
|
|
<p>Example 1: Create a Gauge with default labels.
|
|
|
|
<pre><code>
|
|
class YourClass {
|
|
|
|
private static final Meter meter = Metrics.getMeter();
|
|
private static final MetricRegistry metricRegistry = meter.metricRegistryBuilder().build();
|
|
|
|
List<LabelKey> labelKeys = Arrays.asList(LabelKey.create("Name", "desc"));
|
|
|
|
DoubleGauge gauge = metricRegistry.addDoubleGauge("queue_size",
|
|
"Pending jobs", "1", labelKeys);
|
|
|
|
// It is recommended to keep a reference of a point for manual operations.
|
|
DoublePoint defaultPoint = gauge.getDefaultTimeSeries();
|
|
|
|
void doWork() {
|
|
// Your code here.
|
|
defaultPoint.add(10);
|
|
}
|
|
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Example 2: You can also use labels(keys and values) to track different types of metric.
|
|
|
|
<pre><code>
|
|
class YourClass {
|
|
|
|
private static final Meter meter = Metrics.getMeter();
|
|
private static final MetricRegistry metricRegistry = meter.metricRegistryBuilder().build();
|
|
|
|
List<LabelKey> labelKeys = Arrays.asList(LabelKey.create("Name", "desc"));
|
|
List<LabelValue> labelValues = Arrays.asList(LabelValue.create("Inbound"));
|
|
|
|
DoubleGauge gauge = metricRegistry.addDoubleGauge("queue_size",
|
|
"Pending jobs", "1", labelKeys);
|
|
|
|
// It is recommended to keep a reference of a point for manual operations.
|
|
DoublePoint inboundPoint = gauge.getOrCreateTimeSeries(labelValues);
|
|
|
|
void doSomeWork() {
|
|
// Your code here.
|
|
inboundPoint.set(15);
|
|
}
|
|
|
|
}
|
|
</code></pre></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</dd>
|
|
</dl>
|
|
</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"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Interface and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static interface </code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/metrics/DoubleGauge.Builder.html" title="interface in openconsensus.metrics">DoubleGauge.Builder</a></span></code>
|
|
<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"><code>static interface </code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a></span></code>
|
|
<div class="block">The value of a single point in the Gauge.TimeSeries.</div>
|
|
</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/metrics/DoubleGauge.html#getDefaultTimeSeries--">getDefaultTimeSeries</a></span>()</code>
|
|
<div class="block">Returns a <code>DoublePoint</code> for a gauge with all labels not set, or default labels.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/metrics/DoubleGauge.html#getOrCreateTimeSeries-java.util.List-">getOrCreateTimeSeries</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../openconsensus/metrics/LabelValue.html" title="class in openconsensus.metrics">LabelValue</a>> labelValues)</code>
|
|
<div class="block">Creates a <code>TimeSeries</code> and returns a <code>DoublePoint</code> if the specified <code>labelValues</code> is not already associated with this gauge, else returns an existing <code>DoublePoint</code>.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.openconsensus.metrics.Metric">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface openconsensus.metrics.<a href="../../openconsensus/metrics/Metric.html" title="interface in openconsensus.metrics">Metric</a></h3>
|
|
<code><a href="../../openconsensus/metrics/Metric.html#clear--">clear</a>, <a href="../../openconsensus/metrics/Metric.html#removeTimeSeries-java.util.List-">removeTimeSeries</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getOrCreateTimeSeries-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOrCreateTimeSeries</h4>
|
|
<pre><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a> getOrCreateTimeSeries(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../openconsensus/metrics/LabelValue.html" title="class in openconsensus.metrics">LabelValue</a>> labelValues)</pre>
|
|
<div class="block">Creates a <code>TimeSeries</code> and returns a <code>DoublePoint</code> if the specified <code>labelValues</code> is not already associated with this gauge, else returns an existing <code>DoublePoint</code>.
|
|
|
|
<p>It is recommended to keep a reference to the DoublePoint instead of always calling this
|
|
method for manual operations.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>labelValues</code> - the list of label values. The number of label values must be the same to
|
|
that of the label keys passed to <a href="../../openconsensus/metrics/Metric.Builder.html#setLabelKeys-java.util.List-"><code>Metric.Builder.setLabelKeys(List)</code></a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a <code>DoublePoint</code> the value of single gauge.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>labelValues</code> is null OR any element of <code>labelValues</code> is null.</dd>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if number of <code>labelValues</code>s are not equal to the label
|
|
keys.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDefaultTimeSeries--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getDefaultTimeSeries</h4>
|
|
<pre><a href="../../openconsensus/metrics/DoubleGauge.DoublePoint.html" title="interface in openconsensus.metrics">DoubleGauge.DoublePoint</a> getDefaultTimeSeries()</pre>
|
|
<div class="block">Returns a <code>DoublePoint</code> for a gauge with all labels not set, or default labels.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a <code>DoublePoint</code> for a gauge with all labels not set, or default labels.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>0.1.0</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="../../openconsensus/metrics/DoubleCumulative.DoublePoint.html" title="interface in openconsensus.metrics"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../openconsensus/metrics/DoubleGauge.Builder.html" title="interface in openconsensus.metrics"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?openconsensus/metrics/DoubleGauge.html" target="_top">Frames</a></li>
|
|
<li><a href="DoubleGauge.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">All 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: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|