org.apache.ignite.mxbean

Interface DataRegionMetricsMXBean

All Superinterfaces:

DataRegionMetrics

Deprecated.

Use GridMetricManager instead.

@Deprecated
 @MXBeanDescription(value="MBean that provides access to DataRegionMetrics of a local Apache Ignite node.")
public interface DataRegionMetricsMXBean
extends DataRegionMetrics

This interface defines a JMX view on DataRegionMetrics.

Method Summary

Modifier and Type	Method and Description
void	disableMetrics() Deprecated. Disables memory metrics collection on an Apache Ignite node.
void	enableMetrics() Deprecated. Enables memory metrics collection on an Apache Ignite node.
float	getAllocationRate() Deprecated. Gets pages allocation rate of a memory region.
long	getCheckpointBufferSize() Deprecated. Gets checkpoint buffer size in bytes.
long	getDirtyPages() Deprecated. Gets the number of dirty pages (pages which contents is different from the current persistent storage state).
float	getEvictionRate() Deprecated. Gets eviction rate of a given memory region.
int	getInitialSize() Deprecated. Gets initial memory region size defined by its DataRegionConfiguration.
float	getLargeEntriesPagesPercentage() Deprecated. Gets percentage of pages that are fully occupied by large entries that go beyond page size.
int	getMaxSize() Deprecated. Maximum memory region size defined by its DataRegionConfiguration.
String	getName() Deprecated. A name of a memory region the metrics are collected for.
long	getOffHeapSize() Deprecated. Total offheap size in bytes.
long	getOffheapUsedSize() Deprecated. Total used offheap size in bytes.
float	getPagesFillFactor() Deprecated. Returns the ratio of space occupied by user and system data to the size of all pages that contain this data.
int	getPageSize() Deprecated. Gets memory page size.
long	getPagesRead() Deprecated. The number of read pages from last restart.
float	getPagesReplaceAge() Deprecated. Gets average age (in milliseconds) for the pages being replaced from the disk storage.
long	getPagesReplaced() Deprecated. The number of replaced pages from last restart .
float	getPagesReplaceRate() Deprecated. Gets rate (pages per second) at which pages get replaced with other pages from persistent storage.
long	getPagesWritten() Deprecated. The number of written pages from last restart.
long	getPhysicalMemoryPages() Deprecated. Gets total number of pages currently loaded to the RAM.
long	getPhysicalMemorySize() Deprecated. Gets total size of pages loaded to the RAM.
String	getSwapPath() Deprecated. A path to the memory-mapped files the memory region defined by DataRegionConfiguration will be mapped to.
long	getTotalAllocatedPages() Deprecated. Gets a total number of allocated pages related to the data region.
long	getTotalAllocatedSize() Deprecated. Gets a total size of memory allocated in the data region.
long	getTotalUsedPages() Deprecated. Gets a total number of pages used for storing the data.
long	getTotalUsedSize() Deprecated. Returns the total amount of bytes occupied by the non-empty pages.
long	getUsedCheckpointBufferPages() Deprecated. Gets used checkpoint buffer size in pages.
long	getUsedCheckpointBufferSize() Deprecated. Gets used checkpoint buffer size in bytes.
void	rateTimeInterval(long rateTimeInterval) Deprecated. Use MetricsMxBean.configureHitRateMetric(String, long) instead.
void	subIntervals(int subInts) Deprecated. Use MetricsMxBean.configureHitRateMetric(String, long) instead.

Method Detail

getName

@MXBeanDescription(value="A name of a memory region the metrics are collected for.")
String getName()

Deprecated.

A name of a memory region the metrics are collected for.

Specified by:

getName in interface DataRegionMetrics

Returns:

Name of the memory region.

getInitialSize

@MXBeanDescription(value="Initial memory region size defined by its data region.")
int getInitialSize()

Deprecated.

Gets initial memory region size defined by its DataRegionConfiguration.

Returns:

Initial size in MB.

getMaxSize

@MXBeanDescription(value="Maximum memory region size defined by its data region.")
int getMaxSize()

Deprecated.

Maximum memory region size defined by its DataRegionConfiguration.

Returns:

Maximum size in MB.

getSwapPath

@MXBeanDescription(value="Path to the memory-mapped files.")
String getSwapPath()

Deprecated.

A path to the memory-mapped files the memory region defined by DataRegionConfiguration will be mapped to.

Returns:

Path to the memory-mapped files.

getTotalAllocatedPages

@MXBeanDescription(value="Total number of allocated pages.")
long getTotalAllocatedPages()

Deprecated.

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.

Specified by:

getTotalAllocatedPages in interface DataRegionMetrics

Returns:

Total number of allocated pages.

getTotalUsedPages

@MXBeanDescription(value="Total number of used pages.")
long getTotalUsedPages()

Deprecated.

Gets a total number of pages used for storing the data. It includes allocated pages except of empty pages that are not used yet or pages that can be reused.

E. g. data region contains 1000 allocated pages, and 200 pages are used to store some data, this metric shows 200 used pages. Then the data was partially deleted and 50 pages were totally freed, hence this metric should show 150 used pages.

Specified by:

getTotalUsedPages in interface DataRegionMetrics

Returns:

Total number of used pages.

getTotalAllocatedSize

@MXBeanDescription(value="Total size of allocated pages in bytes.")
long getTotalAllocatedSize()

Deprecated.

Gets a total size of memory allocated in the data region. When persistence is disabled, this metric shows the total size of pages in memory. When persistence is enabled, this metric shows the total size of pages in memory and on disk.

Specified by:

getTotalAllocatedSize in interface DataRegionMetrics

Returns:

Total size of memory allocated, in bytes.

getTotalUsedSize

@MXBeanDescription(value="Total size of used pages in bytes.")
long getTotalUsedSize()

Deprecated.

Returns the total amount of bytes occupied by the non-empty pages. This value is directly tied to the DataRegionMetrics.getTotalUsedPages() and does not take page fragmentation into account (i.e. if some data is removed from a page, but it is not completely empty, it will still show the whole page bytes as being occupied).

Specified by:

getTotalUsedSize in interface DataRegionMetrics

Returns:

Total amount of bytes occupied by the non-empty pages

getAllocationRate

@MXBeanDescription(value="Allocation rate (pages per second) averaged across rateTimeInternal.")
float getAllocationRate()

Deprecated.

Gets pages allocation rate of a memory region.

Specified by:

getAllocationRate in interface DataRegionMetrics

Returns:

Number of allocated pages per second.

getEvictionRate

@MXBeanDescription(value="Eviction rate (pages per second).")
float getEvictionRate()

Deprecated.

Gets eviction rate of a given memory region.

Specified by:

getEvictionRate in interface DataRegionMetrics

Returns:

Number of evicted pages per second.

getLargeEntriesPagesPercentage

@MXBeanDescription(value="Percentage of pages that are fully occupied by large entries that go beyond page size.")
float getLargeEntriesPagesPercentage()

Deprecated.

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.

Specified by:

getLargeEntriesPagesPercentage in interface DataRegionMetrics

Returns:

Percentage of pages fully occupied by large entities.

getPagesFillFactor

@MXBeanDescription(value="The percentage of the used space.")
float getPagesFillFactor()

Deprecated.

Returns the ratio of space occupied by user and system data to the size of all pages that contain this data.

This metric can help to determine how much space of a data page is occupied on average. Low fill factor can indicate that data pages are very fragmented (i.e. there is a lot of empty space across all data pages).

Specified by:

getPagesFillFactor in interface DataRegionMetrics

Returns:

Ratio of space occupied by user and system data to the size of all pages that contain this data.

getDirtyPages

@MXBeanDescription(value="Number of pages in memory not yet synchronized with persistent storage.")
long getDirtyPages()

Deprecated.

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.

Specified by:

getDirtyPages in interface DataRegionMetrics

Returns:

Current number of dirty pages.

getPagesReplaceRate

@MXBeanDescription(value="Rate at which pages in memory are replaced with pages from persistent storage (pages per second).")
float getPagesReplaceRate()

Deprecated.

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.

Specified by:

getPagesReplaceRate in interface DataRegionMetrics

Returns:

Pages per second replace rate.

getPagesReplaceAge

@MXBeanDescription(value="Average age at which pages in memory are replaced with pages from persistent storage (milliseconds).")
float getPagesReplaceAge()

Deprecated.

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.

Specified by:

getPagesReplaceAge in interface DataRegionMetrics

Returns:

Replaced pages age in milliseconds.

getPhysicalMemoryPages

@MXBeanDescription(value="Number of pages residing in physical RAM.")
long getPhysicalMemoryPages()

Deprecated.

Gets total number of pages currently loaded to the RAM. When persistence is disabled, this metric is equal to DataRegionMetrics.getTotalAllocatedPages().

Specified by:

getPhysicalMemoryPages in interface DataRegionMetrics

Returns:

Total number of pages loaded to RAM.

getPagesRead

@MXBeanDescription(value="Number of pages read from last restart.")
long getPagesRead()

Deprecated.

The number of read pages from last restart.

Specified by:

getPagesRead in interface DataRegionMetrics

Returns:

The number of read pages from last restart.

getPagesWritten

@MXBeanDescription(value="Number of pages written from last restart.")
long getPagesWritten()

Deprecated.

The number of written pages from last restart.

Specified by:

getPagesWritten in interface DataRegionMetrics

Returns:

The number of written pages from last restart.

getPagesReplaced

@MXBeanDescription(value="Number of pages replaced from last restart.")
long getPagesReplaced()

Deprecated.

The number of replaced pages from last restart .

Specified by:

getPagesReplaced in interface DataRegionMetrics

Returns:

The number of replaced pages from last restart .

getOffHeapSize

@MXBeanDescription(value="Offheap size in bytes.")
long getOffHeapSize()

Deprecated.

Total offheap size in bytes.

Specified by:

getOffHeapSize in interface DataRegionMetrics

Returns:

Total offheap size in bytes.

getOffheapUsedSize

@MXBeanDescription(value="Offheap used size in bytes.")
long getOffheapUsedSize()

Deprecated.

Total used offheap size in bytes.

Specified by:

getOffheapUsedSize in interface DataRegionMetrics

Returns:

Total used offheap size in bytes.

getPageSize

@MXBeanDescription(value="The size of the memory page in bytes.")
int getPageSize()

Deprecated.

Gets memory page size.

Specified by:

getPageSize in interface DataRegionMetrics

Returns:

Page size in bytes.

getPhysicalMemorySize

@MXBeanDescription(value="The total size of pages loaded to the RAM. When persistence is disabled, this metric is equal to TotalAllocatedSize.")
long getPhysicalMemorySize()

Deprecated.

Gets total size of pages loaded to the RAM. When persistence is disabled, this metric is equal to DataRegionMetrics.getTotalAllocatedSize().

Specified by:

getPhysicalMemorySize in interface DataRegionMetrics

Returns:

Total size of pages loaded to RAM in bytes.

getUsedCheckpointBufferPages

@MXBeanDescription(value="The used checkpoint buffer size in pages.")
long getUsedCheckpointBufferPages()

Deprecated.

Gets used checkpoint buffer size in pages.

Specified by:

getUsedCheckpointBufferPages in interface DataRegionMetrics

Returns:

Checkpoint buffer size in pages.

getUsedCheckpointBufferSize

@MXBeanDescription(value="The used checkpoint buffer size in bytes.")
long getUsedCheckpointBufferSize()

Deprecated.

Gets used checkpoint buffer size in bytes.

Specified by:

getUsedCheckpointBufferSize in interface DataRegionMetrics

Returns:

Checkpoint buffer size in bytes.

getCheckpointBufferSize

@MXBeanDescription(value="The checkpoint buffer size in bytes.")
long getCheckpointBufferSize()

Deprecated.

Gets checkpoint buffer size in bytes.

Specified by:

getCheckpointBufferSize in interface DataRegionMetrics

Returns:

Checkpoint buffer size in bytes.

enableMetrics

@MXBeanDescription(value="Enables memory metrics collection on an Apache Ignite node.")
void enableMetrics()

Deprecated.

Enables memory metrics collection on an Apache Ignite node.

disableMetrics

@MXBeanDescription(value="Disables memory metrics collection on an Apache Ignite node.")
void disableMetrics()

Deprecated.

Disables memory metrics collection on an Apache Ignite node.

rateTimeInterval

@MXBeanDescription(value="Sets time interval for pages allocation and eviction monitoring purposes.")
 @Deprecated
void rateTimeInterval(@MXBeanParameter(name="rateTimeInterval",description="Time interval (in milliseconds) to set.")
                                                                                                                                         long rateTimeInterval)

Deprecated. Use MetricsMxBean.configureHitRateMetric(String, long) instead.

Sets time interval for getAllocationRate() and getEvictionRate() monitoring purposes.

For instance, after setting the interval to 60 seconds, subsequent calls to getAllocationRate() will return average allocation rate (pages per second) for the last minute.

Parameters:

rateTimeInterval - Time interval (in milliseconds) used for allocation and eviction rates calculations.

subIntervals

@MXBeanDescription(value="Sets a number of sub-intervals to calculate allocation and eviction rates metrics.")
 @Deprecated
void subIntervals(@MXBeanParameter(name="subInts",description="Number of subintervals to set.")
                                                                                                                                              int subInts)

Deprecated. Use MetricsMxBean.configureHitRateMetric(String, long) instead.

Sets a number of sub-intervals the whole rateTimeInterval(long) will be split into to calculate getAllocationRate() and getEvictionRate() rates (5 by default).

Setting it to a bigger value will result in more precise calculation and smaller drops of getAllocationRate() metric when next sub-interval has to be recycled but introduces bigger calculation overhead.

Parameters:

subInts - A number of sub-intervals.