| <!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_272) on Thu Nov 12 16:27:24 PST 2020 --> |
| <title>MetricsPublishingService (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="MetricsPublishingService (Apache Geode 1.13.1)"; |
| } |
| } |
| 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>Prev Class</li> |
| <li><a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/metrics/MetricsPublishingService.html" target="_top">Frames</a></li> |
| <li><a href="MetricsPublishingService.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>Nested | </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">org.apache.geode.metrics</div> |
| <h2 title="Interface MetricsPublishingService" class="title">Interface MetricsPublishingService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../org/apache/geode/annotations/Experimental.html" title="annotation in org.apache.geode.annotations">@Experimental</a>(<a href="../../../../org/apache/geode/annotations/Experimental.html#value--">value</a>="Micrometer metrics is a new addition to Geode and the API may change") |
| public interface <span class="typeNameLabel">MetricsPublishingService</span></pre> |
| <div class="block">Publishes metrics managed by a <a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics"><code>MetricsSession</code></a>. |
| |
| <p> |
| Geode discovers <code>MetricsPublishingService</code>s during system creation, using the standard Java |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html?is-external=true" title="class or interface in java.util"><code>ServiceLoader</code></a> mechanism: |
| |
| <p> |
| |
| <pre> |
| package com.application; |
| |
| public class MyMetricsPublishingService implements MetricsPublishingService { |
| private volatile MeterRegistry registry; |
| private volatile MetricsSession session; |
| |
| @Override |
| public void start(MetricsSession session) { |
| this.session = session; |
| registry = ... // configure your meter registry and start publishing |
| |
| // add your registry as a sub-registry to the session |
| session.addSubregistry(registry); |
| } |
| |
| @Override |
| public void stop() { |
| ... |
| // clean up any resources used by your meter registry |
| ... |
| |
| session.removeSubregistry(registry); |
| } |
| } |
| </pre> |
| |
| <p> |
| To make your service available for loading, add the following provider-configuration file in the |
| resource directory of your application Jar: |
| |
| <p> |
| <code>META-INF/services/org.apache.geode.metrics.MetricsPublishingService</code> |
| |
| <p> |
| Add a line inside the file indicating the fully qualified class name of your implementation: |
| |
| <p> |
| <code>com.application.MyMetricsPublishingService</code> |
| |
| <p> |
| Experimental: Micrometer metrics is a new addition to Geode and the API may change.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://micrometer.io/docs">Micrometer Documentation</a>, |
| <a href="https://micrometer.io/docs/concepts">Micrometer Concepts</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/metrics/MetricsPublishingService.html#start-org.apache.geode.metrics.MetricsSession-">start</a></span>(<a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics">MetricsSession</a> session)</code> |
| <div class="block">Invoked when a metrics session starts.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/metrics/MetricsPublishingService.html#stop-org.apache.geode.metrics.MetricsSession-">stop</a></span>(<a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics">MetricsSession</a> session)</code> |
| <div class="block">Invoked when a metrics session stops.</div> |
| </td> |
| </tr> |
| </table> |
| </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="start-org.apache.geode.metrics.MetricsSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start(<a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics">MetricsSession</a> session)</pre> |
| <div class="block">Invoked when a metrics session starts. A typical implementation will create a meter registry |
| that can publish to an external monitoring system, and call |
| <a href="../../../../org/apache/geode/metrics/MetricsSession.html#addSubregistry-io.micrometer.core.instrument.MeterRegistry-"><code>MetricsSession.addSubregistry(MeterRegistry)</code></a> to add that registry to the session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the metrics session whose metrics this publishing service will publish</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stop-org.apache.geode.metrics.MetricsSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop(<a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics">MetricsSession</a> session)</pre> |
| <div class="block">Invoked when a metrics session stops. The implementation should call |
| <a href="../../../../org/apache/geode/metrics/MetricsSession.html#removeSubregistry-io.micrometer.core.instrument.MeterRegistry-"><code>MetricsSession.removeSubregistry(MeterRegistry)</code></a> to remove each meter registry it added |
| to the session. The implementation should also clean up any other resources it allocated during</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the metrics session whose metrics this publishing service was publishing |
| <a href="../../../../org/apache/geode/metrics/MetricsPublishingService.html#start-org.apache.geode.metrics.MetricsSession-"><code>start(MetricsSession)</code></a>.</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>Prev Class</li> |
| <li><a href="../../../../org/apache/geode/metrics/MetricsSession.html" title="interface in org.apache.geode.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/metrics/MetricsPublishingService.html" target="_top">Frames</a></li> |
| <li><a href="MetricsPublishingService.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>Nested | </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> |