DataStorageMetrics (Ignite 2.8.0)

All Known Subinterfaces:

DataStorageMetricsMXBean

All Known Implementing Classes:

DataStorageMetricsImpl, DataStorageMetricsSnapshot
```
public interface DataStorageMetrics
```
Data storage metrics are used to obtain statistics on persistent store and whole data storage.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getCheckpointBufferSize()` Checkpoint buffer size in bytes.
`long`	`getCheckpointTotalTime()` Total checkpoint time from last restart.
`long`	`getDirtyPages()` Total dirty pages for the next checkpoint.
`long`	`getLastCheckpointCopiedOnWritePagesNumber()` Gets the number of pages copied to a temporary checkpoint buffer during the last checkpoint.
`long`	`getLastCheckpointDataPagesNumber()` Gets the number of data pages written during the last checkpoint.
`long`	`getLastCheckpointDuration()` Gets the duration of the last checkpoint in milliseconds.
`long`	`getLastCheckpointFsyncDuration()` Gets the duration of the sync phase of the last checkpoint in milliseconds.
`long`	`getLastCheckpointLockWaitDuration()` Gets the duration of last checkpoint lock wait in milliseconds.
`long`	`getLastCheckpointMarkDuration()` Gets the duration of last checkpoint mark phase in milliseconds.
`long`	`getLastCheckpointPagesWriteDuration()` Gets the duration of last checkpoint pages write phase in milliseconds.
`long`	`getLastCheckpointTotalPagesNumber()` Gets the total number of pages written during the last checkpoint.
`long`	`getOffHeapSize()` Total offheap size in bytes.
`long`	`getOffheapUsedSize()` Total used offheap size in bytes.
`long`	`getPagesRead()` The number of read pages from last restart.
`long`	`getPagesReplaced()` The number of replaced pages from last restart.
`long`	`getPagesWritten()` The number of written pages from last restart.
`long`	`getSparseStorageSize()` Storage space allocated adjusted for possible sparsity in bytes.
`long`	`getStorageSize()` Storage space allocated in bytes.
`long`	`getTotalAllocatedSize()` Total size of memory allocated in bytes.
`long`	`getUsedCheckpointBufferPages()` Gets used checkpoint buffer size in pages.
`long`	`getUsedCheckpointBufferSize()` Gets used checkpoint buffer size in bytes.
`int`	`getWalArchiveSegments()` Gets the current number of WAL segments in the WAL archive.
`long`	`getWalBuffPollSpinsRate()` Returns WAL buffer poll spins number over the last time interval.
`float`	`getWalFsyncTimeAverage()` Gets the average WAL fsync duration in microseconds over the last time interval.
`long`	`getWalLastRollOverTime()` Time of the last WAL segment rollover.
`float`	`getWalLoggingRate()` Gets the average number of WAL records per second written during the last time interval.
`long`	`getWalTotalSize()` Total size in bytes for storage wal files.
`float`	`getWalWritingRate()` Gets the average number of bytes per second written during the last time interval.

- Method Detail
  - getWalLoggingRate
```
float getWalLoggingRate()
```
    Gets the average number of WAL records per second written during the last time interval.
    The length of time interval is configured via DataStorageConfiguration.setMetricsRateTimeInterval(long) configuration property. The number of subintervals is configured via DataStorageConfiguration.setMetricsSubIntervalCount(int) configuration property.
  - getWalWritingRate
```
float getWalWritingRate()
```
    Gets the average number of bytes per second written during the last time interval. The length of time interval is configured via DataStorageConfiguration.setMetricsRateTimeInterval(long) configuration property. The number of subintervals is configured via DataStorageConfiguration.setMetricsSubIntervalCount(int) configuration property.
  - getWalArchiveSegments
```
int getWalArchiveSegments()
```
    Gets the current number of WAL segments in the WAL archive.
  - getWalFsyncTimeAverage
```
float getWalFsyncTimeAverage()
```
    Gets the average WAL fsync duration in microseconds over the last time interval.
    The length of time interval is configured via DataStorageConfiguration.setMetricsRateTimeInterval(long) configuration property. The number of subintervals is configured via DataStorageConfiguration.setMetricsSubIntervalCount(int) configuration property.
  - getWalBuffPollSpinsRate
```
long getWalBuffPollSpinsRate()
```
    Returns WAL buffer poll spins number over the last time interval.
    The length of time interval is configured via DataStorageConfiguration.setMetricsRateTimeInterval(long) configuration property. The number of subintervals is configured via DataStorageConfiguration.setMetricsSubIntervalCount(int) configuration property.
  - getWalTotalSize
```
long getWalTotalSize()
```
    Total size in bytes for storage wal files.
    
    Returns:
    
    Total size in bytes for storage wal files.
  - getWalLastRollOverTime
```
long getWalLastRollOverTime()
```
    Time of the last WAL segment rollover.
    
    Returns:
    
    Time of the last WAL segment rollover.
  - getCheckpointTotalTime
```
long getCheckpointTotalTime()
```
    Total checkpoint time from last restart.
    
    Returns:
    
    Total checkpoint time from last restart.
  - getLastCheckpointDuration
```
long getLastCheckpointDuration()
```
    Gets the duration of the last checkpoint in milliseconds.
    
    Returns:
    
    Total checkpoint duration in milliseconds.
  - getLastCheckpointLockWaitDuration
```
long getLastCheckpointLockWaitDuration()
```
    Gets the duration of last checkpoint lock wait in milliseconds.
    
    Returns:
    
    Checkpoint lock wait time in milliseconds.
  - getLastCheckpointMarkDuration
```
long getLastCheckpointMarkDuration()
```
    Gets the duration of last checkpoint mark phase in milliseconds.
    
    Returns:
    
    Checkpoint mark duration in milliseconds.
  - getLastCheckpointPagesWriteDuration
```
long getLastCheckpointPagesWriteDuration()
```
    Gets the duration of last checkpoint pages write phase in milliseconds.
    
    Returns:
    
    Checkpoint pages write phase in milliseconds.
  - getLastCheckpointFsyncDuration
```
long getLastCheckpointFsyncDuration()
```
    Gets the duration of the sync phase of the last checkpoint in milliseconds.
    
    Returns:
    
    Checkpoint fsync time in milliseconds.
  - getLastCheckpointTotalPagesNumber
```
long getLastCheckpointTotalPagesNumber()
```
    Gets the total number of pages written during the last checkpoint.
    
    Returns:
    
    Total number of pages written during the last checkpoint.
  - getLastCheckpointDataPagesNumber
```
long getLastCheckpointDataPagesNumber()
```
    Gets the number of data pages written during the last checkpoint.
    
    Returns:
    
    Total number of data pages written during the last checkpoint.
  - getLastCheckpointCopiedOnWritePagesNumber
```
long getLastCheckpointCopiedOnWritePagesNumber()
```
    Gets the number of pages copied to a temporary checkpoint buffer during the last checkpoint.
    
    Returns:
    
    Total number of pages copied to a temporary checkpoint buffer during the last checkpoint.
  - getDirtyPages
```
long getDirtyPages()
```
    Total dirty pages for the next checkpoint.
    
    Returns:
    
    Total dirty pages for the next checkpoint.
  - getPagesRead
```
long getPagesRead()
```
    The number of read pages from last restart.
    
    Returns:
    
    The number of read pages from last restart.
  - getPagesWritten
```
long getPagesWritten()
```
    The number of written pages from last restart.
    
    Returns:
    
    The number of written pages from last restart.
  - getPagesReplaced
```
long getPagesReplaced()
```
    The number of replaced pages from last restart.
    
    Returns:
    
    The number of replaced pages from last restart.
  - getOffHeapSize
```
long getOffHeapSize()
```
    Total offheap size in bytes.
    
    Returns:
    
    Total offheap size in bytes.
  - getOffheapUsedSize
```
long getOffheapUsedSize()
```
    Total used offheap size in bytes.
    
    Returns:
    
    Total used offheap size in bytes.
  - getTotalAllocatedSize
```
long getTotalAllocatedSize()
```
    Total size of memory allocated in bytes.
    
    Returns:
    
    Total size of memory allocated in bytes.
  - getUsedCheckpointBufferPages
```
long getUsedCheckpointBufferPages()
```
    Gets used checkpoint buffer size in pages.
    
    Returns:
    
    Checkpoint buffer size in pages.
  - getUsedCheckpointBufferSize
```
long getUsedCheckpointBufferSize()
```
    Gets used checkpoint buffer size in bytes.
    
    Returns:
    
    Checkpoint buffer size in bytes.
  - getCheckpointBufferSize
```
long getCheckpointBufferSize()
```
    Checkpoint buffer size in bytes.
    
    Returns:
    
    Checkpoint buffer size in bytes.
  - getStorageSize
```
long getStorageSize()
```
    Storage space allocated in bytes.
    
    Returns:
    
    Storage space allocated in bytes.
  - getSparseStorageSize
```
long getSparseStorageSize()
```
    Storage space allocated adjusted for possible sparsity in bytes. May produce unstable or even incorrect result on some file systems (e.g. XFS). Known to work correctly on Ext4 and Btrfs.
    
    Returns:
    
    Storage space allocated adjusted for possible sparsity in bytes or negative value is not supported.

Interface DataStorageMetrics

Method Summary

Method Detail

getWalLoggingRate

getWalWritingRate

getWalArchiveSegments

getWalFsyncTimeAverage

getWalBuffPollSpinsRate

getWalTotalSize

getWalLastRollOverTime

getCheckpointTotalTime

getLastCheckpointDuration

getLastCheckpointLockWaitDuration

getLastCheckpointMarkDuration

getLastCheckpointPagesWriteDuration

getLastCheckpointFsyncDuration

getLastCheckpointTotalPagesNumber

getLastCheckpointDataPagesNumber

getLastCheckpointCopiedOnWritePagesNumber

getDirtyPages

getPagesRead

getPagesWritten

getPagesReplaced

getOffHeapSize

getOffheapUsedSize

getTotalAllocatedSize

getUsedCheckpointBufferPages

getUsedCheckpointBufferSize

getCheckpointBufferSize

getStorageSize

getSparseStorageSize