Properties | List of all members
GridGain.Cache.ICacheMetrics Interface Reference

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 OffHeapEntriesCount [get]
 Gets number of entries stored in off-heap memory. More...
 
long OffHeapAllocatedSize [get]
 Gets memory size allocated in off-heap. 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 GridGain.Cache.ICacheMetrics.AverageGetTime
get
Returns
The time in �s.
float GridGain.Cache.ICacheMetrics.AveragePutTime
get
Returns
The time in �s.
float GridGain.Cache.ICacheMetrics.AverageRemoveTime
get
Returns
The time in �s.
float GridGain.Cache.ICacheMetrics.AverageTxCommitTime
get
Returns
The time in �s.
float GridGain.Cache.ICacheMetrics.AverageTxRollbackTime
get
Returns
Number of transaction rollbacks.
long GridGain.Cache.ICacheMetrics.CacheEvictions
get
Returns
The number of evictions.
long GridGain.Cache.ICacheMetrics.CacheGets
get
Returns
The number of gets.
float GridGain.Cache.ICacheMetrics.CacheHitPercentage
get
Returns
The percentage of successful hits, as a decimal e.g 75.
long GridGain.Cache.ICacheMetrics.CacheHits
get
Returns
The number of hits
long GridGain.Cache.ICacheMetrics.CacheMisses
get
Returns
The number of misses
float GridGain.Cache.ICacheMetrics.CacheMissPercentage
get
Returns
The percentage of accesses that failed to find anything.
string GridGain.Cache.ICacheMetrics.CacheName
get
Returns
Cache name.
long GridGain.Cache.ICacheMetrics.CachePuts
get
Returns
The number of puts.
long GridGain.Cache.ICacheMetrics.CacheRemovals
get
Returns
The number of removals.
long GridGain.Cache.ICacheMetrics.CacheTxCommits
get
Returns
Number of transaction commits.
long GridGain.Cache.ICacheMetrics.CacheTxRollbacks
get
Returns
Number of transaction rollbacks.
int GridGain.Cache.ICacheMetrics.DhtEvictQueueCurrentSize
get
Returns
Current size of evict queue.
bool GridGain.Cache.ICacheMetrics.IsEmpty
get
Returns
True if this cache is empty.
bool GridGain.Cache.ICacheMetrics.IsManagementEnabled
get

The default value is false.

Returns
True if management is enabled
bool GridGain.Cache.ICacheMetrics.IsReadThrough
get

The default value is false

Returns
True when a cache is in "read-through" mode.
bool GridGain.Cache.ICacheMetrics.IsStatisticsEnabled
get

The default value is false.

Returns
True if statistics collection is enabled
bool GridGain.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 GridGain.Cache.ICacheMetrics.IsWriteBehindEnabled
get
Returns
True if write-behind is enabled.
bool GridGain.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 GridGain.Cache.ICacheMetrics.KeySize
get
Returns
Number of keys in the cache.
string GridGain.Cache.ICacheMetrics.KeyType
get
Returns
The fully qualified class name of the key type, or "java.lang.Object" if the type is undefined.
long GridGain.Cache.ICacheMetrics.OffHeapAllocatedSize
get
Returns
Memory size allocated in off-heap.
long GridGain.Cache.ICacheMetrics.OffHeapEntriesCount
get
Returns
Number of entries stored in off-heap memory.
long GridGain.Cache.ICacheMetrics.OverflowSize
get
Returns
Number of entries that was swapped to disk.
int GridGain.Cache.ICacheMetrics.Size
get
Returns
Number of non-null values in the cache.
int GridGain.Cache.ICacheMetrics.TxCommitQueueSize
get
Returns
Committed transaction queue size.
int GridGain.Cache.ICacheMetrics.TxCommittedVersionsSize
get
Returns
Number of cached committed transaction IDs.
int GridGain.Cache.ICacheMetrics.TxDhtCommitQueueSize
get
Returns
Committed DHT transaction queue size.
int GridGain.Cache.ICacheMetrics.TxDhtCommittedVersionsSize
get
Returns
Number of cached committed DHT transaction IDs.
int GridGain.Cache.ICacheMetrics.TxDhtPrepareQueueSize
get
Returns
Prepared DHT transaction queue size.
int GridGain.Cache.ICacheMetrics.TxDhtRolledbackVersionsSize
get
Returns
Number of cached rolled back DHT transaction IDs.
int GridGain.Cache.ICacheMetrics.TxDhtStartVersionCountsSize
get
Returns
DHT start version counts map size.
int GridGain.Cache.ICacheMetrics.TxDhtThreadMapSize
get
Returns
DHT thread map size.
int GridGain.Cache.ICacheMetrics.TxDhtXidMapSize
get
Returns
Transaction DHT per-Xid map size.
int GridGain.Cache.ICacheMetrics.TxPrepareQueueSize
get
Returns
Prepared transaction queue size.
int GridGain.Cache.ICacheMetrics.TxRolledbackVersionsSize
get
Returns
Number of cached rolled back transaction IDs.
int GridGain.Cache.ICacheMetrics.TxStartVersionCountsSize
get
Returns
Start version counts map size.
int GridGain.Cache.ICacheMetrics.TxThreadMapSize
get
Returns
Thread map size.
int GridGain.Cache.ICacheMetrics.TxXidMapSize
get
Returns
Transaction per-Xid map size.
string GridGain.Cache.ICacheMetrics.ValueType
get
Returns
The fully qualified class name of the value type, or "java.lang.Object" if the type is undefined.
int GridGain.Cache.ICacheMetrics.WriteBehindBufferSize
get
Returns
Total count of entries in cache store internal buffer.
int GridGain.Cache.ICacheMetrics.WriteBehindCriticalOverflowCount
get
Returns
Count of cache overflow events since start.
int GridGain.Cache.ICacheMetrics.WriteBehindErrorRetryCount
get
Returns
Count of entries in store-retry state.
long GridGain.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 GridGain.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 GridGain.Cache.ICacheMetrics.WriteBehindFlushThreadCount
get
Returns
Count of worker threads.
int GridGain.Cache.ICacheMetrics.WriteBehindStoreBatchSize
get
Returns
Maximum size of batch.
int GridGain.Cache.ICacheMetrics.WriteBehindTotalCriticalOverflowCount
get
Returns
Count of cache overflow events since start.