Google Git
Sign in
apache / incubator-retired-edgent-website / 1d74f4c030b7ba91ee3052633b8aafac15d6919c / . / site / javadoc / r1.2.0 / org / apache / edgent / metrics / class-use / MetricsSetup.html
blob: c790f3afd3abc2c8617d82bfa82fafe124628668 [file] [log] [blame]
<!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_112) on Mon Dec 18 11:25:23 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class org.apache.edgent.metrics.MetricsSetup (Apache Edgent (incubating) v1.2.0 API)</title>
<meta name="date" content="2017-12-18">
<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="Uses of Class org.apache.edgent.metrics.MetricsSetup (Apache Edgent (incubating) v1.2.0 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><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">Class</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/metrics/class-use/MetricsSetup.html" target="_top">Frames</a></li>
<li><a href="MetricsSetup.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">
<h2 title="Uses of Class org.apache.edgent.metrics.MetricsSetup" class="title">Uses of Class<br>org.apache.edgent.metrics.MetricsSetup</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.edgent.metrics">org.apache.edgent.metrics</a></td>
<td class="colLast">
<div class="block">Metric utility methods, oplets, and reporters which allow an
application to expose metric values, for example via JMX.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.edgent.metrics">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a> in <a href="../../../../../org/apache/edgent/metrics/package-summary.html">org.apache.edgent.metrics</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/edgent/metrics/package-summary.html">org.apache.edgent.metrics</a> that return <a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></code></td>
<td class="colLast"><span class="typeNameLabel">MetricsSetup.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html#registerWith-javax.management.MBeanServer-">registerWith</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/javax/management/MBeanServer.html?is-external=true" title="class or interface in javax.management">MBeanServer</a>&nbsp;mBeanServer)</code>
<div class="block">Use the specified <code>MBeanServer</code> with this metric setup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></code></td>
<td class="colLast"><span class="typeNameLabel">MetricsSetup.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html#startConsoleReporter--">startConsoleReporter</a></span>()</code>
<div class="block">Starts the metric <code>ConsoleReporter</code> polling every second.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></code></td>
<td class="colLast"><span class="typeNameLabel">MetricsSetup.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html#startCSVReporter-java.lang.String-">startCSVReporter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pathMetrics)</code>
<div class="block">Starts the metric <code>CsvReporter</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></code></td>
<td class="colLast"><span class="typeNameLabel">MetricsSetup.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html#startJMXReporter-java.lang.String-">startJMXReporter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;jmxDomainName)</code>
<div class="block">Starts the metric <code>JMXReporter</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">MetricsSetup</a></code></td>
<td class="colLast"><span class="typeNameLabel">MetricsSetup.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html#withRegistry-org.apache.edgent.execution.services.ServiceContainer-com.codahale.metrics.MetricRegistry-">withRegistry</a></span>(<a href="../../../../../org/apache/edgent/execution/services/ServiceContainer.html" title="class in org.apache.edgent.execution.services">ServiceContainer</a>&nbsp;services,
com.codahale.metrics.MetricRegistry&nbsp;registry)</code>
<div class="block">Returns a new <a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics"><code>MetricsSetup</code></a> for configuring metrics.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../org/apache/edgent/metrics/MetricsSetup.html" title="class in org.apache.edgent.metrics">Class</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/metrics/class-use/MetricsSetup.html" target="_top">Frames</a></li>
<li><a href="MetricsSetup.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>