Google Git
Sign in
apache / ignite-website / f579a33a1d55a1fec469fbc3a56fc44b2fdd04cd / . / build / releases / 2.3.0 / javadoc / org / apache / ignite / mxbean / DataRegionMetricsMXBean.html
blob: 0e740ce7c7630ba6144789e5653ed41440a595a1 [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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.3.0/javadoc/org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<!-- Generated by javadoc (version 1.7.0_80) on Sat Oct 28 06:25:54 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataRegionMetricsMXBean (Ignite 2.3.0)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<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"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataRegionMetricsMXBean (Ignite 2.3.0)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/DataRegionMetricsMXBean.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"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/mxbean/ClusterLocalNodeMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/mxbean/DataStorageMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" target="_top">Frames</a></li>
<li><a href="DataRegionMetricsMXBean.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 DataRegionMetricsMXBean" class="title">Interface DataRegionMetricsMXBean</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/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></dd>
</dl>
<hr>
<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 DataRegionMetrics of a local Apache Ignite node.")
public interface <span class="strong">DataRegionMetricsMXBean</span>
extends <a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></pre>
<div class="block">This interface defines a JMX view on <a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite"><code>DataRegionMetrics</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</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>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#disableMetrics()">disableMetrics</a></strong>()</code>
<div class="block">Disables memory metrics collection on an Apache Ignite node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#enableMetrics()">enableMetrics</a></strong>()</code>
<div class="block">Enables memory metrics collection on an Apache Ignite node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getAllocationRate()">getAllocationRate</a></strong>()</code>
<div class="block">Gets pages allocation rate of a memory region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getDirtyPages()">getDirtyPages</a></strong>()</code>
<div class="block">Gets the number of dirty pages (pages which contents is different from the current persistent storage state).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getEvictionRate()">getEvictionRate</a></strong>()</code>
<div class="block">Gets eviction rate of a given memory region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getInitialSize()">getInitialSize</a></strong>()</code>
<div class="block">Gets initial memory region size defined by its <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getLargeEntriesPagesPercentage()">getLargeEntriesPagesPercentage</a></strong>()</code>
<div class="block">Gets percentage of pages that are fully occupied by large entries that go beyond page size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getMaxSize()">getMaxSize</a></strong>()</code>
<div class="block">Maximum memory region size defined by its <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getName()">getName</a></strong>()</code>
<div class="block">A name of a memory region the metrics are collected for.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesFillFactor()">getPagesFillFactor</a></strong>()</code>
<div class="block">Gets the percentage of space that is still free and can be filled in.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesReplaceRate()">getPagesReplaceRate</a></strong>()</code>
<div class="block">Gets rate (pages per second) at which pages get replaced with other pages from persistent storage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPhysicalMemoryPages()">getPhysicalMemoryPages</a></strong>()</code>
<div class="block">Gets total number of pages currently loaded to the RAM.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getSwapPath()">getSwapPath</a></strong>()</code>
<div class="block">A path to the memory-mapped files the memory region defined by <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a> will be
mapped to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getTotalAllocatedPages()">getTotalAllocatedPages</a></strong>()</code>
<div class="block">Gets a total number of allocated pages related to the data region.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#rateTimeInterval(long)">rateTimeInterval</a></strong>(long&nbsp;rateTimeInterval)</code>
<div class="block">Sets time interval for <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getAllocationRate()"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getEvictionRate()"><code>getEvictionRate()</code></a> monitoring purposes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#subIntervals(int)">subIntervals</a></strong>(int&nbsp;subInts)</code>
<div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#rateTimeInterval(long)"><code>rateTimeInterval(long)</code></a> will be split into to calculate
<a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getAllocationRate()"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">A name of a memory region the metrics are collected for.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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 data region.")
int&nbsp;getInitialSize()</pre>
<div class="block">Gets initial memory region size defined by its <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a>.</div>
<dl><dt><span class="strong">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 data region.")
int&nbsp;getMaxSize()</pre>
<div class="block">Maximum memory region size defined by its <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Maximum size in MB.</dd></dl>
</li>
</ul>
<a name="getSwapPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSwapPath</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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSwapPath()</pre>
<div class="block">A path to the memory-mapped files the memory region defined by <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a> will be
mapped to.</div>
<dl><dt><span class="strong">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&nbsp;getTotalAllocatedPages()</pre>
<div class="block">Gets a total number of allocated pages related to the data region. 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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getTotalAllocatedPages()">getTotalAllocatedPages</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getAllocationRate()</pre>
<div class="block">Gets pages allocation rate of a memory region.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getAllocationRate()">getAllocationRate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getEvictionRate()</pre>
<div class="block">Gets eviction rate of a given memory region.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getEvictionRate()">getEvictionRate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getLargeEntriesPagesPercentage()</pre>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getLargeEntriesPagesPercentage()">getLargeEntriesPagesPercentage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getPagesFillFactor()</pre>
<div class="block">Gets the percentage of space that is still free and can be filled in.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPagesFillFactor()">getPagesFillFactor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getDirtyPages()</pre>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getDirtyPages()">getDirtyPages</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getPagesReplaceRate()</pre>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPagesReplaceRate()">getPagesReplaceRate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;getPhysicalMemoryPages()</pre>
<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/DataRegionMetrics.html#getTotalAllocatedPages()"><code>DataRegionMetrics.getTotalAllocatedPages()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPhysicalMemoryPages()">getPhysicalMemoryPages</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></code></dd>
<dt><span class="strong">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&nbsp;enableMetrics()</pre>
<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&nbsp;disableMetrics()</pre>
<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&nbsp;rateTimeInterval(long&nbsp;rateTimeInterval)</pre>
<div class="block">Sets time interval for <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getAllocationRate()"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.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/DataRegionMetricsMXBean.html#getAllocationRate()"><code>getAllocationRate()</code></a>
will return average allocation rate (pages per second) for the last minute.</div>
<dl><dt><span class="strong">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&nbsp;subIntervals(int&nbsp;subInts)</pre>
<div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#rateTimeInterval(long)"><code>rateTimeInterval(long)</code></a> will be split into to calculate
<a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getAllocationRate()"><code>getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.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/DataRegionMetricsMXBean.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="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/DataRegionMetricsMXBean.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"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/mxbean/ClusterLocalNodeMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/mxbean/DataStorageMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" target="_top">Frames</a></li>
<li><a href="DataRegionMetricsMXBean.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>2017 Copyright &#169; 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>:&nbsp;&nbsp; ver. <strong>2.3.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; October 28 2017 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>