java.lang.Object
- org.apache.ignite.internal.processors.cache.persistence.DataRegionMetricsImpl

All Implemented Interfaces:: DataRegionMetrics

public class DataRegionMetricsImpl
extends Object
implements DataRegionMetrics

Field Summary

Fields
Modifier and Type Field Description

static String DATAREGION_METRICS_PREFIX
Data region metrics prefix.

Constructor Summary

Constructors
Constructor	Description
`DataRegionMetricsImpl(DataRegionConfiguration dataRegionCfg, GridKernalContext kernalCtx)`	Same as `DataRegionMetricsImpl(DataRegionConfiguration, GridKernalContext, DataRegionMetricsProvider)` but uses a no-op implementation for the `DataRegionMetricsProvider`.
`DataRegionMetricsImpl(DataRegionConfiguration dataRegionCfg, GridKernalContext kernalCtx, DataRegionMetricsProvider dataRegionMetricsProvider)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addThrottlingTime(long time)`
`PageMetrics`	`cacheGrpPageMetrics(int cacheGrpId)`	Returns memory page metrics associated with the given cache group.
`void`	`clear()`	Clear metrics.
`void`	`decrementDirtyPages()`	Decrements dirtyPages counter.
`void`	`decrementLargeEntriesPages()`
`void`	`decrementPagesWithTimestamp(long ts)`	Decrement count of pages with given last access time.
`void`	`disableMetrics()`	Disable metrics.
`void`	`enableMetrics()`	Enable metrics.
`float`	`getAllocationRate()`	Gets pages allocation rate of a memory region.
`long`	`getCheckpointBufferSize()`	Gets checkpoint buffer size in bytes.
`long`	`getDirtyPages()`	Gets the number of dirty pages (pages which contents is different from the current persistent storage state).
`float`	`getEvictionRate()`	Gets eviction rate of a given memory region.
`float`	`getLargeEntriesPagesPercentage()`	Gets percentage of pages that are fully occupied by large entries that go beyond page size.
`String`	`getName()`	A name of a memory region the metrics are collected for.
`long`	`getOffHeapSize()`	Total offheap size in bytes.
`long`	`getOffheapUsedSize()`	Total used offheap size in bytes.
`float`	`getPagesFillFactor()`	Returns the ratio of space occupied by user and system data to the size of all pages that contain this data.
`int`	`getPageSize()`	Gets memory page size.
`long`	`getPagesRead()`	The number of read pages from last restart.
`float`	`getPagesReplaceAge()`	Gets average age (in milliseconds) for the pages being replaced from the disk storage.
`long`	`getPagesReplaced()`	The number of replaced pages from last restart .
`float`	`getPagesReplaceRate()`	Gets rate (pages per second) at which pages get replaced with other pages from persistent storage.
`long`	`getPagesWritten()`	The number of written pages from last restart.
`long`	`getPhysicalMemoryPages()`	Gets total number of pages currently loaded to the RAM.
`long`	`getPhysicalMemorySize()`	Gets total size of pages loaded to the RAM.
`long`	`getTotalAllocatedPages()`	Gets a total number of allocated pages related to the data region.
`long`	`getTotalAllocatedSize()`	Gets a total size of memory allocated in the data region.
`long`	`getTotalUsedPages()`	Gets a total number of pages used for storing the data.
`long`	`getTotalUsedSize()`	Returns the total amount of bytes occupied by the non-empty pages.
`long`	`getUsedCheckpointBufferPages()`	Gets used checkpoint buffer size in pages.
`long`	`getUsedCheckpointBufferSize()`	Gets used checkpoint buffer size in bytes.
`void`	`incrementDirtyPages()`	Increments dirtyPages counter.
`void`	`incrementLargeEntriesPages()`
`void`	`incrementPagesWithTimestamp(long ts)`	Increment count of pages with given last access time.
`void`	`onPageRead(long nanos)`	Updates page read.
`void`	`onPageReplaced(long pageAge, long nanos)`	Updates page replacement metrics.
`void`	`onPageWritten()`	Updates page written.
`void`	`pageMemory(PageMemory pageMem)`
`PageMetrics`	`pageMetrics()`	Memory page metrics associated with the data region.
`Collection<PagesTimestampHistogramView>`	`pagesTimestampHistogramView()`	Creates pages timestamp histogram view.
`void`	`persistenceEnabled(boolean persistenceEnabled)`
`void`	`rateTimeInterval(long rateTimeInterval)`	Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
`void`	`remove()`	Removes all metric for data region.
`void`	`removeCacheGrpPageMetrics(Integer grpId)`	Removes all memory page metrics associated with the given cache group.
`void`	`resetDirtyPages()`	Resets dirtyPages counter to zero.
`void`	`subIntervals(int subInts)`	Deprecated. Use `MetricsMxBean.configureHitRateMetric(String, long)` instead.
`void`	`updateCheckpointBufferSize(long size)`
`void`	`updateEvictionRate()`	Updates eviction rate metric.
`void`	`updateOffHeapSize(long size)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATAREGION_METRICS_PREFIX
```
public static final String DATAREGION_METRICS_PREFIX
```
    Data region metrics prefix. Full name will contain DataRegionConfiguration.getName() also. "io.dataregion.default", for example.
- Constructor Detail
  - DataRegionMetricsImpl
```
@TestOnly
public DataRegionMetricsImpl(DataRegionConfiguration dataRegionCfg,
                             GridKernalContext kernalCtx)
```
    Same as DataRegionMetricsImpl(DataRegionConfiguration, GridKernalContext, DataRegionMetricsProvider) but uses a no-op implementation for the DataRegionMetricsProvider.
  - DataRegionMetricsImpl
```
public DataRegionMetricsImpl(DataRegionConfiguration dataRegionCfg,
                             GridKernalContext kernalCtx,
                             DataRegionMetricsProvider dataRegionMetricsProvider)
```
    Parameters:
    
    dataRegionCfg - DataRegionConfiguration.
    
    kernalCtx - Kernal context.
    
    dataRegionMetricsProvider - Data region metrics provider.
- Method Detail
  - getName
```
public String getName()
```
    A name of a memory region the metrics are collected for.
    
    Specified by:
    
    getName in interface DataRegionMetrics
    
    Returns:
    
    Name of the memory region.
  - getTotalAllocatedPages
```
public long getTotalAllocatedPages()
```
    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.
  - getTotalAllocatedSize
```
public long getTotalAllocatedSize()
```
    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.
  - getTotalUsedPages
```
public long getTotalUsedPages()
```
    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.
  - getTotalUsedSize
```
public long getTotalUsedSize()
```
    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
```
public float getAllocationRate()
```
    Gets pages allocation rate of a memory region.
    
    Specified by:
    
    getAllocationRate in interface DataRegionMetrics
    
    Returns:
    
    Number of allocated pages per second.
  - getEvictionRate
```
public float getEvictionRate()
```
    Gets eviction rate of a given memory region.
    
    Specified by:
    
    getEvictionRate in interface DataRegionMetrics
    
    Returns:
    
    Number of evicted pages per second.
  - getLargeEntriesPagesPercentage
```
public float getLargeEntriesPagesPercentage()
```
    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
```
public float getPagesFillFactor()
```
    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 ant data.
  - getDirtyPages
```
public long getDirtyPages()
```
    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
```
public float getPagesReplaceRate()
```
    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
```
public float getPagesReplaceAge()
```
    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
```
public long getPhysicalMemoryPages()
```
    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.
  - getPhysicalMemorySize
```
public long getPhysicalMemorySize()
```
    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
```
public long getUsedCheckpointBufferPages()
```
    Gets used checkpoint buffer size in pages.
    
    Specified by:
    
    getUsedCheckpointBufferPages in interface DataRegionMetrics
    
    Returns:
    
    Checkpoint buffer size in pages.
  - getUsedCheckpointBufferSize
```
public long getUsedCheckpointBufferSize()
```
    Gets used checkpoint buffer size in bytes.
    
    Specified by:
    
    getUsedCheckpointBufferSize in interface DataRegionMetrics
    
    Returns:
    
    Checkpoint buffer size in bytes.
  - getCheckpointBufferSize
```
public long getCheckpointBufferSize()
```
    Gets checkpoint buffer size in bytes.
    
    Specified by:
    
    getCheckpointBufferSize in interface DataRegionMetrics
    
    Returns:
    
    Checkpoint buffer size in bytes.
  - getPageSize
```
public int getPageSize()
```
    Gets memory page size.
    
    Specified by:
    
    getPageSize in interface DataRegionMetrics
    
    Returns:
    
    Page size in bytes.
  - getPagesRead
```
public long getPagesRead()
```
    The number of read pages from last restart.
    
    Specified by:
    
    getPagesRead in interface DataRegionMetrics
    
    Returns:
    
    The number of read pages from last restart.
  - getPagesWritten
```
public long getPagesWritten()
```
    The number of written pages from last restart.
    
    Specified by:
    
    getPagesWritten in interface DataRegionMetrics
    
    Returns:
    
    The number of written pages from last restart.
  - getPagesReplaced
```
public long getPagesReplaced()
```
    The number of replaced pages from last restart .
    
    Specified by:
    
    getPagesReplaced in interface DataRegionMetrics
    
    Returns:
    
    The number of replaced pages from last restart .
  - getOffHeapSize
```
public long getOffHeapSize()
```
    Total offheap size in bytes.
    
    Specified by:
    
    getOffHeapSize in interface DataRegionMetrics
    
    Returns:
    
    Total offheap size in bytes.
  - getOffheapUsedSize
```
public long getOffheapUsedSize()
```
    Total used offheap size in bytes.
    
    Specified by:
    
    getOffheapUsedSize in interface DataRegionMetrics
    
    Returns:
    
    Total used offheap size in bytes.
  - updateOffHeapSize
```
public void updateOffHeapSize(long size)
```
    Parameters:
    
    size - Region size.
  - updateCheckpointBufferSize
```
public void updateCheckpointBufferSize(long size)
```
    Parameters:
    
    size - Checkpoint buffer size.
  - pageMetrics
```
public PageMetrics pageMetrics()
```
    Memory page metrics associated with the data region.
  - onPageReplaced
```
public void onPageReplaced(long pageAge,
                           long nanos)
```
    Updates page replacement metrics.
  - onPageRead
```
public void onPageRead(long nanos)
```
    Updates page read.
    
    Parameters:
    
    nanos - Time consumed by page reading.
  - onPageWritten
```
public void onPageWritten()
```
    Updates page written.
  - incrementDirtyPages
```
public void incrementDirtyPages()
```
    Increments dirtyPages counter.
  - decrementDirtyPages
```
public void decrementDirtyPages()
```
    Decrements dirtyPages counter.
  - resetDirtyPages
```
public void resetDirtyPages()
```
    Resets dirtyPages counter to zero.
  - cacheGrpPageMetrics
```
public PageMetrics cacheGrpPageMetrics(int cacheGrpId)
```
    Returns memory page metrics associated with the given cache group.
  - removeCacheGrpPageMetrics
```
public void removeCacheGrpPageMetrics(Integer grpId)
```
    Removes all memory page metrics associated with the given cache group.
  - updateEvictionRate
```
public void updateEvictionRate()
```
    Updates eviction rate metric.
  - incrementLargeEntriesPages
```
public void incrementLargeEntriesPages()
```
  - decrementLargeEntriesPages
```
public void decrementLargeEntriesPages()
```
  - enableMetrics
```
public void enableMetrics()
```
    Enable metrics.
  - disableMetrics
```
public void disableMetrics()
```
    Disable metrics.
  - persistenceEnabled
```
public void persistenceEnabled(boolean persistenceEnabled)
```
    Parameters:
    
    persistenceEnabled - Persistence enabled.
  - pageMemory
```
public void pageMemory(PageMemory pageMem)
```
    Parameters:
    
    pageMem - Page mem.
  - rateTimeInterval
```
@Deprecated
public void rateTimeInterval(long rateTimeInterval)
```
    Deprecated.
    Use MetricsMxBean.configureHitRateMetric(String, long) instead.
    
    Parameters:
    
    rateTimeInterval - Time interval (in milliseconds) used to calculate allocation/eviction rate.
  - subIntervals
```
@Deprecated
public void subIntervals(int subInts)
```
    Deprecated.
    Use MetricsMxBean.configureHitRateMetric(String, long) instead.
    
    Sets number of subintervals the whole rateTimeInterval will be split into to calculate allocation rate.
    
    Parameters:
    
    subInts - Number of subintervals.
  - clear
```
public void clear()
```
    Clear metrics.
  - remove
```
public void remove()
```
    Removes all metric for data region.
  - addThrottlingTime
```
public void addThrottlingTime(long time)
```
    Parameters:
    
    time - Time to add to totalThrottlingTime metric in milliseconds.
  - incrementPagesWithTimestamp
```
public void incrementPagesWithTimestamp(long ts)
```
    Increment count of pages with given last access time.
    
    Parameters:
    
    ts - Last access timestamp.
  - decrementPagesWithTimestamp
```
public void decrementPagesWithTimestamp(long ts)
```
    Decrement count of pages with given last access time.
    
    Parameters:
    
    ts - Last access timestamp.
  - pagesTimestampHistogramView
```
public Collection<PagesTimestampHistogramView> pagesTimestampHistogramView()
```
    Creates pages timestamp histogram view.

Class DataRegionMetricsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATAREGION_METRICS_PREFIX

Constructor Detail

DataRegionMetricsImpl

DataRegionMetricsImpl

Method Detail

getName

getTotalAllocatedPages

getTotalAllocatedSize

getTotalUsedPages

getTotalUsedSize

getAllocationRate

getEvictionRate

getLargeEntriesPagesPercentage

getPagesFillFactor

getDirtyPages

getPagesReplaceRate

getPagesReplaceAge

getPhysicalMemoryPages

getPhysicalMemorySize

getUsedCheckpointBufferPages

getUsedCheckpointBufferSize

getCheckpointBufferSize

getPageSize

getPagesRead

getPagesWritten

getPagesReplaced

getOffHeapSize

getOffheapUsedSize

updateOffHeapSize

updateCheckpointBufferSize

pageMetrics

onPageReplaced

onPageRead

onPageWritten

incrementDirtyPages

decrementDirtyPages

resetDirtyPages

cacheGrpPageMetrics

removeCacheGrpPageMetrics

updateEvictionRate

incrementLargeEntriesPages

decrementLargeEntriesPages

enableMetrics

disableMetrics

persistenceEnabled

pageMemory

rateTimeInterval

subIntervals

clear

remove

addThrottlingTime

incrementPagesWithTimestamp

decrementPagesWithTimestamp

pagesTimestampHistogramView