org.gridgain.grid.persistentstore

Interface SnapshotMetricsMXBean

@MXBeanDescription(value="MBean that provides access to snapshot information.")
public interface SnapshotMetricsMXBean

Snapshot metrics used to obtain statistics on snapshots.

Method Summary

Modifier and Type	Method and Description
int	getAvailableSnapshotMetrics() Gets the number of recorded snapshot metrics.
long	getBytesWritten() Total size of all pages in bytes during snapshot creation (before/without compression).
long	getBytesWritten(int index) Total size of bytes during snapshot creation.
long	getFreeSpace() Gets free space in default configured snapshot directory (in bytes).
long	getLastSnapshotFinishTime() Gets the last snapshot finish time.
long	getLastSnapshotId() Gets the last snapshot IDs
String	getLastSnapshotOperation() Gets the last snapshot operation type.
long	getLastSnapshotStartTime() Gets the last snapshot start time.
long	getPartitionsWritten() Partitions written during snapshot creation.
long	getPartitionsWritten(int index) Partitions written during snapshot creation.
long	getTotalBytesWrittenOnStorage() Total bytes written on storage during snapshot creation (including snapshot metadata).
long	getTotalBytesWrittenOnStorage(int index) Total bytes written on storage during snapshot creation.
long	getWriteThrottlingTime() Time in milliseconds when snapshot writer thread was parked.
long	getWriteThrottlingTime(int index) Time in milliseconds when snapshot writer thread was parked.
boolean	isSnapshotInProgress() Gets flag indicating if there is an ongoing snapshot operation.
long	snapshotFinishTime(int index) Gets one of the last snapshot finish times by it's relative index.
long	snapshotId(int index) Gets one of the last snapshot IDs by it's relative index.
String	snapshotOperation(int index) Gets one of the last snapshot operation types by it's relative index.
long	snapshotStartTime(int index) Gets one of the last snapshot start times by it's relative index.

Method Detail

isSnapshotInProgress

@MXBeanDescription(value="Snapshot in progress.")
boolean isSnapshotInProgress()

Gets flag indicating if there is an ongoing snapshot operation.

Returns:

Boolean flag inidicating if there is a snapshot operation in progress.

getLastSnapshotId

@MXBeanDescription(value="Last snapshot ID.")
long getLastSnapshotId()

Gets the last snapshot IDs

Returns:

Snapshot ID.

snapshotId

@MXBeanDescription(value="Snapshot id.")
long snapshotId(int index)

Gets one of the last snapshot IDs by it's relative index. The most recent snapshot has index 0.

Parameters:

index - Relative snapshot index.

Returns:

Snapshot ID.

getLastSnapshotStartTime

@MXBeanDescription(value="Last snapshot start time.")
long getLastSnapshotStartTime()

Gets the last snapshot start time.

Returns:

Last snapshot start time.

snapshotStartTime

@MXBeanDescription(value="Snapshot start time. 0 for current (if snapshot in progress) or last.")
long snapshotStartTime(int index)

Gets one of the last snapshot start times by it's relative index. The most recent snapshot has index 0.

Parameters:

index - Relative snapshot index.

Returns:

Snapshot start time.

getLastSnapshotFinishTime

@MXBeanDescription(value="Last snapshot finish time.")
long getLastSnapshotFinishTime()

Gets the last snapshot finish time.

Returns:

Last snapshot finish time.

snapshotFinishTime

@MXBeanDescription(value="Snapshot finish time. 0 for current (if snapshot in progress) or last.")
long snapshotFinishTime(int index)

Gets one of the last snapshot finish times by it's relative index. The most recent snapshot has index 0.

Parameters:

index - Relative snapshot index.

Returns:

Snapshot finish time.

getLastSnapshotOperation

@MXBeanDescription(value="Last snapshot operation type.")
String getLastSnapshotOperation()

Gets the last snapshot operation type.

Returns:

Last snapshot operation type.

snapshotOperation

@MXBeanDescription(value="Snapshot operation type. 0 for current (if snapshot in progress) or last.")
String snapshotOperation(int index)

Gets one of the last snapshot operation types by it's relative index. The most recent snapshot has index 0.

Parameters:

index - Relative snapshot index.

Returns:

Snapshot operation type.

getAvailableSnapshotMetrics

@MXBeanDescription(value="Last available snapshots info.")
int getAvailableSnapshotMetrics()

Gets the number of recorded snapshot metrics.

Returns:

Number of recorded snapshot metrics.

getFreeSpace

@MXBeanDescription(value="Free space in snapshot directory.")
long getFreeSpace()

Gets free space in default configured snapshot directory (in bytes).

Returns:

Free space in bytes available in default snapshot directory.

getBytesWritten

@MXBeanDescription(value="Total pages in bytes written in current snapshot before compression.")
long getBytesWritten()

Total size of all pages in bytes during snapshot creation (before/without compression).

Returns:

Size in bytes.

getTotalBytesWrittenOnStorage

@MXBeanDescription(value="Total bytes written on storage.")
long getTotalBytesWrittenOnStorage()

Total bytes written on storage during snapshot creation (including snapshot metadata).

Returns:

Size in bytes.

getWriteThrottlingTime

@MXBeanDescription(value="Time in milliseconds snapshot writer thread was throttled.")
long getWriteThrottlingTime()

Time in milliseconds when snapshot writer thread was parked.

Returns:

Time in milliseconds

getBytesWritten

@MXBeanDescription(value="Bytes written during snapshot creation.")
long getBytesWritten(int index)

Total size of bytes during snapshot creation.

Parameters:

index - Relative snapshot index.

getWriteThrottlingTime

@MXBeanDescription(value="Time in milliseconds snapshot writer thread was throttled.")
long getWriteThrottlingTime(int index)

Time in milliseconds when snapshot writer thread was parked.

Parameters:

index - Relative snapshot index.

Returns:

Time in milliseconds

getTotalBytesWrittenOnStorage

@MXBeanDescription(value="Total bytes written on storage.")
long getTotalBytesWrittenOnStorage(int index)

Total bytes written on storage during snapshot creation.

Parameters:

index - Relative snapshot index.

getPartitionsWritten

@MXBeanDescription(value="Partitions written during snapshot creation.")
long getPartitionsWritten()

Partitions written during snapshot creation.

Returns:

Partitions written.

getPartitionsWritten

@MXBeanDescription(value="Partitions written during snapshot creation.")
long getPartitionsWritten(int index)

Partitions written during snapshot creation.

Parameters:

index - Relative snapshot index.*

Returns:

Partitions written.