blob: 2a8fe1aec01a253094f64fcaecccd00bd80524c5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.storm.metricstore.MetricException (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="use: package: org.apache.storm.metricstore, class: MetricException">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">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><a href="../MetricException.html" title="class in org.apache.storm.metricstore">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Class org.apache.storm.metricstore.MetricException" class="title">Uses of Class<br>org.apache.storm.metricstore.MetricException</h1>
</div>
<div class="caption"><span>Packages that use <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.metricstore">org.apache.storm.metricstore</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.metricstore.rocksdb">org.apache.storm.metricstore.rocksdb</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.metricstore">
<h2>Uses of <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a> in <a href="../package-summary.html">org.apache.storm.metricstore</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.metricstore</a> that throw <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a></span></div>
<div class="summary-table three-column-summary">
<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"><code>static <a href="../MetricStore.html" title="interface in org.apache.storm.metricstore">MetricStore</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">MetricStoreConfig.</span><code><a href="../MetricStoreConfig.html#configure(java.util.Map,org.apache.storm.metric.StormMetricsRegistry)" class="member-name-link">configure</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="../../metric/StormMetricsRegistry.html" title="class in org.apache.storm.metric">StormMetricsRegistry</a>&nbsp;metricsRegistry)</code></div>
<div class="col-last even-row-color">
<div class="block">Configures metrics store (running on Nimbus) to use the class specified in the conf.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="../WorkerMetricsProcessor.html" title="interface in org.apache.storm.metricstore">WorkerMetricsProcessor</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MetricStoreConfig.</span><code><a href="../MetricStoreConfig.html#configureMetricProcessor(java.util.Map)" class="member-name-link">configureMetricProcessor</a><wbr>(<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>&nbsp;conf)</code></div>
<div class="col-last odd-row-color">
<div class="block">Configures metric processor (running on supervisor) to use the class specified in the conf.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">MetricStore.</span><code><a href="../MetricStore.html#insert(org.apache.storm.metricstore.Metric)" class="member-name-link">insert</a><wbr>(<a href="../Metric.html" title="class in org.apache.storm.metricstore">Metric</a>&nbsp;metric)</code></div>
<div class="col-last even-row-color">
<div class="block">Stores a metric in the store.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MetricStore.</span><code><a href="../MetricStore.html#populateValue(org.apache.storm.metricstore.Metric)" class="member-name-link">populateValue</a><wbr>(<a href="../Metric.html" title="class in org.apache.storm.metricstore">Metric</a>&nbsp;metric)</code></div>
<div class="col-last odd-row-color">
<div class="block">Fill out the numeric values for a metric.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">MetricStore.</span><code><a href="../MetricStore.html#prepare(java.util.Map,org.apache.storm.metric.StormMetricsRegistry)" class="member-name-link">prepare</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;config,
<a href="../../metric/StormMetricsRegistry.html" title="class in org.apache.storm.metric">StormMetricsRegistry</a>&nbsp;metricsRegistry)</code></div>
<div class="col-last even-row-color">
<div class="block">Create metric store instance using the configurations provided via the config map.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">NimbusMetricProcessor.</span><code><a href="../NimbusMetricProcessor.html#prepare(java.util.Map)" class="member-name-link">prepare</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;config)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">WorkerMetricsProcessor.</span><code><a href="../WorkerMetricsProcessor.html#prepare(java.util.Map)" class="member-name-link">prepare</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color">
<div class="block">Prepares the metric processor.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">NimbusMetricProcessor.</span><code><a href="../NimbusMetricProcessor.html#processWorkerMetrics(java.util.Map,org.apache.storm.generated.WorkerMetrics)" class="member-name-link">processWorkerMetrics</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="../../generated/WorkerMetrics.html" title="class in org.apache.storm.generated">WorkerMetrics</a>&nbsp;metrics)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">WorkerMetricsProcessor.</span><code><a href="../WorkerMetricsProcessor.html#processWorkerMetrics(java.util.Map,org.apache.storm.generated.WorkerMetrics)" class="member-name-link">processWorkerMetrics</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="../../generated/WorkerMetrics.html" title="class in org.apache.storm.generated">WorkerMetrics</a>&nbsp;metrics)</code></div>
<div class="col-last even-row-color">
<div class="block">Process insertion of worker metrics.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">MetricStore.</span><code><a href="../MetricStore.html#scan(org.apache.storm.metricstore.FilterOptions,org.apache.storm.metricstore.MetricStore.ScanCallback)" class="member-name-link">scan</a><wbr>(<a href="../FilterOptions.html" title="class in org.apache.storm.metricstore">FilterOptions</a>&nbsp;filter,
<a href="../MetricStore.ScanCallback.html" title="interface in org.apache.storm.metricstore">MetricStore.ScanCallback</a>&nbsp;scanCallback)</code></div>
<div class="col-last odd-row-color">
<div class="block">Scans all metrics in the store and returns the ones matching the specified filtering options.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Metric.</span><code><a href="../Metric.html#setAggLevel(org.apache.storm.metricstore.AggLevel)" class="member-name-link">setAggLevel</a><wbr>(<a href="../AggLevel.html" title="enum in org.apache.storm.metricstore">AggLevel</a>&nbsp;aggLevel)</code></div>
<div class="col-last even-row-color">
<div class="block">Set the aggLevel.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">FilterOptions.</span><code><a href="../FilterOptions.html#setAggLevels(java.util.Set)" class="member-name-link">setAggLevels</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../AggLevel.html" title="enum in org.apache.storm.metricstore">AggLevel</a>&gt;&nbsp;levels)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the aggregation levels to search for.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.storm.metricstore</a> that throw <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../Metric.html#%3Cinit%3E(java.lang.String,java.lang.Long,java.lang.String,double,java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,org.apache.storm.metricstore.AggLevel)" class="member-name-link">Metric</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>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>&nbsp;timestamp,
<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>&nbsp;topologyId,
double&nbsp;value,
<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>&nbsp;componentId,
<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>&nbsp;executorId,
<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>&nbsp;hostname,
<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>&nbsp;streamId,
int&nbsp;port,
<a href="../AggLevel.html" title="enum in org.apache.storm.metricstore">AggLevel</a>&nbsp;aggLevel)</code></div>
<div class="col-last even-row-color">
<div class="block">Metric constructor.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.metricstore.rocksdb">
<h2>Uses of <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a> in <a href="../rocksdb/package-summary.html">org.apache.storm.metricstore.rocksdb</a></h2>
<div class="caption"><span>Methods in <a href="../rocksdb/package-summary.html">org.apache.storm.metricstore.rocksdb</a> that throw <a href="../MetricException.html" title="class in org.apache.storm.metricstore">MetricException</a></span></div>
<div class="summary-table three-column-summary">
<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"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">RocksDbStore.</span><code><a href="../rocksdb/RocksDbStore.html#insert(org.apache.storm.metricstore.Metric)" class="member-name-link">insert</a><wbr>(<a href="../Metric.html" title="class in org.apache.storm.metricstore">Metric</a>&nbsp;metric)</code></div>
<div class="col-last even-row-color">
<div class="block">Stores metrics in the store.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">RocksDbStore.</span><code><a href="../rocksdb/RocksDbStore.html#populateValue(org.apache.storm.metricstore.Metric)" class="member-name-link">populateValue</a><wbr>(<a href="../Metric.html" title="class in org.apache.storm.metricstore">Metric</a>&nbsp;metric)</code></div>
<div class="col-last odd-row-color">
<div class="block">Fill out the numeric values for a metric.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">RocksDbStore.</span><code><a href="../rocksdb/RocksDbStore.html#prepare(java.util.Map,org.apache.storm.metric.StormMetricsRegistry)" class="member-name-link">prepare</a><wbr>(<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>&lt;<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;config,
<a href="../../metric/StormMetricsRegistry.html" title="class in org.apache.storm.metric">StormMetricsRegistry</a>&nbsp;metricsRegistry)</code></div>
<div class="col-last even-row-color">
<div class="block">Create metric store instance using the configurations provided via the config map.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StringMetadataCache.</span><code><a href="../rocksdb/StringMetadataCache.html#put(java.lang.String,org.apache.storm.metricstore.rocksdb.StringMetadata,boolean)" class="member-name-link">put</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>&nbsp;s,
org.apache.storm.metricstore.rocksdb.StringMetadata&nbsp;stringMetadata,
boolean&nbsp;newEntry)</code></div>
<div class="col-last odd-row-color">
<div class="block">Add the string metadata to the cache.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">WritableStringMetadataCache.</span><code><a href="../rocksdb/WritableStringMetadataCache.html#put(java.lang.String,org.apache.storm.metricstore.rocksdb.StringMetadata,boolean)" class="member-name-link">put</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>&nbsp;s,
org.apache.storm.metricstore.rocksdb.StringMetadata&nbsp;stringMetadata,
boolean&nbsp;newEntry)</code></div>
<div class="col-last even-row-color">
<div class="block">Add the string metadata to the cache.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">RocksDbStore.</span><code><a href="../rocksdb/RocksDbStore.html#scan(org.apache.storm.metricstore.FilterOptions,org.apache.storm.metricstore.MetricStore.ScanCallback)" class="member-name-link">scan</a><wbr>(<a href="../FilterOptions.html" title="class in org.apache.storm.metricstore">FilterOptions</a>&nbsp;filter,
<a href="../MetricStore.ScanCallback.html" title="interface in org.apache.storm.metricstore">MetricStore.ScanCallback</a>&nbsp;scanCallback)</code></div>
<div class="col-last odd-row-color">
<div class="block">Scans all metrics in the store and returns the ones matching the specified filtering options.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>