org.apache.ignite.internal.processors.cache

Class CacheClusterMetricsMXBeanImpl

java.lang.Object

org.apache.ignite.internal.processors.cache.CacheClusterMetricsMXBeanImpl

All Implemented Interfaces:

javax.cache.management.CacheMXBean, javax.cache.management.CacheStatisticsMXBean, CacheMetrics, CacheMetricsMXBean

public class CacheClusterMetricsMXBeanImpl
extends Object
implements CacheMetricsMXBean

Management bean that provides access to IgniteCache.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	disableStatistics() Disable statistic collection for the cache.
void	enableStatistics() Enable statistic collection for the cache.
long	estimateRebalancingFinishTime() This method is deprecated and will be deleted in future major release.
float	getAverageGetTime() The mean time to execute gets.
float	getAveragePutTime() The mean time to execute puts.
float	getAverageRemoveTime() The mean time to execute removes.
float	getAverageTxCommitTime() The mean time to execute tx commit.
float	getAverageTxRollbackTime() The mean time to execute tx rollbacks.
long	getCacheEvictions() The total number of evictions from the cache.
long	getCacheGets() The total number of requests to the cache.
float	getCacheHitPercentage() This is a measure of cache efficiency.
long	getCacheHits() The number of get requests that were satisfied by the cache.
long	getCacheMisses() A miss is a get request that is not satisfied.
float	getCacheMissPercentage() Returns the percentage of cache accesses that did not find a requested entry in the cache.
long	getCachePuts() The total number of puts to the cache.
long	getCacheRemovals() The total number of removals from the cache.
long	getCacheSize() Cache size.
long	getCacheTxCommits() Gets total number of transaction commits.
long	getCacheTxRollbacks() Gets total number of transaction rollbacks.
int	getDhtEvictQueueCurrentSize() Gets current size of evict queue used to batch up evictions.
float	getEntryProcessorAverageInvocationTime() The mean time to execute cache invokes.
float	getEntryProcessorHitPercentage() The percentage of invocations on keys, which exist in cache.
long	getEntryProcessorHits() The total number of invocations on keys, which exist in cache.
long	getEntryProcessorInvocations() The total number of cache invocations.
float	getEntryProcessorMaxInvocationTime() So far, the maximum time to execute cache invokes.
float	getEntryProcessorMinInvocationTime() So far, the minimum time to execute cache invokes.
long	getEntryProcessorMisses() The total number of invocations on keys, which don't exist in cache.
float	getEntryProcessorMissPercentage() The percentage of invocations on keys, which don't exist in cache.
long	getEntryProcessorPuts() The total number of cache invocations, caused update.
long	getEntryProcessorReadOnlyInvocations() The total number of cache invocations, caused no updates.
long	getEntryProcessorRemovals() The total number of cache invocations, caused removal.
long	getEstimatedRebalancingFinishTime()
long	getEstimatedRebalancingKeys()
long	getHeapEntriesCount() Gets the number of cache entries in heap memory, including entries held by active transactions, entries in onheap cache and near entries.
long	getIndexRebuildKeysProcessed() Return number of keys processed during index rebuilding.
int	getKeySize() Gets number of keys in the cache, possibly with null values.
long	getKeysToRebalanceLeft()
String	getKeyType() Determines the required type of keys for this Cache, if any.
long	getOffHeapAllocatedSize() Gets memory size allocated in off-heap.
long	getOffHeapBackupEntriesCount() Gets number of backup entries stored in off-heap memory.
long	getOffHeapEntriesCount() Gets number of entries stored in off-heap memory.
long	getOffHeapEvictions() The total number of evictions from the off-heap memory.
long	getOffHeapGets() The total number of get requests to the off-heap memory.
float	getOffHeapHitPercentage() Gets the percentage of hits on off-heap memory.
long	getOffHeapHits() The number of get requests that were satisfied by the off-heap memory.
long	getOffHeapMisses() A miss is a get request that is not satisfied by off-heap memory.
float	getOffHeapMissPercentage() Gets the percentage of misses on off-heap memory.
long	getOffHeapPrimaryEntriesCount() Gets number of primary entries stored in off-heap memory.
long	getOffHeapPuts() The total number of put requests to the off-heap memory.
long	getOffHeapRemovals() The total number of removals from the off-heap memory.
long	getRebalanceClearingPartitionsLeft()
long	getRebalancedKeys()
long	getRebalancingBytesRate()
long	getRebalancingKeysRate()
int	getRebalancingPartitionsCount()
long	getRebalancingStartTime()
int	getSize() Gets number of non-null values in the cache.
int	getTotalPartitionsCount()
int	getTxCommitQueueSize() Gets committed transaction queue size.
int	getTxCommittedVersionsSize() Gets number of cached committed transaction IDs.
int	getTxDhtCommitQueueSize() Gets committed DHT transaction queue size.
int	getTxDhtCommittedVersionsSize() Gets number of cached committed DHT transaction IDs.
int	getTxDhtPrepareQueueSize() Gets prepared DHT transaction queue size.
int	getTxDhtRolledbackVersionsSize() Gets number of cached rolled back DHT transaction IDs.
int	getTxDhtStartVersionCountsSize() Gets DHT start version counts map size.
int	getTxDhtThreadMapSize() Gets transaction DHT per-thread map size.
int	getTxDhtXidMapSize() Gets transaction DHT per-Xid map size.
String	getTxKeyCollisions() Checks if there were any tx key collisions last time.
int	getTxPrepareQueueSize() Gets prepared transaction queue size.
int	getTxRolledbackVersionsSize() Gets number of cached rolled back transaction IDs.
int	getTxStartVersionCountsSize() Gets start version counts map size.
int	getTxThreadMapSize() Gets transaction per-thread map size.
int	getTxXidMapSize() Gets transaction per-Xid map size.
String	getValueType() Determines the required type of values for this Cache, if any.
int	getWriteBehindBufferSize() Gets count of entries that were processed by the write-behind store and have not been flushed to the underlying store yet.
int	getWriteBehindCriticalOverflowCount() Gets count of write buffer overflow events in progress at the moment.
int	getWriteBehindErrorRetryCount() Gets count of cache entries that are in a store-retry state.
long	getWriteBehindFlushFrequency() Gets the cache flush frequency.
int	getWriteBehindFlushSize() Gets the maximum size of the write-behind buffer.
int	getWriteBehindFlushThreadCount() Gets the number of flush threads that will perform store update operations.
int	getWriteBehindStoreBatchSize() Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.
int	getWriteBehindTotalCriticalOverflowCount() Gets count of write buffer overflow events since initialization.
boolean	isEmpty() Returns true if this cache is empty.
boolean	isIndexRebuildInProgress() Return true if index rebuild is in progress.
boolean	isManagementEnabled() Checks whether management is enabled on this cache.
boolean	isReadThrough() Determines if a Cache should operate in read-through mode.
boolean	isStatisticsEnabled() Checks whether statistics collection is enabled in this cache.
boolean	isStoreByValue() Whether storeByValue true or storeByReference false.
boolean	isValidForReading() Checks whether cache topology is valid for read operations.
boolean	isValidForWriting() Checks whether cache topology is valid for write operations.
boolean	isWriteBehindEnabled() Returns true if write-behind is enabled.
boolean	isWriteThrough() Determines if a Cache should operate in "write-through" mode.
String	name() Gets name of this cache.
long	rebalancingStartTime() This method is deprecated and will be deleted in future major release.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

name

public String name()

Gets name of this cache.

Specified by:

name in interface CacheMetrics

Specified by:

name in interface CacheMetricsMXBean

Returns:

Cache name.

getOffHeapGets

public long getOffHeapGets()

The total number of get requests to the off-heap memory.

Specified by:

getOffHeapGets in interface CacheMetrics

Specified by:

getOffHeapGets in interface CacheMetricsMXBean

Returns:

The number of gets.

getOffHeapPuts

public long getOffHeapPuts()

The total number of put requests to the off-heap memory.

Specified by:

getOffHeapPuts in interface CacheMetrics

Specified by:

getOffHeapPuts in interface CacheMetricsMXBean

Returns:

The number of puts.

getOffHeapRemovals

public long getOffHeapRemovals()

The total number of removals from the off-heap memory. This does not include evictions.

Specified by:

getOffHeapRemovals in interface CacheMetrics

Specified by:

getOffHeapRemovals in interface CacheMetricsMXBean

Returns:

The number of removals.

getOffHeapEvictions

public long getOffHeapEvictions()

The total number of evictions from the off-heap memory.

Specified by:

getOffHeapEvictions in interface CacheMetrics

Specified by:

getOffHeapEvictions in interface CacheMetricsMXBean

Returns:

The number of evictions.

getOffHeapHits

public long getOffHeapHits()

The number of get requests that were satisfied by the off-heap memory.

Specified by:

getOffHeapHits in interface CacheMetrics

Specified by:

getOffHeapHits in interface CacheMetricsMXBean

Returns:

The off-heap hits number.

getOffHeapHitPercentage

public float getOffHeapHitPercentage()

Gets the percentage of hits on off-heap memory.

Specified by:

getOffHeapHitPercentage in interface CacheMetrics

Specified by:

getOffHeapHitPercentage in interface CacheMetricsMXBean

Returns:

The percentage of hits on off-heap memory.

getOffHeapMisses

public long getOffHeapMisses()

A miss is a get request that is not satisfied by off-heap memory.

Specified by:

getOffHeapMisses in interface CacheMetrics

Specified by:

getOffHeapMisses in interface CacheMetricsMXBean

Returns:

The off-heap misses number.

getOffHeapMissPercentage

public float getOffHeapMissPercentage()

Gets the percentage of misses on off-heap memory.

Specified by:

getOffHeapMissPercentage in interface CacheMetrics

Specified by:

getOffHeapMissPercentage in interface CacheMetricsMXBean

Returns:

The percentage of misses on off-heap memory.

getOffHeapEntriesCount

public long getOffHeapEntriesCount()

Gets number of entries stored in off-heap memory.

Specified by:

getOffHeapEntriesCount in interface CacheMetrics

Specified by:

getOffHeapEntriesCount in interface CacheMetricsMXBean

Returns:

Number of entries stored in off-heap memory.

getHeapEntriesCount

public long getHeapEntriesCount()

Gets the number of cache entries in heap memory, including entries held by active transactions, entries in onheap cache and near entries.

Specified by:

getHeapEntriesCount in interface CacheMetrics

Specified by:

getHeapEntriesCount in interface CacheMetricsMXBean

Returns:

Number of entries in heap memory.

getOffHeapPrimaryEntriesCount

public long getOffHeapPrimaryEntriesCount()

Gets number of primary entries stored in off-heap memory.

Specified by:

getOffHeapPrimaryEntriesCount in interface CacheMetrics

Specified by:

getOffHeapPrimaryEntriesCount in interface CacheMetricsMXBean

Returns:

Number of primary entries stored in off-heap memory.

getOffHeapBackupEntriesCount

public long getOffHeapBackupEntriesCount()

Gets number of backup entries stored in off-heap memory.

Specified by:

getOffHeapBackupEntriesCount in interface CacheMetrics

Specified by:

getOffHeapBackupEntriesCount in interface CacheMetricsMXBean

Returns:

Number of backup entries stored in off-heap memory.

getOffHeapAllocatedSize

public long getOffHeapAllocatedSize()

Gets memory size allocated in off-heap.

Specified by:

getOffHeapAllocatedSize in interface CacheMetrics

Specified by:

getOffHeapAllocatedSize in interface CacheMetricsMXBean

Returns:

Memory size allocated in off-heap.

getSize

public int getSize()

Gets number of non-null values in the cache. Note this method will always return 0

Specified by:

getSize in interface CacheMetrics

Specified by:

getSize in interface CacheMetricsMXBean

Returns:

Number of non-null values in the cache.

getCacheSize

public long getCacheSize()

Cache size.

Specified by:

getCacheSize in interface CacheMetrics

Specified by:

getCacheSize in interface CacheMetricsMXBean

Returns:

Cache size.

getKeySize

public int getKeySize()

Gets number of keys in the cache, possibly with null values. Note this method will always return 0

Specified by:

getKeySize in interface CacheMetrics

Specified by:

getKeySize in interface CacheMetricsMXBean

Returns:

Number of keys in the cache.

isEmpty

public boolean isEmpty()

Returns true if this cache is empty.

Specified by:

isEmpty in interface CacheMetrics

Specified by:

isEmpty in interface CacheMetricsMXBean

Returns:

True if this cache is empty.

getDhtEvictQueueCurrentSize

public int getDhtEvictQueueCurrentSize()

Gets current size of evict queue used to batch up evictions.

Specified by:

getDhtEvictQueueCurrentSize in interface CacheMetrics

Specified by:

getDhtEvictQueueCurrentSize in interface CacheMetricsMXBean

Returns:

Current size of evict queue.

getTxCommitQueueSize

public int getTxCommitQueueSize()

Gets committed transaction queue size.

Specified by:

getTxCommitQueueSize in interface CacheMetrics

Specified by:

getTxCommitQueueSize in interface CacheMetricsMXBean

Returns:

Committed transaction queue size.

getTxThreadMapSize

public int getTxThreadMapSize()

Gets transaction per-thread map size.

Specified by:

getTxThreadMapSize in interface CacheMetrics

Specified by:

getTxThreadMapSize in interface CacheMetricsMXBean

Returns:

Thread map size.

getTxXidMapSize

public int getTxXidMapSize()

Gets transaction per-Xid map size.

Specified by:

getTxXidMapSize in interface CacheMetrics

Specified by:

getTxXidMapSize in interface CacheMetricsMXBean

Returns:

Transaction per-Xid map size.

getTxPrepareQueueSize

public int getTxPrepareQueueSize()

Gets prepared transaction queue size.

Specified by:

getTxPrepareQueueSize in interface CacheMetrics

Specified by:

getTxPrepareQueueSize in interface CacheMetricsMXBean

Returns:

Prepared transaction queue size.

getTxStartVersionCountsSize

public int getTxStartVersionCountsSize()

Gets start version counts map size.

Specified by:

getTxStartVersionCountsSize in interface CacheMetrics

Specified by:

getTxStartVersionCountsSize in interface CacheMetricsMXBean

Returns:

Start version counts map size.

getTxCommittedVersionsSize

public int getTxCommittedVersionsSize()

Gets number of cached committed transaction IDs.

Specified by:

getTxCommittedVersionsSize in interface CacheMetrics

Specified by:

getTxCommittedVersionsSize in interface CacheMetricsMXBean

Returns:

Number of cached committed transaction IDs.

getTxRolledbackVersionsSize

public int getTxRolledbackVersionsSize()

Gets number of cached rolled back transaction IDs.

Specified by:

getTxRolledbackVersionsSize in interface CacheMetrics

Specified by:

getTxRolledbackVersionsSize in interface CacheMetricsMXBean

Returns:

Number of cached rolled back transaction IDs.

getTxDhtThreadMapSize

public int getTxDhtThreadMapSize()

Gets transaction DHT per-thread map size.

Specified by:

getTxDhtThreadMapSize in interface CacheMetrics

Specified by:

getTxDhtThreadMapSize in interface CacheMetricsMXBean

Returns:

DHT thread map size.

getTxDhtXidMapSize

public int getTxDhtXidMapSize()

Gets transaction DHT per-Xid map size.

Specified by:

getTxDhtXidMapSize in interface CacheMetrics

Specified by:

getTxDhtXidMapSize in interface CacheMetricsMXBean

Returns:

Transaction DHT per-Xid map size.

getTxDhtCommitQueueSize

public int getTxDhtCommitQueueSize()

Gets committed DHT transaction queue size.

Specified by:

getTxDhtCommitQueueSize in interface CacheMetrics

Specified by:

getTxDhtCommitQueueSize in interface CacheMetricsMXBean

Returns:

Committed DHT transaction queue size.

getTxDhtPrepareQueueSize

public int getTxDhtPrepareQueueSize()

Gets prepared DHT transaction queue size.

Specified by:

getTxDhtPrepareQueueSize in interface CacheMetrics

Specified by:

getTxDhtPrepareQueueSize in interface CacheMetricsMXBean

Returns:

Prepared DHT transaction queue size.

getTxDhtStartVersionCountsSize

public int getTxDhtStartVersionCountsSize()

Gets DHT start version counts map size.

Specified by:

getTxDhtStartVersionCountsSize in interface CacheMetrics

Specified by:

getTxDhtStartVersionCountsSize in interface CacheMetricsMXBean

Returns:

DHT start version counts map size.

getTxDhtCommittedVersionsSize

public int getTxDhtCommittedVersionsSize()

Gets number of cached committed DHT transaction IDs.

Specified by:

getTxDhtCommittedVersionsSize in interface CacheMetrics

Specified by:

getTxDhtCommittedVersionsSize in interface CacheMetricsMXBean

Returns:

Number of cached committed DHT transaction IDs.

getTxDhtRolledbackVersionsSize

public int getTxDhtRolledbackVersionsSize()

Gets number of cached rolled back DHT transaction IDs.

Specified by:

getTxDhtRolledbackVersionsSize in interface CacheMetrics

Specified by:

getTxDhtRolledbackVersionsSize in interface CacheMetricsMXBean

Returns:

Number of cached rolled back DHT transaction IDs.

isWriteBehindEnabled

public boolean isWriteBehindEnabled()

Returns true if write-behind is enabled.

Specified by:

isWriteBehindEnabled in interface CacheMetrics

Specified by:

isWriteBehindEnabled in interface CacheMetricsMXBean

Returns:

True if write-behind is enabled.

getWriteBehindFlushSize

public int getWriteBehindFlushSize()

Gets the maximum size of the write-behind buffer. When the count of unique keys in write buffer exceeds this value, the buffer is scheduled for write to the underlying store.

If this value is 0, then flush is performed only on time-elapsing basis. However, when this value is 0, the cache critical size is set to CacheConfiguration.DFLT_WRITE_BEHIND_CRITICAL_SIZE

Specified by:

getWriteBehindFlushSize in interface CacheMetrics

Specified by:

getWriteBehindFlushSize in interface CacheMetricsMXBean

Returns:

Buffer size that triggers flush procedure.

getWriteBehindFlushThreadCount

public int getWriteBehindFlushThreadCount()

Gets the number of flush threads that will perform store update operations.

Specified by:

getWriteBehindFlushThreadCount in interface CacheMetrics

Specified by:

getWriteBehindFlushThreadCount in interface CacheMetricsMXBean

Returns:

Count of worker threads.

getWriteBehindFlushFrequency

public long getWriteBehindFlushFrequency()

Gets the cache flush frequency. All pending operations on the underlying store will be performed within time interval not less then this value.

If this value is 0, then flush is performed only when buffer size exceeds flush size.

Specified by:

getWriteBehindFlushFrequency in interface CacheMetrics

Specified by:

getWriteBehindFlushFrequency in interface CacheMetricsMXBean

Returns:

Flush frequency in milliseconds.

getWriteBehindStoreBatchSize

public int getWriteBehindStoreBatchSize()

Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch.

Specified by:

getWriteBehindStoreBatchSize in interface CacheMetrics

Specified by:

getWriteBehindStoreBatchSize in interface CacheMetricsMXBean

Returns:

Maximum size of batch.

getWriteBehindTotalCriticalOverflowCount

public int getWriteBehindTotalCriticalOverflowCount()

Gets count of write buffer overflow events since initialization. Each overflow event causes the ongoing flush operation to be performed synchronously.

Specified by:

getWriteBehindTotalCriticalOverflowCount in interface CacheMetrics

Specified by:

getWriteBehindTotalCriticalOverflowCount in interface CacheMetricsMXBean

Returns:

Count of cache overflow events since start.

getWriteBehindCriticalOverflowCount

public int getWriteBehindCriticalOverflowCount()

Gets count of write buffer overflow events in progress at the moment. Each overflow event causes the ongoing flush operation to be performed synchronously.

Specified by:

getWriteBehindCriticalOverflowCount in interface CacheMetrics

Specified by:

getWriteBehindCriticalOverflowCount in interface CacheMetricsMXBean

Returns:

Count of cache overflow events since start.

getWriteBehindErrorRetryCount

public int getWriteBehindErrorRetryCount()

Gets count of cache entries that are in a store-retry state. An entry is assigned a store-retry state when underlying store failed due some reason and cache has enough space to retain this entry till the next try.

Specified by:

getWriteBehindErrorRetryCount in interface CacheMetrics

Specified by:

getWriteBehindErrorRetryCount in interface CacheMetricsMXBean

Returns:

Count of entries in store-retry state.

getWriteBehindBufferSize

public int getWriteBehindBufferSize()

Gets count of entries that were processed by the write-behind store and have not been flushed to the underlying store yet.

Specified by:

getWriteBehindBufferSize in interface CacheMetrics

Specified by:

getWriteBehindBufferSize in interface CacheMetricsMXBean

Returns:

Total count of entries in cache store internal buffer.

clear

public void clear()

Specified by:

clear in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

clear in interface CacheMetricsMXBean

getCacheHits

public long getCacheHits()

The number of get requests that were satisfied by the cache.

Specified by:

getCacheHits in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheHits in interface CacheMetrics

Specified by:

getCacheHits in interface CacheMetricsMXBean

Returns:

The number of hits.

getCacheHitPercentage

public float getCacheHitPercentage()

This is a measure of cache efficiency.

Specified by:

getCacheHitPercentage in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheHitPercentage in interface CacheMetrics

Specified by:

getCacheHitPercentage in interface CacheMetricsMXBean

Returns:

The percentage of successful hits, as a decimal e.g 75.

getCacheMisses

public long getCacheMisses()

A miss is a get request that is not satisfied.

Specified by:

getCacheMisses in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheMisses in interface CacheMetrics

Specified by:

getCacheMisses in interface CacheMetricsMXBean

Returns:

The number of misses.

getCacheMissPercentage

public float getCacheMissPercentage()

Returns the percentage of cache accesses that did not find a requested entry in the cache.

Specified by:

getCacheMissPercentage in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheMissPercentage in interface CacheMetrics

Specified by:

getCacheMissPercentage in interface CacheMetricsMXBean

Returns:

The percentage of accesses that failed to find anything.

getCacheGets

public long getCacheGets()

The total number of requests to the cache. This will be equal to the sum of the hits and misses.

Specified by:

getCacheGets in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheGets in interface CacheMetrics

Specified by:

getCacheGets in interface CacheMetricsMXBean

Returns:

The number of gets.

getCachePuts

public long getCachePuts()

The total number of puts to the cache.

Specified by:

getCachePuts in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCachePuts in interface CacheMetrics

Specified by:

getCachePuts in interface CacheMetricsMXBean

Returns:

The number of puts.

getEntryProcessorPuts

public long getEntryProcessorPuts()

The total number of cache invocations, caused update.

Specified by:

getEntryProcessorPuts in interface CacheMetrics

Specified by:

getEntryProcessorPuts in interface CacheMetricsMXBean

Returns:

The number of invocation updates.

getEntryProcessorRemovals

public long getEntryProcessorRemovals()

The total number of cache invocations, caused removal.

Specified by:

getEntryProcessorRemovals in interface CacheMetrics

Specified by:

getEntryProcessorRemovals in interface CacheMetricsMXBean

Returns:

The number of invocation removals.

getEntryProcessorReadOnlyInvocations

public long getEntryProcessorReadOnlyInvocations()

The total number of cache invocations, caused no updates.

Specified by:

getEntryProcessorReadOnlyInvocations in interface CacheMetrics

Specified by:

getEntryProcessorReadOnlyInvocations in interface CacheMetricsMXBean

Returns:

The number of read-only invocations.

getEntryProcessorInvocations

public long getEntryProcessorInvocations()

The total number of cache invocations.

Specified by:

getEntryProcessorInvocations in interface CacheMetrics

Specified by:

getEntryProcessorInvocations in interface CacheMetricsMXBean

Returns:

The number of cache invocations.

getEntryProcessorHits

public long getEntryProcessorHits()

The total number of invocations on keys, which exist in cache.

Specified by:

getEntryProcessorHits in interface CacheMetrics

Specified by:

getEntryProcessorHits in interface CacheMetricsMXBean

Returns:

The number of cache invocation hits.

getEntryProcessorHitPercentage

public float getEntryProcessorHitPercentage()

The percentage of invocations on keys, which exist in cache.

Specified by:

getEntryProcessorHitPercentage in interface CacheMetrics

Specified by:

getEntryProcessorHitPercentage in interface CacheMetricsMXBean

Returns:

The percentage of successful invocation hits.

getEntryProcessorMissPercentage

public float getEntryProcessorMissPercentage()

The percentage of invocations on keys, which don't exist in cache.

Specified by:

getEntryProcessorMissPercentage in interface CacheMetrics

Specified by:

getEntryProcessorMissPercentage in interface CacheMetricsMXBean

Returns:

The percentage of invocation misses.

getEntryProcessorMisses

public long getEntryProcessorMisses()

The total number of invocations on keys, which don't exist in cache.

Specified by:

getEntryProcessorMisses in interface CacheMetrics

Specified by:

getEntryProcessorMisses in interface CacheMetricsMXBean

Returns:

The number of cache invocation misses.

getEntryProcessorAverageInvocationTime

public float getEntryProcessorAverageInvocationTime()

The mean time to execute cache invokes.

Specified by:

getEntryProcessorAverageInvocationTime in interface CacheMetrics

Specified by:

getEntryProcessorAverageInvocationTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getEntryProcessorMinInvocationTime

public float getEntryProcessorMinInvocationTime()

So far, the minimum time to execute cache invokes.

Specified by:

getEntryProcessorMinInvocationTime in interface CacheMetrics

Specified by:

getEntryProcessorMinInvocationTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getEntryProcessorMaxInvocationTime

public float getEntryProcessorMaxInvocationTime()

So far, the maximum time to execute cache invokes.

Specified by:

getEntryProcessorMaxInvocationTime in interface CacheMetrics

Specified by:

getEntryProcessorMaxInvocationTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getCacheRemovals

public long getCacheRemovals()

The total number of removals from the cache. This does not include evictions, where the cache itself initiates the removal to make space.

Specified by:

getCacheRemovals in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheRemovals in interface CacheMetrics

Specified by:

getCacheRemovals in interface CacheMetricsMXBean

Returns:

The number of removals.

getCacheEvictions

public long getCacheEvictions()

The total number of evictions from the cache. An eviction is a removal initiated by the cache itself to free up space. An eviction is not treated as a removal and does not appear in the removal counts.

Specified by:

getCacheEvictions in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getCacheEvictions in interface CacheMetrics

Specified by:

getCacheEvictions in interface CacheMetricsMXBean

Returns:

The number of evictions.

getAverageGetTime

public float getAverageGetTime()

The mean time to execute gets.

Specified by:

getAverageGetTime in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getAverageGetTime in interface CacheMetrics

Specified by:

getAverageGetTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getAveragePutTime

public float getAveragePutTime()

The mean time to execute puts.

Specified by:

getAveragePutTime in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getAveragePutTime in interface CacheMetrics

Specified by:

getAveragePutTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getAverageRemoveTime

public float getAverageRemoveTime()

The mean time to execute removes.

Specified by:

getAverageRemoveTime in interface javax.cache.management.CacheStatisticsMXBean

Specified by:

getAverageRemoveTime in interface CacheMetrics

Specified by:

getAverageRemoveTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getAverageTxCommitTime

public float getAverageTxCommitTime()

The mean time to execute tx commit.

Specified by:

getAverageTxCommitTime in interface CacheMetrics

Specified by:

getAverageTxCommitTime in interface CacheMetricsMXBean

Returns:

The time in µs.

getAverageTxRollbackTime

public float getAverageTxRollbackTime()

The mean time to execute tx rollbacks.

Specified by:

getAverageTxRollbackTime in interface CacheMetrics

Specified by:

getAverageTxRollbackTime in interface CacheMetricsMXBean

Returns:

Number of transaction rollbacks.

getCacheTxCommits

public long getCacheTxCommits()

Gets total number of transaction commits.

Specified by:

getCacheTxCommits in interface CacheMetrics

Specified by:

getCacheTxCommits in interface CacheMetricsMXBean

Returns:

Number of transaction commits.

getCacheTxRollbacks

public long getCacheTxRollbacks()

Gets total number of transaction rollbacks.

Specified by:

getCacheTxRollbacks in interface CacheMetrics

Specified by:

getCacheTxRollbacks in interface CacheMetricsMXBean

Returns:

Number of transaction rollbacks.

getKeyType

public String getKeyType()

Determines the required type of keys for this Cache, if any.

Specified by:

getKeyType in interface javax.cache.management.CacheMXBean

Specified by:

getKeyType in interface CacheMetrics

Specified by:

getKeyType in interface CacheMetricsMXBean

Returns:

The fully qualified class name of the key type, or "java.lang.Object" if the type is undefined.

getValueType

public String getValueType()

Determines the required type of values for this Cache, if any.

Specified by:

getValueType in interface javax.cache.management.CacheMXBean

Specified by:

getValueType in interface CacheMetrics

Specified by:

getValueType in interface CacheMetricsMXBean

Returns:

The fully qualified class name of the value type, or "java.lang.Object" if the type is undefined.

isStoreByValue

public boolean isStoreByValue()

Whether storeByValue true or storeByReference false. When true, both keys and values are stored by value.

When false, both keys and values are stored by reference. Caches stored by reference are capable of mutation by any threads holding the reference. The effects are:

• if the key is mutated, then the key may not be retrievable or removable
• if the value is mutated, then all threads in the JVM can potentially observe those mutations, subject to the normal Java Memory Model rules.

Storage by reference only applies to the local heap. If an entry is moved off heap it will need to be transformed into a representation. Any mutations that occur after transformation may not be reflected in the cache.

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

The default value is true.

Specified by:

isStoreByValue in interface javax.cache.management.CacheMXBean

Specified by:

isStoreByValue in interface CacheMetrics

Specified by:

isStoreByValue in interface CacheMetricsMXBean

Returns:

True if the cache is store by value.

isStatisticsEnabled

public boolean isStatisticsEnabled()

Checks whether statistics collection is enabled in this cache.

The default value is false.

Specified by:

isStatisticsEnabled in interface javax.cache.management.CacheMXBean

Specified by:

isStatisticsEnabled in interface CacheMetrics

Specified by:

isStatisticsEnabled in interface CacheMetricsMXBean

Returns:

True if statistics collection is enabled.

isManagementEnabled

public boolean isManagementEnabled()

Checks whether management is enabled on this cache.

The default value is false.

Specified by:

isManagementEnabled in interface javax.cache.management.CacheMXBean

Specified by:

isManagementEnabled in interface CacheMetrics

Specified by:

isManagementEnabled in interface CacheMetricsMXBean

Returns:

true if management is enabled.

isReadThrough

public boolean isReadThrough()

Determines if a Cache should operate in read-through mode.

The default value is false

Specified by:

isReadThrough in interface javax.cache.management.CacheMXBean

Specified by:

isReadThrough in interface CacheMetrics

Specified by:

isReadThrough in interface CacheMetricsMXBean

Returns:

True when a Cache is in "read-through" mode.

See Also:

CacheLoader

isWriteThrough

public boolean isWriteThrough()

Determines if a Cache should operate in "write-through" mode.

will appropriately cause the configured CacheWriter to be invoked.

The default value is false

Specified by:

isWriteThrough in interface javax.cache.management.CacheMXBean

Specified by:

isWriteThrough in interface CacheMetrics

Specified by:

isWriteThrough in interface CacheMetricsMXBean

Returns:

True when a Cache is in "write-through" mode.

See Also:

CacheWriter

getTotalPartitionsCount

public int getTotalPartitionsCount()

Specified by:

getTotalPartitionsCount in interface CacheMetrics

Specified by:

getTotalPartitionsCount in interface CacheMetricsMXBean

Returns:

Total number of partitions on current node.

getRebalancedKeys

public long getRebalancedKeys()

Specified by:

getRebalancedKeys in interface CacheMetrics

Specified by:

getRebalancedKeys in interface CacheMetricsMXBean

Returns:

Number of already rebalanced keys.

getEstimatedRebalancingKeys

public long getEstimatedRebalancingKeys()

Specified by:

getEstimatedRebalancingKeys in interface CacheMetrics

Specified by:

getEstimatedRebalancingKeys in interface CacheMetricsMXBean

Returns:

Number estimated to rebalance keys.

getRebalancingPartitionsCount

public int getRebalancingPartitionsCount()

Specified by:

getRebalancingPartitionsCount in interface CacheMetrics

Specified by:

getRebalancingPartitionsCount in interface CacheMetricsMXBean

Returns:

Number of currently rebalancing partitions on current node.

getKeysToRebalanceLeft

public long getKeysToRebalanceLeft()

Specified by:

getKeysToRebalanceLeft in interface CacheMetrics

Specified by:

getKeysToRebalanceLeft in interface CacheMetricsMXBean

Returns:

Estimated number of keys to be rebalanced on current node.

getRebalancingKeysRate

public long getRebalancingKeysRate()

Specified by:

getRebalancingKeysRate in interface CacheMetrics

Specified by:

getRebalancingKeysRate in interface CacheMetricsMXBean

Returns:

Estimated rebalancing speed in keys.

getRebalancingBytesRate

public long getRebalancingBytesRate()

Specified by:

getRebalancingBytesRate in interface CacheMetrics

Specified by:

getRebalancingBytesRate in interface CacheMetricsMXBean

Returns:

Estimated rebalancing speed in bytes.

estimateRebalancingFinishTime

public long estimateRebalancingFinishTime()

This method is deprecated and will be deleted in future major release. Use CacheMetrics.getEstimatedRebalancingFinishTime() instead.

Specified by:

estimateRebalancingFinishTime in interface CacheMetrics

Returns:

Estimated rebalancing finished time.

rebalancingStartTime

public long rebalancingStartTime()

This method is deprecated and will be deleted in future major release. Use CacheMetrics.getRebalancingStartTime() instead.

Specified by:

rebalancingStartTime in interface CacheMetrics

Returns:

Rebalancing start time.

getEstimatedRebalancingFinishTime

public long getEstimatedRebalancingFinishTime()

Specified by:

getEstimatedRebalancingFinishTime in interface CacheMetrics

Specified by:

getEstimatedRebalancingFinishTime in interface CacheMetricsMXBean

Returns:

Estimated rebalancing finish time.

getRebalancingStartTime

public long getRebalancingStartTime()

Specified by:

getRebalancingStartTime in interface CacheMetrics

Specified by:

getRebalancingStartTime in interface CacheMetricsMXBean

Returns:

Rebalancing start time.

getRebalanceClearingPartitionsLeft

public long getRebalanceClearingPartitionsLeft()

Specified by:

getRebalanceClearingPartitionsLeft in interface CacheMetrics

Specified by:

getRebalanceClearingPartitionsLeft in interface CacheMetricsMXBean

Returns:

The number of partitions need to be cleared before actual rebalance start.

isValidForReading

public boolean isValidForReading()

Checks whether cache topology is valid for read operations.

Note: the method will return false if any partition was lost despite the fact others can be awailable for reading.

Specified by:

isValidForReading in interface CacheMetrics

Specified by:

isValidForReading in interface CacheMetricsMXBean

Returns:

true when cache topology is valid for reading.

isValidForWriting

public boolean isValidForWriting()

Checks whether cache topology is valid for write operations.

Note: the method will return false if any partition was lost despite the fact others can be awailable for writing according to configured partition loss policy.

Specified by:

isValidForWriting in interface CacheMetrics

Specified by:

isValidForWriting in interface CacheMetricsMXBean

Returns:

true when cache topology is valid for writing.

getTxKeyCollisions

public String getTxKeyCollisions()

Checks if there were any tx key collisions last time. Interval for check specified throught: IgniteSystemProperties.IGNITE_DUMP_TX_COLLISIONS_INTERVAL or TransactionsMXBean.setTxKeyCollisionsInterval(int).

Specified by:

getTxKeyCollisions in interface CacheMetrics

Specified by:

getTxKeyCollisions in interface CacheMetricsMXBean

Returns:

Key collisions and appropriate queue size string representation.

enableStatistics

public void enableStatistics()

Enable statistic collection for the cache.

Specified by:

enableStatistics in interface CacheMetricsMXBean

disableStatistics

public void disableStatistics()

Disable statistic collection for the cache.

Specified by:

disableStatistics in interface CacheMetricsMXBean

isIndexRebuildInProgress

public boolean isIndexRebuildInProgress()

Return true if index rebuild is in progress.

Specified by:

isIndexRebuildInProgress in interface CacheMetrics

Specified by:

isIndexRebuildInProgress in interface CacheMetricsMXBean

Returns:

true if index rebuild is in progress.

getIndexRebuildKeysProcessed

public long getIndexRebuildKeysProcessed()

Return number of keys processed during index rebuilding. To get remaining number of keys for rebuilding, subtract current value from CacheMetrics.getCacheSize().

Specified by:

getIndexRebuildKeysProcessed in interface CacheMetrics

Specified by:

getIndexRebuildKeysProcessed in interface CacheMetricsMXBean

Returns:

Number of keys processed during index rebuilding.