|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CacheSampler
An interface for exposing cache statistics.
Extends from both LiveCacheStatistics
and LegacyCacheStatistics
Method Summary | |
---|---|
void |
flush()
Flushes all cache items from memory to the disk store, and from the DiskStore to disk. |
long |
getAverageGetTime()
Gets the average get time. |
SampledRateCounter |
getAverageGetTimeSample()
Get the SampledRateCounter for average time taken for get() operation in the
cache. |
long |
getAverageSearchTime()
Gets the average search time. |
SampledRateCounter |
getAverageSearchTimeSample()
Get the SampledRateCounter for average search execution time for searches finishing within the last sample period. |
SampledCounter |
getCacheClusterOfflineSample()
Get the SampledCounter for offline cache cluster events. |
SampledCounter |
getCacheClusterOnlineSample()
Get the SampledCounter for online cache cluster events. |
SampledCounter |
getCacheClusterRejoinSample()
Get the SampledCounter for rejoin cache cluster events. |
SampledCounter |
getCacheElementEvictedSample()
Get the SampledCounter element evicted from cache. |
SampledCounter |
getCacheElementExpiredSample()
Get the SampledCounter element expired from cache. |
SampledCounter |
getCacheElementPutSample()
Get the SampledCounter element puts in the cache. |
SampledCounter |
getCacheElementRemovedSample()
Get the SampledCounter element removed from cache. |
SampledCounter |
getCacheElementUpdatedSample()
Get the SampledCounter element updates , i.e. |
long |
getCacheEvictionRate()
Gets the cache eviction rate. |
long |
getCacheExpirationRate()
Gets the cache expiration rate. |
SampledCounter |
getCacheHitInMemorySample()
Get the SampledCounter for in-memory cache hit. |
SampledCounter |
getCacheHitOffHeapSample()
Get the SampledCounter for off-heap cache hit. |
SampledCounter |
getCacheHitOnDiskSample()
Get the SampledCounter for on-disk cache hit. |
long |
getCacheHitRate()
Gets the cache hit rate. |
SampledCounter |
getCacheHitRatioSample()
Get the SampledCounter for cache hit ratio. |
SampledCounter |
getCacheHitSample()
Get the SampledCounter for cache hit. |
long |
getCacheInMemoryHitRate()
Gets the cache in memory hit rate. |
long |
getCacheInMemoryMissRate()
Gets the cache in memory miss rate. |
SampledCounter |
getCacheMissExpiredSample()
Get the SampledCounter for cache miss as result of the element getting
expired. |
SampledCounter |
getCacheMissInMemorySample()
Get the SampledCounter for in-memory cache miss. |
SampledCounter |
getCacheMissNotFoundSample()
Get the SampledCounter for cache miss as result of the element not found
in cache. |
SampledCounter |
getCacheMissOffHeapSample()
Get the SampledCounter for off-heap cache miss. |
SampledCounter |
getCacheMissOnDiskSample()
Get the SampledCounter for on-disk cache miss. |
long |
getCacheMissRate()
Gets the cache miss rate. |
SampledCounter |
getCacheMissSample()
Get the SampledCounter for cache miss. |
long |
getCacheOffHeapHitRate()
Gets the cache off heap hit rate. |
long |
getCacheOffHeapMissRate()
Gets the cache off heap miss rate. |
long |
getCacheOnDiskHitRate()
Gets the cache on disk hit rate. |
long |
getCacheOnDiskMissRate()
Gets the cache on disk miss rate. |
long |
getCachePutRate()
Gets the cache put rate. |
long |
getCacheRemoveRate()
Gets the cache remove rate. |
long |
getCacheSearchRate()
Gets the cache search rate. |
long |
getCacheUpdateRate()
Gets the cache update rate. |
SampledCounter |
getCacheXaCommitsSample()
Get the SampledCounter for number of XA Transaction commits that have completed in the interval. |
SampledCounter |
getCacheXaRollbacksSample()
Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval. |
long |
getDiskExpiryThreadIntervalSeconds()
Configuration property accessor |
boolean |
getHasWriteBehindWriter()
Is there a registered Write-behind CacheWriter. |
SampledCounter |
getLocalDiskSizeInBytesSample()
Get the SampledCounter for local disk size in bytes. |
SampledCounter |
getLocalDiskSizeSample()
Get the SampledCounter for local disk size. |
SampledCounter |
getLocalHeapSizeInBytesSample()
Get the SampledCounter for local heap size in bytes. |
SampledCounter |
getLocalHeapSizeSample()
Get the SampledCounter for local heap size. |
SampledCounter |
getLocalOffHeapSizeInBytesSample()
Get the SampledCounter for local offheap size in bytes. |
SampledCounter |
getLocalOffHeapSizeSample()
Get the SampledCounter for local offheap size. |
long |
getMaxBytesLocalDisk()
Configuration property accessor. |
String |
getMaxBytesLocalDiskAsString()
Configuration property accessor. |
long |
getMaxBytesLocalHeap()
Configuration property accessor. |
String |
getMaxBytesLocalHeapAsString()
Configuration property accessor. |
long |
getMaxBytesLocalOffHeap()
Configuration property accessor. |
String |
getMaxBytesLocalOffHeapAsString()
Configuration property accessor. |
int |
getMaxElementsOnDisk()
Configuration property accessor. |
long |
getMaxEntriesInCache()
Configuration property accessor. |
long |
getMaxEntriesLocalDisk()
Configuration property accessor. |
long |
getMaxEntriesLocalHeap()
Configuration property accessor. |
String |
getMemoryStoreEvictionPolicy()
Configuration property accessor. |
long |
getMostRecentRejoinTimeStampMillis()
Get the timestamp in nanos of the last rejoin. |
SampledCounter |
getMostRecentRejoinTimestampMillisSample()
Get the SampledCounter for last rejoin timestamp. |
long |
getNonStopFailureRate()
Gets the non stop failure most recent sample. |
SampledCounter |
getNonStopFailureSample()
Gets the nonstop failure sample. |
long |
getNonStopRejoinTimeoutRate()
Gets the non stop rejoin most recent sample. |
SampledCounter |
getNonStopRejoinTimeoutSample()
Gets the nonstop rejoin sample. |
long |
getNonStopSuccessRate()
Gets the non stop success most recent sample. |
SampledCounter |
getNonStopSuccessSample()
Gets the nonstop success sample. |
long |
getNonStopTimeoutRate()
Gets the non stop timeout most recent sample. |
SampledCounter |
getNonStopTimeoutSample()
Gets the nonstop timeout sample. |
String |
getPersistenceStrategy()
getPersistenceStrategy |
String |
getPinnedToStore()
Configuration property accessor. |
SampledCounter |
getPutIfAbsentMissSample()
Gets the putIfAbsent miss sample |
SampledCounter |
getPutIfAbsentSuccessSample()
Gets the putIfAbsent success sample |
SampledCounter |
getRemoteSizeSample()
Get the SampledCounter for remote size. |
SampledCounter |
getRemoveElementMissSample()
Gets the removeElement miss sample |
SampledCounter |
getRemoveElementSuccessSample()
Gets the removeElement success sample |
SampledCounter |
getReplaceOneArgMissSample()
Gets the one arg replace miss sample |
SampledCounter |
getReplaceOneArgSuccessSample()
Gets the one arg replace success sample |
SampledCounter |
getReplaceTwoArgMissSample()
Gets the two arg replace miss sample |
SampledCounter |
getReplaceTwoArgSuccessSample()
Gets the two arg replace success sample |
boolean |
getSearchable()
Is the cache configured for search. |
Map<String,String> |
getSearchAttributes()
Get the declared search attributes and their type names. |
SampledCounter |
getSearchesPerSecondSample()
Get the SampledCounter for number of searches that have finished in the interval. |
SampledCounter |
getSizeSample()
Get the SampledCounter for cache size. |
String |
getStatus()
Gets the status attribute of the Cache. |
String |
getTerracottaConsistency()
Returns a textual description of a Terracotta-clustered cache's consistency mode. |
long |
getTimeToIdleSeconds()
Configuration property accessor. |
long |
getTimeToLiveSeconds()
Configuration property accessor. |
boolean |
getTransactional()
Is the cache a transactional one. |
long |
getTransactionCommitRate()
Gets the transaction commit rate. |
long |
getTransactionRollbackRate()
Gets the transaction rollback rate. |
int |
getWriterConcurrency()
Returns the number of configured write-behind queues/threads. |
int |
getWriterMaxQueueSize()
Returns the maximum size of any write-behind queues. |
long |
getWriterQueueLength()
Returns the total length of all write-behind queues for this cache. |
SampledCounter |
getWriterQueueLengthSample()
Get the SampledCounter for writer queue length. |
boolean |
isClusterBulkLoadEnabled()
Is the cache in bulk-load mode cluster-wide?. |
boolean |
isDiskPersistent()
Configuration property accessor. |
boolean |
isEnabled()
Is the cache enabled?. |
boolean |
isEternal()
Configuration property accessor. |
boolean |
isLoggingEnabled()
Configuration property accessor. |
boolean |
isNodeBulkLoadEnabled()
Is the cache in bulk-load mode locally?. |
boolean |
isOverflowToDisk()
Configuration property accessor. |
boolean |
isOverflowToOffHeap()
isOverflowToOffHeap |
boolean |
isPinned()
Configuration property accessor. |
boolean |
isTerracottaClustered()
Is the cache configured with Terracotta clustering?. |
void |
removeAll()
Removes all cached items. |
void |
setDiskExpiryThreadIntervalSeconds(long seconds)
setDiskExpiryThreadIntervalSeconds. |
void |
setDiskPersistent(boolean diskPersistent)
setDiskPersistent. |
void |
setEnabled(boolean enabled)
Enabled/disable the cache. |
void |
setEternal(boolean eternal)
setEternal. |
void |
setLoggingEnabled(boolean enabled)
setLoggingEnabled. |
void |
setMaxBytesLocalDisk(long maxBytes)
setMaxBytesLocalDisk. |
void |
setMaxBytesLocalDiskAsString(String maxBytes)
setMaxBytesLocalDisk. |
void |
setMaxBytesLocalHeap(long maxBytes)
setMaxBytesLocalHeap. |
void |
setMaxBytesLocalHeapAsString(String maxBytes)
setMaxBytesLocalHeap. |
void |
setMaxElementsOnDisk(int maxElements)
setMaxElementsOnDisk. |
void |
setMaxEntriesInCache(long maxEntries)
setMaxEntriesInCache. |
void |
setMaxEntriesLocalDisk(long maxEntries)
setMaxEntriesLocalDisk. |
void |
setMaxEntriesLocalHeap(long maxEntries)
setMaxEntriesLocalHeap. |
void |
setMemoryStoreEvictionPolicy(String evictionPolicy)
setMemoryStoreEvictionPolicy. |
void |
setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
Enabled/disable bulk-load mode for this node. |
void |
setOverflowToDisk(boolean overflowToDisk)
setOverflowToDisk. |
void |
setTimeToIdleSeconds(long tti)
setTimeToIdleSeconds. |
void |
setTimeToLiveSeconds(long ttl)
setTimeToLiveSeconds. |
Method Detail |
---|
boolean isEnabled()
void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
bulkLoadEnabled
- the new node bulk load enabledboolean isClusterBulkLoadEnabled()
boolean isNodeBulkLoadEnabled()
void setEnabled(boolean enabled)
enabled
- the new enabledvoid removeAll()
void flush()
String getStatus()
boolean isTerracottaClustered()
String getTerracottaConsistency()
long getMaxEntriesLocalHeap()
void setMaxEntriesLocalHeap(long maxEntries)
maxEntries
- the new max entries local heaplong getMaxBytesLocalHeap()
void setMaxBytesLocalHeap(long maxBytes)
maxBytes
- the new max bytes local heapvoid setMaxBytesLocalHeapAsString(String maxBytes)
maxBytes
- the new max bytes local heap as stringString getMaxBytesLocalHeapAsString()
long getMaxBytesLocalOffHeap()
String getMaxBytesLocalOffHeapAsString()
long getMaxEntriesLocalDisk()
void setMaxEntriesLocalDisk(long maxEntries)
maxEntries
- the new max entries local diskint getMaxElementsOnDisk()
long getMaxEntriesInCache()
void setMaxElementsOnDisk(int maxElements)
maxElements
- the new max elements on diskvoid setMaxEntriesInCache(long maxEntries)
maxEntries
- the new max entries in cachelong getMaxBytesLocalDisk()
void setMaxBytesLocalDisk(long maxBytes)
maxBytes
- the new max bytes local diskvoid setMaxBytesLocalDiskAsString(String maxBytes)
maxBytes
- the new max bytes local disk as stringString getMaxBytesLocalDiskAsString()
String getMemoryStoreEvictionPolicy()
void setMemoryStoreEvictionPolicy(String evictionPolicy)
evictionPolicy
- the new memory store eviction policyboolean isEternal()
void setEternal(boolean eternal)
eternal
- the new eternallong getTimeToIdleSeconds()
void setTimeToIdleSeconds(long tti)
tti
- the new time to idle secondslong getTimeToLiveSeconds()
void setTimeToLiveSeconds(long ttl)
ttl
- the new time to live secondsboolean isOverflowToDisk()
void setOverflowToDisk(boolean overflowToDisk)
overflowToDisk
- the new overflow to diskboolean isDiskPersistent()
void setDiskPersistent(boolean diskPersistent)
diskPersistent
- the new disk persistentboolean isOverflowToOffHeap()
String getPersistenceStrategy()
PersistenceConfiguration
long getDiskExpiryThreadIntervalSeconds()
void setDiskExpiryThreadIntervalSeconds(long seconds)
seconds
- the new disk expiry thread interval secondsboolean isLoggingEnabled()
void setLoggingEnabled(boolean enabled)
enabled
- the new logging enabledboolean isPinned()
PinningConfiguration
String getPinnedToStore()
PinningConfiguration
boolean getHasWriteBehindWriter()
long getWriterQueueLength()
getWriterQueueLength
in interface LegacyCacheStatistics
long getMostRecentRejoinTimeStampMillis()
int getWriterMaxQueueSize()
CacheWriterConfiguration.getWriteBehindMaxQueueSize()
int getWriterConcurrency()
CacheWriterConfiguration.getWriteBehindConcurrency()
boolean getTransactional()
CacheConfiguration.TransactionalMode
long getTransactionCommitRate()
long getTransactionRollbackRate()
boolean getSearchable()
Searchable
Map<String,String> getSearchAttributes()
long getCacheSearchRate()
long getAverageSearchTime()
long getCacheHitRate()
long getCacheInMemoryHitRate()
long getCacheOffHeapHitRate()
long getCacheOnDiskHitRate()
long getCacheMissRate()
long getCacheInMemoryMissRate()
long getCacheOffHeapMissRate()
long getCacheOnDiskMissRate()
long getCachePutRate()
long getCacheUpdateRate()
long getCacheRemoveRate()
long getCacheEvictionRate()
long getCacheExpirationRate()
long getAverageGetTime()
SampledCounter getCacheHitSample()
SampledCounter
for cache hit.
SampledCounter
for cache hit countSampledCounter getCacheHitRatioSample()
SampledCounter
for cache hit ratio.
SampledCounter
for cache hit ratioSampledCounter getCacheHitInMemorySample()
SampledCounter
for in-memory cache hit.
SampledCounter
for cache hit count in memorySampledCounter getCacheHitOffHeapSample()
SampledCounter
for off-heap cache hit.
SampledCounter
for cache hit count in off-heapSampledCounter getCacheHitOnDiskSample()
SampledCounter
for on-disk cache hit.
SampledCounter
for cache hit count on diskSampledCounter getCacheMissSample()
SampledCounter
for cache miss.
SampledCounter
for cache miss countSampledCounter getCacheMissInMemorySample()
SampledCounter
for in-memory cache miss.
SampledCounter
for cache miss count in memorySampledCounter getCacheMissOffHeapSample()
SampledCounter
for off-heap cache miss.
SampledCounter
for cache miss count in off-heapSampledCounter getCacheMissOnDiskSample()
SampledCounter
for on-disk cache miss.
SampledCounter
for cache miss count on diskSampledCounter getCacheMissExpiredSample()
SampledCounter
for cache miss as result of the element getting
expired.
SampledCounter
for cache miss count and the reason for miss
being the element got expiredSampledCounter getCacheMissNotFoundSample()
SampledCounter
for cache miss as result of the element not found
in cache.
SampledCounter
for cache miss not found countSampledCounter getCacheElementEvictedSample()
SampledCounter
element evicted from cache.
SampledCounter
for element evicted countSampledCounter getCacheElementRemovedSample()
SampledCounter
element removed from cache.
SampledCounter
for element removed countSampledCounter getCacheElementExpiredSample()
SampledCounter
element expired from cache.
SampledCounter getCacheElementPutSample()
SampledCounter
element puts in the cache.
SampledCounter
for number of element putsSampledCounter getCacheElementUpdatedSample()
SampledCounter
element updates , i.e. put() on elements with
already existing keys in the cache
SampledCounter
d value for element update countSampledRateCounter getAverageGetTimeSample()
SampledRateCounter
for average time taken for get() operation in the
cache.
SampledRateCounter
of average get time taken for a get operationSampledRateCounter getAverageSearchTimeSample()
SampledRateCounter
for average search execution time for searches finishing within the last sample period.
SampledRateCounter
of average search time takenSampledCounter getSearchesPerSecondSample()
SampledCounter
for number of searches that have finished in the interval.
SampledCounter
for number of searchesSampledCounter getCacheXaCommitsSample()
SampledCounter
for number of XA Transaction commits that have completed in the interval.
SampledCounter
for number XA Transaction commitsSampledCounter getCacheXaRollbacksSample()
SampledCounter
for number of XA Transaction rollbacks that have completed in the interval.
SampledCounter
for number XA Transaction rollbacksSampledCounter getSizeSample()
SampledCounter
for cache size.
SampledCounter
for cache sizeSampledCounter getLocalHeapSizeSample()
SampledCounter
for local heap size.
SampledCounter
for local heap sizeSampledCounter getLocalHeapSizeInBytesSample()
SampledCounter
for local heap size in bytes.
SampledCounter
for local heap size in bytesSampledCounter getLocalOffHeapSizeSample()
SampledCounter
for local offheap size.
SampledCounter
for local offheap sizeSampledCounter getLocalOffHeapSizeInBytesSample()
SampledCounter
for local offheap size in bytes.
SampledCounter
for local offheap size in bytesSampledCounter getLocalDiskSizeSample()
SampledCounter
for local disk size.
SampledCounter
for local disk sizeSampledCounter getLocalDiskSizeInBytesSample()
SampledCounter
for local disk size in bytes.
SampledCounter
for local disk size in bytesSampledCounter getRemoteSizeSample()
SampledCounter
for remote size.
SampledCounter
for remote sizeSampledCounter getWriterQueueLengthSample()
SampledCounter
for writer queue length.
SampledCounter
for writer queue lengthSampledCounter getMostRecentRejoinTimestampMillisSample()
SampledCounter
for last rejoin timestamp.
SampledCounter
for last rejoin timestampSampledCounter getCacheClusterOfflineSample()
SampledCounter
for offline cache cluster events.
SampledCounter
for offline cache cluster eventsSampledCounter getCacheClusterOnlineSample()
SampledCounter
for online cache cluster events.
SampledCounter
for online cache cluster eventsSampledCounter getCacheClusterRejoinSample()
SampledCounter
for rejoin cache cluster events.
SampledCounter
for rejoin cache cluster eventsSampledCounter getNonStopSuccessSample()
SampledCounter getNonStopFailureSample()
SampledCounter getNonStopRejoinTimeoutSample()
SampledCounter getNonStopTimeoutSample()
long getNonStopSuccessRate()
long getNonStopFailureRate()
long getNonStopRejoinTimeoutRate()
long getNonStopTimeoutRate()
SampledCounter getReplaceOneArgSuccessSample()
SampledCounter getReplaceOneArgMissSample()
SampledCounter getReplaceTwoArgSuccessSample()
SampledCounter getReplaceTwoArgMissSample()
SampledCounter getPutIfAbsentSuccessSample()
SampledCounter getPutIfAbsentMissSample()
SampledCounter getRemoveElementSuccessSample()
SampledCounter getRemoveElementMissSample()
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |