| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.6.0/javadoc/org/apache/ignite/mxbean/MemoryMetricsMXBean.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <!-- Generated by javadoc (1.8.0_77) on Tue Jul 10 11:04:45 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MemoryMetricsMXBean (Ignite 2.6.0)</title> |
| <meta name="date" content="2018-07-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MemoryMetricsMXBean (Ignite 2.6.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38,"i6":38,"i7":38,"i8":38,"i9":38,"i10":38,"i11":38,"i12":38,"i13":38,"i14":38,"i15":38}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="class-use/MemoryMetricsMXBean.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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/mxbean/IgnitionMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/mxbean/MemoryMetricsMXBean.html" target="_top">Frames</a></li> |
| <li><a href="MemoryMetricsMXBean.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.ignite.mxbean</div> |
| <h2 title="Interface MemoryMetricsMXBean" class="title">Interface MemoryMetricsMXBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></dd> |
| </dl> |
| <hr> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Part of old API. Metrics are accessible through <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><code>DataRegionMetricsMXBean</code></a>.</span></div> |
| </div> |
| <br> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="MBean that provides access to MemoryMetrics of a local Apache Ignite node.") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public interface <span class="typeNameLabel">MemoryMetricsMXBean</span> |
| extends <a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></pre> |
| <div class="block">This interface defines a JMX view on <a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite"><code>MemoryMetrics</code></a>.</div> |
| </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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/ignite/mxbean/MemoryMetricsMXBean.html#disableMetrics--">disableMetrics</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Disables memory metrics collection on an Apache Ignite node.</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/ignite/mxbean/MemoryMetricsMXBean.html#enableMetrics--">enableMetrics</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Enables memory metrics collection on an Apache Ignite node.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--">getAllocationRate</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets pages allocation rate of a memory region.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getDirtyPages--">getDirtyPages</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets the number of dirty pages (pages which contents is different from the current persistent storage state).</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getEvictionRate--">getEvictionRate</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets eviction rate of a given memory region.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getInitialSize--">getInitialSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets initial memory region size defined by its <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getLargeEntriesPagesPercentage--">getLargeEntriesPagesPercentage</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets percentage of pages that are fully occupied by large entries that go beyond page size.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getMaxSize--">getMaxSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Maximum memory region size defined by its <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getName--">getName</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A name of a memory region the metrics are collected for.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getPagesFillFactor--">getPagesFillFactor</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets the percentage of space that is still free and can be filled in.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getPagesReplaceRate--">getPagesReplaceRate</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets rate (pages per second) at which pages get replaced with other pages from persistent storage.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getPhysicalMemoryPages--">getPhysicalMemoryPages</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets total number of pages currently loaded to the RAM.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getSwapFilePath--">getSwapFilePath</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A path to the memory-mapped files the memory region defined by <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a> will be |
| mapped to.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getTotalAllocatedPages--">getTotalAllocatedPages</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a total number of allocated pages related to the memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#rateTimeInterval-long-">rateTimeInterval</a></span>(long rateTimeInterval)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets time interval for <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getEvictionRate--"><code>getEvictionRate()</code></a> monitoring purposes.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#subIntervals-int-">subIntervals</a></span>(int subInts)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#rateTimeInterval-long-"><code>rateTimeInterval(long)</code></a> will be split into to calculate |
| <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getEvictionRate--"><code>getEvictionRate()</code></a> rates (5 by default).</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="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="A name of a memory region the metrics are collected for.") |
| <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> getName()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A name of a memory region the metrics are collected for.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getName--">getName</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Name of the memory region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialSize</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Initial memory region size defined by its memory policy.") |
| int getInitialSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets initial memory region size defined by its <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Initial size in MB.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxSize</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Maximum memory region size defined by its memory policy.") |
| int getMaxSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Maximum memory region size defined by its <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Maximum size in MB.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSwapFilePath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSwapFilePath</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Path to the memory-mapped files.") |
| <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> getSwapFilePath()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A path to the memory-mapped files the memory region defined by <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryPolicyConfiguration</code></a> will be |
| mapped to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Path to the memory-mapped files.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalAllocatedPages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalAllocatedPages</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Total number of allocated pages.") |
| long getTotalAllocatedPages()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a total number of allocated pages related to the memory policy. When persistence is disabled, this |
| metric shows the total number of pages in memory. When persistence is enabled, this metric shows the |
| total number of pages in memory and on disk.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getTotalAllocatedPages--">getTotalAllocatedPages</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Total number of allocated pages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllocationRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllocationRate</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Allocation rate (pages per second) averaged across rateTimeInternal.") |
| float getAllocationRate()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets pages allocation rate of a memory region.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--">getAllocationRate</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of allocated pages per second.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEvictionRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionRate</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Eviction rate (pages per second).") |
| float getEvictionRate()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets eviction rate of a given memory region.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--">getEvictionRate</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of evicted pages per second.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLargeEntriesPagesPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLargeEntriesPagesPercentage</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Percentage of pages that are fully occupied by large entries that go beyond page size.") |
| float getLargeEntriesPagesPercentage()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets percentage of pages that are fully occupied by large entries that go beyond page size. The large entities |
| are split into fragments in a way so that each fragment can fit into a single page.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getLargeEntriesPagesPercentage--">getLargeEntriesPagesPercentage</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Percentage of pages fully occupied by large entities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPagesFillFactor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPagesFillFactor</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Percentage of space that is still free and can be filled in.") |
| float getPagesFillFactor()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets the percentage of space that is still free and can be filled in.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getPagesFillFactor--">getPagesFillFactor</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The percentage of space that is still free and can be filled in.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDirtyPages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirtyPages</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Number of pages in memory not yet synchronized with persistent storage.") |
| long getDirtyPages()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets the number of dirty pages (pages which contents is different from the current persistent storage state). |
| This metric is enabled only for Ignite nodes with enabled persistence.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getDirtyPages--">getDirtyPages</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current number of dirty pages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPagesReplaceRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPagesReplaceRate</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Rate at which pages in memory are replaced with pages from persistent storage (pages per second).") |
| float getPagesReplaceRate()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets rate (pages per second) at which pages get replaced with other pages from persistent storage. |
| The rate effectively represents the rate at which pages get 'evicted' in favor of newly needed pages. |
| This metric is enabled only for Ignite nodes with enabled persistence.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getPagesReplaceRate--">getPagesReplaceRate</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Pages per second replace rate.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPhysicalMemoryPages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhysicalMemoryPages</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Number of pages residing in physical RAM.") |
| long getPhysicalMemoryPages()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets total number of pages currently loaded to the RAM. When persistence is disabled, this metric is equal |
| to <a href="../../../../org/apache/ignite/MemoryMetrics.html#getTotalAllocatedPages--"><code>MemoryMetrics.getTotalAllocatedPages()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/MemoryMetrics.html#getPhysicalMemoryPages--">getPhysicalMemoryPages</a></code> in interface <code><a href="../../../../org/apache/ignite/MemoryMetrics.html" title="interface in org.apache.ignite">MemoryMetrics</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Total number of pages loaded to RAM.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enableMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableMetrics</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Enables memory metrics collection on an Apache Ignite node.") |
| void enableMetrics()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Enables memory metrics collection on an Apache Ignite node.</div> |
| </li> |
| </ul> |
| <a name="disableMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableMetrics</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Disables memory metrics collection on an Apache Ignite node.") |
| void disableMetrics()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Disables memory metrics collection on an Apache Ignite node.</div> |
| </li> |
| </ul> |
| <a name="rateTimeInterval-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rateTimeInterval</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Sets time interval for pages allocation and eviction monitoring purposes.") |
| <a href="../../../../org/apache/ignite/mxbean/MXBeanParametersNames.html" title="annotation in org.apache.ignite.mxbean">@MXBeanParametersNames</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanParametersNames.html#value--">value</a>="rateTimeInterval") |
| <a href="../../../../org/apache/ignite/mxbean/MXBeanParametersDescriptions.html" title="annotation in org.apache.ignite.mxbean">@MXBeanParametersDescriptions</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanParametersDescriptions.html#value--">value</a>="Time interval (in milliseconds) to set.") |
| void rateTimeInterval(long rateTimeInterval)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets time interval for <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getEvictionRate--"><code>getEvictionRate()</code></a> monitoring purposes. |
| <p> |
| For instance, after setting the interval to 60 seconds, subsequent calls to <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> |
| will return average allocation rate (pages per second) for the last minute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rateTimeInterval</code> - Time interval (in milliseconds) used for allocation and eviction rates calculations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="subIntervals-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>subIntervals</h4> |
| <pre><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean">@MXBeanDescription</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html#value--">value</a>="Sets a number of sub-intervals to calculate allocation and eviction rates metrics.") |
| <a href="../../../../org/apache/ignite/mxbean/MXBeanParametersNames.html" title="annotation in org.apache.ignite.mxbean">@MXBeanParametersNames</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanParametersNames.html#value--">value</a>="subInts") |
| <a href="../../../../org/apache/ignite/mxbean/MXBeanParametersDescriptions.html" title="annotation in org.apache.ignite.mxbean">@MXBeanParametersDescriptions</a>(<a href="../../../../org/apache/ignite/mxbean/MXBeanParametersDescriptions.html#value--">value</a>="Number of subintervals to set.") |
| void subIntervals(int subInts)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#rateTimeInterval-long-"><code>rateTimeInterval(long)</code></a> will be split into to calculate |
| <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getEvictionRate--"><code>getEvictionRate()</code></a> rates (5 by default). |
| <p> |
| Setting it to a bigger value will result in more precise calculation and smaller drops of |
| <a href="../../../../org/apache/ignite/mxbean/MemoryMetricsMXBean.html#getAllocationRate--"><code>getAllocationRate()</code></a> metric when next sub-interval has to be recycled but introduces bigger |
| calculation overhead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subInts</code> - A number of sub-intervals.</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="class-use/MemoryMetricsMXBean.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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/mxbean/IgnitionMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/mxbean/MXBeanDescription.html" title="annotation in org.apache.ignite.mxbean"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/mxbean/MemoryMetricsMXBean.html" target="_top">Frames</a></li> |
| <li><a href="MemoryMetricsMXBean.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 ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2018 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>: ver. <strong>2.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: July 10 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
