Cache metrics used to obtain statistics on cache itself. More...

Properties
long	CacheHits `[get]`
	The number of get requests that were satisfied by the cache. More...

float	CacheHitPercentage `[get]`
	This is a measure of cache efficiency. More...

long	CacheMisses `[get]`
	A miss is a get request that is not satisfied. More...

float	CacheMissPercentage `[get]`
	Returns the percentage of cache accesses that did not find a requested entry in the cache. More...

long	CacheGets `[get]`
	The total number of requests to the cache. This will be equal to the sum of the hits and misses. More...

long	CachePuts `[get]`
	The total number of puts to the cache. More...

long	CacheRemovals `[get]`
	The total number of removals from the cache. This does not include evictions, where the cache itself initiates the removal to make space. More...

long	CacheEvictions `[get]`
	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. More...

float	AverageGetTime `[get]`
	The mean time to execute gets. More...

float	AveragePutTime `[get]`
	The mean time to execute puts. More...

float	AverageRemoveTime `[get]`
	The mean time to execute removes. More...

float	AverageTxCommitTime `[get]`
	The mean time to execute tx commit. More...

float	AverageTxRollbackTime `[get]`
	The mean time to execute tx rollbacks. More...

long	CacheTxCommits `[get]`
	Gets total number of transaction commits. More...

long	CacheTxRollbacks `[get]`
	Gets total number of transaction rollbacks. More...

string	CacheName `[get]`
	Gets cache name. More...

long	OverflowSize `[get]`
	Gets number of entries that was swapped to disk. More...

long	OffHeapGets `[get]`
	The total number of get requests to the off-heap memory. More...

long	OffHeapPuts `[get]`
	The total number of put requests to the off-heap memory. More...

long	OffHeapRemovals `[get]`
	The total number of removals from the off-heap memory. This does not include evictions. More...

long	OffHeapEvictions `[get]`
	The total number of evictions from the off-heap memory. More...

long	OffHeapHits `[get]`
	The number of get requests that were satisfied by the off-heap memory. More...

float	OffHeapHitPercentage `[get]`
	Gets the percentage of hits on off-heap memory. More...

long	OffHeapMisses `[get]`
	A miss is a get request that is not satisfied by off-heap memory. More...

float	OffHeapMissPercentage `[get]`
	Gets the percentage of misses on off-heap memory. More...

long	OffHeapEntriesCount `[get]`
	Gets number of entries stored in off-heap memory. More...

long	OffHeapPrimaryEntriesCount `[get]`
	Gets the number of primary entries stored in off-heap memory. More...

long	OffHeapBackupEntriesCount `[get]`
	Gets number of backup entries stored in off-heap memory. More...

long	OffHeapAllocatedSize `[get]`
	Gets memory size allocated in off-heap. More...

long	OffHeapMaxSize `[get]`
	Gets off-heap memory maximum size. More...

long	SwapGets `[get]`
	The total number of get requests to the swap. More...

long	SwapPuts `[get]`
	The total number of put requests to the swap. More...

long	SwapRemovals `[get]`
	The total number of removals from the swap. More...

long	SwapHits `[get]`
	The number of get requests that were satisfied by the swap. More...

long	SwapMisses `[get]`
	A number of get requests to that were not satisfied by the swap. More...

long	SwapEntriesCount `[get]`
	Gets number of entries stored in swap. More...

long	SwapSize `[get]`
	Gets size of swap, in bytes. More...

float	SwapHitPercentage `[get]`
	Gets the percentage of hits on swap. More...

float	SwapMissPercentage `[get]`
	Gets the percentage of misses on swap. More...

int	Size `[get]`
	Gets number of non-null values in the cache. More...

int	KeySize `[get]`
	Gets number of keys in the cache, possibly with null values. More...

bool	IsEmpty `[get]`
	Returns true if this cache is empty. More...

int	DhtEvictQueueCurrentSize `[get]`
	Gets current size of evict queue used to batch up evictions. More...

int	TxThreadMapSize `[get]`
	Gets transaction per-thread map size. More...

int	TxXidMapSize `[get]`
	Gets transaction per-Xid map size. More...

int	TxCommitQueueSize `[get]`
	Gets committed transaction queue size. More...

int	TxPrepareQueueSize `[get]`
	Gets prepared transaction queue size. More...

int	TxStartVersionCountsSize `[get]`
	Gets start version counts map size. More...

int	TxCommittedVersionsSize `[get]`
	Gets number of cached committed transaction IDs. More...

int	TxRolledbackVersionsSize `[get]`
	Gets number of cached rolled back transaction IDs. More...

int	TxDhtThreadMapSize `[get]`
	Gets transaction DHT per-thread map size. More...

int	TxDhtXidMapSize `[get]`
	Gets transaction DHT per-Xid map size. More...

int	TxDhtCommitQueueSize `[get]`
	Gets committed DHT transaction queue size. More...

int	TxDhtPrepareQueueSize `[get]`
	Gets prepared DHT transaction queue size. More...

int	TxDhtStartVersionCountsSize `[get]`
	Gets DHT start version counts map size. More...

int	TxDhtCommittedVersionsSize `[get]`
	Gets number of cached committed DHT transaction IDs. More...

int	TxDhtRolledbackVersionsSize `[get]`
	Gets number of cached rolled back DHT transaction IDs. More...

bool	IsWriteBehindEnabled `[get]`
	Returns true if write-behind is enabled. More...

int	WriteBehindFlushSize `[get]`
	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. More...

int	WriteBehindFlushThreadCount `[get]`
	Gets the number of flush threads that will perform store update operations. More...

long	WriteBehindFlushFrequency `[get]`
	Gets the cache flush frequency. All pending operations on the underlying store will be performed within time interval not less then this value. More...

int	WriteBehindStoreBatchSize `[get]`
	Gets the maximum count of similar (put or remove) operations that can be grouped to a single batch. More...

int	WriteBehindTotalCriticalOverflowCount `[get]`
	Gets count of write buffer overflow events since initialization. Each overflow event causes the ongoing flush operation to be performed synchronously. More...

int	WriteBehindCriticalOverflowCount `[get]`
	Gets count of write buffer overflow events in progress at the moment. Each overflow event causes the ongoing flush operation to be performed synchronously. More...

int	WriteBehindErrorRetryCount `[get]`
	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. More...

int	WriteBehindBufferSize `[get]`
	Gets count of entries that were processed by the write-behind store and have not been flushed to the underlying store yet. More...

string	KeyType `[get]`
	Determines the required type of keys for this cache, if any. More...

string	ValueType `[get]`
	Determines the required type of values for this cache, if any. More...

bool	IsStoreByValue `[get]`
	Whether storeByValue true or storeByReference false. When true, both keys and values are stored by value. More...

bool	IsStatisticsEnabled `[get]`
	Checks whether statistics collection is enabled in this cache. More...

bool	IsManagementEnabled `[get]`
	Checks whether management is enabled on this cache. More...

bool	IsReadThrough `[get]`
	Determines if a cache should operate in read-through mode. More...

bool	IsWriteThrough `[get]`
	Determines if a cache should operate in "write-through" mode. More...

Detailed Description

Property Documentation

float Apache.Ignite.Core.Cache.ICacheMetrics.AverageGetTime

get

Returns: The time in ms.

float Apache.Ignite.Core.Cache.ICacheMetrics.AveragePutTime

get

Returns: The time in s.

float Apache.Ignite.Core.Cache.ICacheMetrics.AverageRemoveTime

get

Returns: The time in ms.

float Apache.Ignite.Core.Cache.ICacheMetrics.AverageTxCommitTime

get

Returns: The time in ms.

float Apache.Ignite.Core.Cache.ICacheMetrics.AverageTxRollbackTime

get

Returns: Number of transaction rollbacks.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheEvictions

get

Returns: The number of evictions.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheGets

get

Returns: The number of gets.

float Apache.Ignite.Core.Cache.ICacheMetrics.CacheHitPercentage

get

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

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheHits

get

Returns: The number of hits.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheMisses

get

Returns: The number of misses.

float Apache.Ignite.Core.Cache.ICacheMetrics.CacheMissPercentage

get

Returns: The percentage of accesses that failed to find anything.

string Apache.Ignite.Core.Cache.ICacheMetrics.CacheName

get

Returns: Cache name.

long Apache.Ignite.Core.Cache.ICacheMetrics.CachePuts

get

Returns: The number of puts.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheRemovals

get

Returns: The number of removals.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheTxCommits

get

Returns: Number of transaction commits.

long Apache.Ignite.Core.Cache.ICacheMetrics.CacheTxRollbacks

get

Returns: Number of transaction rollbacks.

int Apache.Ignite.Core.Cache.ICacheMetrics.DhtEvictQueueCurrentSize

get

Returns: Current size of evict queue.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsEmpty

get

Returns: True if this cache is empty.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsManagementEnabled

get

The default value is false.

Returns: True if management is enabled.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsReadThrough

get

The default value is false

Returns: True when a cache is in "read-through" mode.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsStatisticsEnabled

get

The default value is false.

Returns: True if statistics collection is enabled.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsStoreByValue

get

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.

Returns: True if the cache is store by value.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsWriteBehindEnabled

get

Returns: True if write-behind is enabled.

bool Apache.Ignite.Core.Cache.ICacheMetrics.IsWriteThrough

get

Will appropriately cause the configured CacheWriter to be invoked.

The default value is false

Returns: True when a cache is in "write-through" mode.

int Apache.Ignite.Core.Cache.ICacheMetrics.KeySize

get

Returns: Number of keys in the cache.

string Apache.Ignite.Core.Cache.ICacheMetrics.KeyType

get

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

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapAllocatedSize

get

Returns: Memory size allocated in off-heap.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapBackupEntriesCount

get

Returns: Number of backup entries stored in off-heap memory.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapEntriesCount

get

Returns: Number of entries stored in off-heap memory.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapEvictions

get

Returns: The number of evictions.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapGets

get

Returns: The number of gets.

float Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapHitPercentage

get

Returns: The percentage of hits on off-heap memory.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapHits

get

Returns: The off-heap hits number.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapMaxSize

get

Returns: Off-heap memory maximum size.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapMisses

get

Returns: The off-heap misses number.

float Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapMissPercentage

get

Returns: The percentage of misses on off-heap memory.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapPrimaryEntriesCount

get

Returns: Number of primary entries stored in off-heap memory.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapPuts

get

Returns: The number of puts.

long Apache.Ignite.Core.Cache.ICacheMetrics.OffHeapRemovals

get

Returns: The number of removals.

long Apache.Ignite.Core.Cache.ICacheMetrics.OverflowSize

get

Returns: Number of entries that was swapped to disk.

int Apache.Ignite.Core.Cache.ICacheMetrics.Size

get

Returns: Number of non-null values in the cache.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapEntriesCount

get

Returns: Number of entries stored in swap.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapGets

get

Returns: The number of gets from the swap.

float Apache.Ignite.Core.Cache.ICacheMetrics.SwapHitPercentage

get

Returns: The percentage of hits on swap.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapHits

get

Returns: The swap hits number.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapMisses

get

Returns: The swap misses number.

float Apache.Ignite.Core.Cache.ICacheMetrics.SwapMissPercentage

get

Returns: The percentage of misses on swap.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapPuts

get

Returns: The number of puts to the swap.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapRemovals

get

Returns: The number of removals from the swap.

long Apache.Ignite.Core.Cache.ICacheMetrics.SwapSize

get

Returns: Size of swap, in bytes.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxCommitQueueSize

get

Returns: Committed transaction queue size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxCommittedVersionsSize

get

Returns: Number of cached committed transaction IDs.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtCommitQueueSize

get

Returns: Committed DHT transaction queue size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtCommittedVersionsSize

get

Returns: Number of cached committed DHT transaction IDs.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtPrepareQueueSize

get

Returns: Prepared DHT transaction queue size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtRolledbackVersionsSize

get

Returns: Number of cached rolled back DHT transaction IDs.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtStartVersionCountsSize

get

Returns: DHT start version counts map size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtThreadMapSize

get

Returns: DHT thread map size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxDhtXidMapSize

get

Returns: Transaction DHT per-Xid map size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxPrepareQueueSize

get

Returns: Prepared transaction queue size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxRolledbackVersionsSize

get

Returns: Number of cached rolled back transaction IDs.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxStartVersionCountsSize

get

Returns: Start version counts map size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxThreadMapSize

get

Returns: Thread map size.

int Apache.Ignite.Core.Cache.ICacheMetrics.TxXidMapSize

get

Returns: Transaction per-Xid map size.

string Apache.Ignite.Core.Cache.ICacheMetrics.ValueType

get

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

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindBufferSize

get

Returns: Total count of entries in cache store internal buffer.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindCriticalOverflowCount

get

Returns: Count of cache overflow events since start.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindErrorRetryCount

get

Returns: Count of entries in store-retry state.

long Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindFlushFrequency

get

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

Returns: Flush frequency in milliseconds.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindFlushSize

get

If this value is 0, then flush is performed only on time-elapsing basis.

Returns: Buffer size that triggers flush procedure.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindFlushThreadCount

get

Returns: Count of worker threads.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindStoreBatchSize

get

Returns: Maximum size of batch.

int Apache.Ignite.Core.Cache.ICacheMetrics.WriteBehindTotalCriticalOverflowCount

get

Returns: Count of cache overflow events since start.

Properties

Detailed Description

Property Documentation