blob: 4267e04eafd9c78169700c5648a48901c4b0ee98 [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.6.0/javadoc/org/apache/ignite/mxbean/DataRegionMetricsMXBean.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>DataRegionMetricsMXBean (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="DataRegionMetricsMXBean (Ignite 2.6.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":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="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">Ignite - In-Memory Data Fabric</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/mxbean/ClusterMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/mxbean/DataStorageMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Next&nbsp;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&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>
<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="typeNameLabel">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="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/DataRegionMetricsMXBean.html#disableMetrics--">disableMetrics</a></span>()</code>
<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/DataRegionMetricsMXBean.html#enableMetrics--">enableMetrics</a></span>()</code>
<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/DataRegionMetricsMXBean.html#getAllocationRate--">getAllocationRate</a></span>()</code>
<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/DataRegionMetricsMXBean.html#getDirtyPages--">getDirtyPages</a></span>()</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 id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getEvictionRate--">getEvictionRate</a></span>()</code>
<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/DataRegionMetricsMXBean.html#getInitialSize--">getInitialSize</a></span>()</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 id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getLargeEntriesPagesPercentage--">getLargeEntriesPagesPercentage</a></span>()</code>
<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/DataRegionMetricsMXBean.html#getMaxSize--">getMaxSize</a></span>()</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 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/DataRegionMetricsMXBean.html#getName--">getName</a></span>()</code>
<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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getOffHeapSize--">getOffHeapSize</a></span>()</code>
<div class="block">Total offheap size in bytes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getOffheapUsedSize--">getOffheapUsedSize</a></span>()</code>
<div class="block">Total used offheap size in bytes.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesFillFactor--">getPagesFillFactor</a></span>()</code>
<div class="block">Gets the percentage of the used space.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesRead--">getPagesRead</a></span>()</code>
<div class="block">The number of read pages from last restart.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesReplaceAge--">getPagesReplaceAge</a></span>()</code>
<div class="block">Gets average age (in milliseconds) for the pages being replaced from the disk storage.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesReplaced--">getPagesReplaced</a></span>()</code>
<div class="block">The number of replaced pages from last restart .</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesReplaceRate--">getPagesReplaceRate</a></span>()</code>
<div class="block">Gets rate (pages per second) at which pages get replaced with other pages from persistent storage.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPagesWritten--">getPagesWritten</a></span>()</code>
<div class="block">The number of written pages from last restart.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getPhysicalMemoryPages--">getPhysicalMemoryPages</a></span>()</code>
<div class="block">Gets total number of pages currently loaded to the RAM.</div>
</td>
</tr>
<tr id="i18" 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/DataRegionMetricsMXBean.html#getSwapPath--">getSwapPath</a></span>()</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 id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#getTotalAllocatedPages--">getTotalAllocatedPages</a></span>()</code>
<div class="block">Gets a total number of allocated pages related to the data region.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#rateTimeInterval-long-">rateTimeInterval</a></span>(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 id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html#subIntervals-int-">subIntervals</a></span>(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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.DataRegionMetrics">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.<a href="../../../../org/apache/ignite/DataRegionMetrics.html" title="interface in org.apache.ignite">DataRegionMetrics</a></h3>
<code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getCheckpointBufferPages--">getCheckpointBufferPages</a>, <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getCheckpointBufferSize--">getCheckpointBufferSize</a>, <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPageSize--">getPageSize</a>, <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPhysicalMemorySize--">getPhysicalMemorySize</a>, <a href="../../../../org/apache/ignite/DataRegionMetrics.html#getTotalAllocatedSize--">getTotalAllocatedSize</a></code></li>
</ul>
</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>&nbsp;getName()</pre>
<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/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="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 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="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 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="returnLabel">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/8/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="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&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><span class="overrideSpecifyLabel">Specified by:</span></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="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&nbsp;getAllocationRate()</pre>
<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/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="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&nbsp;getEvictionRate()</pre>
<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/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="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&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><span class="overrideSpecifyLabel">Specified by:</span></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="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>="The percentage of the used space.")
float&nbsp;getPagesFillFactor()</pre>
<div class="block">Gets the percentage of the used space.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">Returns:</span></dt>
<dd>The percentage of the used space.</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><span class="overrideSpecifyLabel">Specified by:</span></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="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&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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">Returns:</span></dt>
<dd>Pages per second replace rate.</dd>
</dl>
</li>
</ul>
<a name="getPagesReplaceAge--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagesReplaceAge</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>="Average age at which pages in memory are replaced with pages from persistent storage (milliseconds).")
float&nbsp;getPagesReplaceAge()</pre>
<div class="block">Gets average age (in milliseconds) for the pages being replaced from the disk storage.
This number effectively represents the average time between the moment when a page is read
from the disk and the time when the page is evicted. Note that if a page is never evicted, it does
not contribute to this metric.
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/DataRegionMetrics.html#getPagesReplaceAge--">getPagesReplaceAge</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="returnLabel">Returns:</span></dt>
<dd>Replaced pages age in milliseconds.</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><span class="overrideSpecifyLabel">Specified by:</span></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="returnLabel">Returns:</span></dt>
<dd>Total number of pages loaded to RAM.</dd>
</dl>
</li>
</ul>
<a name="getPagesRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagesRead</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 read from last restart.")
long&nbsp;getPagesRead()</pre>
<div class="block">The number of read pages from last restart.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPagesRead--">getPagesRead</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="returnLabel">Returns:</span></dt>
<dd>The number of read pages from last restart.</dd>
</dl>
</li>
</ul>
<a name="getPagesWritten--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagesWritten</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 written from last restart.")
long&nbsp;getPagesWritten()</pre>
<div class="block">The number of written pages from last restart.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPagesWritten--">getPagesWritten</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="returnLabel">Returns:</span></dt>
<dd>The number of written pages from last restart.</dd>
</dl>
</li>
</ul>
<a name="getPagesReplaced--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPagesReplaced</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 replaced from last restart.")
long&nbsp;getPagesReplaced()</pre>
<div class="block">The number of replaced pages from last restart .</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getPagesReplaced--">getPagesReplaced</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="returnLabel">Returns:</span></dt>
<dd>The number of replaced pages from last restart .</dd>
</dl>
</li>
</ul>
<a name="getOffHeapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffHeapSize</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>="Offheap size in bytes.")
long&nbsp;getOffHeapSize()</pre>
<div class="block">Total offheap size in bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getOffHeapSize--">getOffHeapSize</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="returnLabel">Returns:</span></dt>
<dd>Total offheap size in bytes.</dd>
</dl>
</li>
</ul>
<a name="getOffheapUsedSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffheapUsedSize</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>="Offheap used size in bytes.")
long&nbsp;getOffheapUsedSize()</pre>
<div class="block">Total used offheap size in bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/DataRegionMetrics.html#getOffheapUsedSize--">getOffheapUsedSize</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="returnLabel">Returns:</span></dt>
<dd>Total used offheap size in bytes.</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="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&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="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/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">Ignite - In-Memory Data Fabric</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/mxbean/ClusterMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/mxbean/DataStorageMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><span class="typeNameLink">Next&nbsp;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&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>
<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>2018 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.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; July 10 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>