public interface CacheMetrics
IgniteCache.metrics()
to obtain metrics for a cache.Modifier and Type | Method and Description |
---|---|
long |
estimateRebalancingFinishTime()
Deprecated.
|
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()
Deprecated.
|
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.
|
int |
getIndexBuildPartitionsLeftCount() |
long |
getIndexRebuildKeysProcessed()
Return number of keys processed during index rebuilding.
|
int |
getKeySize()
Deprecated.
Can overflow. Use
getCacheSize() instead. |
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()
Deprecated.
Can overflow. Use
getCacheSize() instead. |
int |
getTotalPartitionsCount() |
int |
getTxCommitQueueSize()
Deprecated.
|
int |
getTxCommittedVersionsSize()
Gets number of cached committed transaction IDs.
|
int |
getTxDhtCommitQueueSize()
Deprecated.
|
int |
getTxDhtCommittedVersionsSize()
Gets number of cached committed DHT transaction IDs.
|
int |
getTxDhtPrepareQueueSize()
Deprecated.
|
int |
getTxDhtRolledbackVersionsSize()
Gets number of cached rolled back DHT transaction IDs.
|
int |
getTxDhtStartVersionCountsSize()
Deprecated.
|
int |
getTxDhtThreadMapSize()
Gets transaction DHT per-thread map size.
|
int |
getTxDhtXidMapSize()
Gets transaction DHT per-Xid map size.
|
@NotNull String |
getTxKeyCollisions()
Checks if there were any tx key collisions last time.
|
int |
getTxPrepareQueueSize()
Deprecated.
|
int |
getTxRolledbackVersionsSize()
Gets number of cached rolled back transaction IDs.
|
int |
getTxStartVersionCountsSize()
Deprecated.
|
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()
Deprecated.
|
long getCacheHits()
float getCacheHitPercentage()
long getCacheMisses()
float getCacheMissPercentage()
long getCacheGets()
long getCachePuts()
long getEntryProcessorPuts()
long getEntryProcessorRemovals()
long getEntryProcessorReadOnlyInvocations()
long getEntryProcessorInvocations()
long getEntryProcessorHits()
float getEntryProcessorHitPercentage()
long getEntryProcessorMisses()
float getEntryProcessorMissPercentage()
float getEntryProcessorAverageInvocationTime()
float getEntryProcessorMinInvocationTime()
float getEntryProcessorMaxInvocationTime()
long getCacheRemovals()
long getCacheEvictions()
float getAverageGetTime()
float getAveragePutTime()
float getAverageRemoveTime()
float getAverageTxCommitTime()
float getAverageTxRollbackTime()
long getCacheTxCommits()
long getCacheTxRollbacks()
String name()
long getOffHeapGets()
long getOffHeapPuts()
long getOffHeapRemovals()
long getOffHeapEvictions()
long getOffHeapHits()
float getOffHeapHitPercentage()
long getOffHeapMisses()
float getOffHeapMissPercentage()
long getHeapEntriesCount()
long getOffHeapEntriesCount()
long getOffHeapPrimaryEntriesCount()
long getOffHeapBackupEntriesCount()
long getOffHeapAllocatedSize()
@Deprecated int getSize()
getCacheSize()
instead.null
values in the cache.
Note this method will always return 0
null
values in the cache.long getCacheSize()
@Deprecated int getKeySize()
getCacheSize()
instead.null
values.
Note this method will always return 0
boolean isEmpty()
true
if this cache is empty.True
if this cache is empty.@Deprecated int getDhtEvictQueueCurrentSize()
int getTxThreadMapSize()
int getTxXidMapSize()
@Deprecated int getTxCommitQueueSize()
@Deprecated int getTxPrepareQueueSize()
@Deprecated int getTxStartVersionCountsSize()
int getTxCommittedVersionsSize()
int getTxRolledbackVersionsSize()
int getTxDhtThreadMapSize()
int getTxDhtXidMapSize()
@Deprecated int getTxDhtCommitQueueSize()
@Deprecated int getTxDhtPrepareQueueSize()
@Deprecated int getTxDhtStartVersionCountsSize()
int getTxDhtCommittedVersionsSize()
int getTxDhtRolledbackVersionsSize()
boolean isWriteBehindEnabled()
true
if write-behind is enabled.True
if write-behind is enabled.int getWriteBehindFlushSize()
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
int getWriteBehindFlushThreadCount()
long getWriteBehindFlushFrequency()
0
, then flush is performed only when buffer size exceeds flush size.int getWriteBehindStoreBatchSize()
int getWriteBehindTotalCriticalOverflowCount()
int getWriteBehindCriticalOverflowCount()
int getWriteBehindErrorRetryCount()
int getWriteBehindBufferSize()
String getKeyType()
Cache
, if any."java.lang.Object"
if the type is undefined.String getValueType()
Cache
, if any."java.lang.Object"
if the type is undefined.boolean isStoreByValue()
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:
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
.
True
if the cache is store by value.int getTotalPartitionsCount()
int getRebalancingPartitionsCount()
long getRebalancedKeys()
long getEstimatedRebalancingKeys()
long getKeysToRebalanceLeft()
long getRebalancingKeysRate()
long getRebalancingBytesRate()
@Deprecated long estimateRebalancingFinishTime()
getEstimatedRebalancingFinishTime()
instead.@Deprecated long rebalancingStartTime()
getRebalancingStartTime()
instead.long getEstimatedRebalancingFinishTime()
long getRebalancingStartTime()
long getRebalanceClearingPartitionsLeft()
boolean isStatisticsEnabled()
The default value is false
.
True
if statistics collection is enabled.boolean isManagementEnabled()
The default value is false
.
true
if management is enabled.boolean isReadThrough()
Cache
should operate in read-through mode.
The default value is false
True
when a Cache
is in
"read-through" mode.CacheLoader
boolean isWriteThrough()
Cache
should operate in "write-through"
mode.
will appropriately cause the configured CacheWriter
to be invoked.
The default value is false
True
when a Cache
is in "write-through" mode.CacheWriter
boolean isValidForReading()
Note: the method will return false
if any partition was lost despite the fact others can be awailable
for reading.
true
when cache topology is valid for reading.boolean isValidForWriting()
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.
true
when cache topology is valid for writing.@NotNull @NotNull String getTxKeyCollisions()
IgniteSystemProperties.IGNITE_DUMP_TX_COLLISIONS_INTERVAL
or
TransactionsMXBean.setTxKeyCollisionsInterval(int)
.boolean isIndexRebuildInProgress()
true
if index rebuild is in progress.true
if index rebuild is in progress.long getIndexRebuildKeysProcessed()
getCacheSize()
.int getIndexBuildPartitionsLeftCount()
Follow @ApacheIgnite
Ignite Database and Caching Platform : ver. 2.16.0 Release Date : December 15 2023