| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>IMetric (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.metric.api, interface: IMetric"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/IMetric.html">Use</a></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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.metric.api</a></div> |
| <h1 title="Interface IMetric" class="title">Interface IMetric</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="rpc/IShellMetric.html" title="interface in org.apache.storm.metric.api.rpc">IShellMetric</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AssignableMetric.html" title="class in org.apache.storm.metric.api">AssignableMetric</a></code>, <code><a href="rpc/AssignableShellMetric.html" title="class in org.apache.storm.metric.api.rpc">AssignableShellMetric</a></code>, <code><a href="../cgroup/CGroupCpu.html" title="class in org.apache.storm.metric.cgroup">CGroupCpu</a></code>, <code><a href="../cgroup/CGroupCpuGuarantee.html" title="class in org.apache.storm.metric.cgroup">CGroupCpuGuarantee</a></code>, <code><a href="../cgroup/CGroupCpuGuaranteeByCfsQuota.html" title="class in org.apache.storm.metric.cgroup">CGroupCpuGuaranteeByCfsQuota</a></code>, <code><a href="../cgroup/CGroupMemoryLimit.html" title="class in org.apache.storm.metric.cgroup">CGroupMemoryLimit</a></code>, <code><a href="../cgroup/CGroupMemoryUsage.html" title="class in org.apache.storm.metric.cgroup">CGroupMemoryUsage</a></code>, <code><a href="../cgroup/CGroupMetricsBase.html" title="class in org.apache.storm.metric.cgroup">CGroupMetricsBase</a></code>, <code><a href="CombinedMetric.html" title="class in org.apache.storm.metric.api">CombinedMetric</a></code>, <code><a href="rpc/CombinedShellMetric.html" title="class in org.apache.storm.metric.api.rpc">CombinedShellMetric</a></code>, <code><a href="CountMetric.html" title="class in org.apache.storm.metric.api">CountMetric</a></code>, <code><a href="rpc/CountShellMetric.html" title="class in org.apache.storm.metric.api.rpc">CountShellMetric</a></code>, <code><a href="../../metrics/sigar/CPUMetric.html" title="class in org.apache.storm.metrics.sigar">CPUMetric</a></code>, <code><a href="../../messaging/DeserializingConnectionCallback.html" title="class in org.apache.storm.messaging">DeserializingConnectionCallback</a></code>, <code><a href="../../metrics/hdrhistogram/HistogramMetric.html" title="class in org.apache.storm.metrics.hdrhistogram">HistogramMetric</a></code>, <code><a href="MultiCountMetric.html" title="class in org.apache.storm.metric.api">MultiCountMetric</a></code>, <code><a href="MultiReducedMetric.html" title="class in org.apache.storm.metric.api">MultiReducedMetric</a></code>, <code><a href="ReducedMetric.html" title="class in org.apache.storm.metric.api">ReducedMetric</a></code>, <code><a href="rpc/ReducedShellMetric.html" title="class in org.apache.storm.metric.api.rpc">ReducedShellMetric</a></code>, <code><a href="StateMetric.html" title="class in org.apache.storm.metric.api">StateMetric</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IMetric</span></div> |
| <div class="block">Produces metrics. |
| Usually, metric is a measurement identified by a name string. |
| Dimensions are a collection of additional key-value metadata map containing extra information of this measurement. |
| It is optional when customizing your metric by implementing this interface</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDimensions()" class="member-name-link">getDimensions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get dimension map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueAndReset()" class="member-name-link">getValueAndReset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get value and reset.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getValueAndReset()"> |
| <h3>getValueAndReset</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getValueAndReset</span>()</div> |
| <div class="block">Get value and reset.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an object that will be sent to |
| <a href="IMetricsConsumer.html#handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer.TaskInfo,java.util.Collection)"><code>IMetricsConsumer.handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer.TaskInfo, java.util.Collection)</code></a>. |
| If <code>null</code> is returned nothing will be sent. If this value can be reset, like with a counter, a side effect |
| of calling this should be that the value is reset.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDimensions()"> |
| <h3>getDimensions</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getDimensions</span>()</div> |
| <div class="block">Get dimension map. An empty map will be returned if metric is not dimensional.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a K-V map of the additional metadata.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
