Package org.infinispan.interceptors.impl

Class CacheMgmtInterceptor

java.lang.Object

org.infinispan.interceptors.BaseAsyncInterceptor

org.infinispan.interceptors.DDAsyncInterceptor

org.infinispan.interceptors.impl.JmxStatsCommandInterceptor

org.infinispan.interceptors.impl.CacheMgmtInterceptor

All Implemented Interfaces:

Visitor, AsyncInterceptor, JmxStatisticsExposer, CustomMetricsSupplier

@MBean(objectName="Statistics",
       description="General statistics such as timings, hit/miss ratio, and so on.")
public final class CacheMgmtInterceptor
extends JmxStatsCommandInterceptor
implements CustomMetricsSupplier

Captures cache management statistics.

Since:

9.0

Author:

Jerry Gauthier

Field Summary

Fields inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

cacheConfiguration

Constructor Summary

Constructors

Constructor	Description
CacheMgmtInterceptor()

Method Summary

Modifier and Type	Method	Description
void	addDataRead(boolean foundValue, long timeNanoSeconds, Ownership ownership)
void	addEvictions(long numEvictions)
static int	calculateRequiredMinimumNumberOfNodes(AdvancedCache<?,?> cache, ComponentRegistry componentRegistry)
long	getApproximateEntries()
long	getApproximateEntriesInMemory()
long	getApproximateEntriesUnique()
long	getAverageReadTime()
long	getAverageReadTimeNanos()
long	getAverageRemoveTime()
long	getAverageRemoveTimeNanos()
long	getAverageWriteTime()
long	getAverageWriteTimeNanos()
Collection<org.infinispan.commons.stat.MetricInfo>	getCustomMetrics(GlobalMetricsConfiguration configuration)	Extra metrics to be registered.
long	getDataMemoryUsed()
long	getEvictions()
double	getHitRatio()
long	getHits()
long	getMisses()
int	getNumberOfEntries()	Deprecated, for removal: This API element is subject to removal in a future version.
int	getNumberOfEntriesInMemory()	Deprecated, for removal: This API element is subject to removal in a future version.
long	getOffHeapMemoryUsed()
double	getReadWriteRatio()
long	getRemoveHits()
long	getRemoveMisses()
int	getRequiredMinimumNumberOfNodes()
long	getStores()
long	getTimeSinceReset()
long	getTimeSinceStart()
void	resetStatistics()	Resets statistics gathered.
void	start()
Object	visitComputeCommand(InvocationContext ctx, ComputeCommand command)
Object	visitComputeIfAbsentCommand(InvocationContext ctx, ComputeIfAbsentCommand command)
Object	visitEvictCommand(InvocationContext ctx, EvictCommand command)
Object	visitGetAllCommand(InvocationContext ctx, GetAllCommand command)
Object	visitGetCacheEntryCommand(InvocationContext ctx, GetCacheEntryCommand command)
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command)
Object	visitIracPutKeyValueCommand(InvocationContext ctx, IracPutKeyValueCommand command)
Object	visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command)
Object	visitPutMapCommand(InvocationContext ctx, PutMapCommand command)
Object	visitReadOnlyKeyCommand(InvocationContext ctx, ReadOnlyKeyCommand command)
Object	visitReadOnlyManyCommand(InvocationContext ctx, ReadOnlyManyCommand command)
Object	visitReadWriteKeyCommand(InvocationContext ctx, ReadWriteKeyCommand command)
Object	visitReadWriteKeyValueCommand(InvocationContext ctx, ReadWriteKeyValueCommand command)
Object	visitReadWriteManyCommand(InvocationContext ctx, ReadWriteManyCommand command)
Object	visitReadWriteManyEntriesCommand(InvocationContext ctx, ReadWriteManyEntriesCommand command)
Object	visitRemoveCommand(InvocationContext ctx, RemoveCommand command)
Object	visitReplaceCommand(InvocationContext ctx, ReplaceCommand command)
Object	visitWriteOnlyKeyCommand(InvocationContext ctx, WriteOnlyKeyCommand command)
Object	visitWriteOnlyKeyValueCommand(InvocationContext ctx, WriteOnlyKeyValueCommand command)

Methods inherited from class org.infinispan.interceptors.impl.JmxStatsCommandInterceptor

getStatisticsEnabled, onStart, setStatisticsEnabled

Methods inherited from class org.infinispan.interceptors.DDAsyncInterceptor

handleDefault, visitClearCommand, visitCommand, visitCommitCommand, visitEntrySetCommand, visitInvalidateCommand, visitInvalidateL1Command, visitKeySetCommand, visitLockControlCommand, visitPrepareCommand, visitRollbackCommand, visitSizeCommand, visitTouchCommand, visitUnknownCommand, visitWriteOnlyManyCommand, visitWriteOnlyManyEntriesCommand

Methods inherited from class org.infinispan.interceptors.BaseAsyncInterceptor

asyncInvokeNext, asyncInvokeNext, asyncInvokeNext, asyncValue, delayedNull, delayedValue, delayedValue, invokeNext, invokeNextAndExceptionally, invokeNextAndFinally, invokeNextAndHandle, invokeNextThenAccept, invokeNextThenApply, isSuccessfullyDone, makeStage, setNextInterceptor, valueOrException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.Visitor

visitRemoveExpiredCommand

Constructor Details

CacheMgmtInterceptor

public CacheMgmtInterceptor()

Method Details

start

public void start()

getCustomMetrics

public Collection<org.infinispan.commons.stat.MetricInfo> getCustomMetrics(GlobalMetricsConfiguration configuration)

Description copied from interface: CustomMetricsSupplier

Extra metrics to be registered.

These can be dynamic metrics that cannot use ManagedAttribute annotation. Extra tags can be set in MBeanMetadata.AttributeMetadata.

Specified by:

getCustomMetrics in interface CustomMetricsSupplier

Parameters:

configuration - The GlobalMetricsConfiguration. Implementation can make decision based on GlobalMetricsConfiguration.namesAsTags() or GlobalMetricsConfiguration.histograms().

Returns:

A list of MBeanMetadata.AttributeMetadata to be registered.

visitEvictCommand

public Object visitEvictCommand(InvocationContext ctx,
 EvictCommand command)
                         throws Throwable

Specified by:

visitEvictCommand in interface Visitor

Overrides:

visitEvictCommand in class DDAsyncInterceptor

Throws:

Throwable

visitGetKeyValueCommand

public Object visitGetKeyValueCommand(InvocationContext ctx,
 GetKeyValueCommand command)

Specified by:

visitGetKeyValueCommand in interface Visitor

Overrides:

visitGetKeyValueCommand in class DDAsyncInterceptor

visitGetCacheEntryCommand

public Object visitGetCacheEntryCommand(InvocationContext ctx,
 GetCacheEntryCommand command)

Specified by:

visitGetCacheEntryCommand in interface Visitor

Overrides:

visitGetCacheEntryCommand in class DDAsyncInterceptor

addDataRead

public void addDataRead(boolean foundValue,
 long timeNanoSeconds,
 Ownership ownership)

visitGetAllCommand

public Object visitGetAllCommand(InvocationContext ctx,
 GetAllCommand command)

Specified by:

visitGetAllCommand in interface Visitor

Overrides:

visitGetAllCommand in class DDAsyncInterceptor

visitPutMapCommand

public Object visitPutMapCommand(InvocationContext ctx,
 PutMapCommand command)

Specified by:

visitPutMapCommand in interface Visitor

Overrides:

visitPutMapCommand in class DDAsyncInterceptor

visitPutKeyValueCommand

public Object visitPutKeyValueCommand(InvocationContext ctx,
 PutKeyValueCommand command)

Specified by:

visitPutKeyValueCommand in interface Visitor

Overrides:

visitPutKeyValueCommand in class DDAsyncInterceptor

visitIracPutKeyValueCommand

public Object visitIracPutKeyValueCommand(InvocationContext ctx,
 IracPutKeyValueCommand command)
                                   throws Throwable

Specified by:

visitIracPutKeyValueCommand in interface Visitor

Overrides:

visitIracPutKeyValueCommand in class DDAsyncInterceptor

Throws:

Throwable

visitReplaceCommand

public Object visitReplaceCommand(InvocationContext ctx,
 ReplaceCommand command)

Specified by:

visitReplaceCommand in interface Visitor

Overrides:

visitReplaceCommand in class DDAsyncInterceptor

visitComputeCommand

public Object visitComputeCommand(InvocationContext ctx,
 ComputeCommand command)

Specified by:

visitComputeCommand in interface Visitor

Overrides:

visitComputeCommand in class DDAsyncInterceptor

visitComputeIfAbsentCommand

public Object visitComputeIfAbsentCommand(InvocationContext ctx,
 ComputeIfAbsentCommand command)

Specified by:

visitComputeIfAbsentCommand in interface Visitor

Overrides:

visitComputeIfAbsentCommand in class DDAsyncInterceptor

visitReadOnlyKeyCommand

public Object visitReadOnlyKeyCommand(InvocationContext ctx,
 ReadOnlyKeyCommand command)

Specified by:

visitReadOnlyKeyCommand in interface Visitor

Overrides:

visitReadOnlyKeyCommand in class DDAsyncInterceptor

visitReadOnlyManyCommand

public Object visitReadOnlyManyCommand(InvocationContext ctx,
 ReadOnlyManyCommand command)

Specified by:

visitReadOnlyManyCommand in interface Visitor

Overrides:

visitReadOnlyManyCommand in class DDAsyncInterceptor

visitWriteOnlyKeyCommand

public Object visitWriteOnlyKeyCommand(InvocationContext ctx,
 WriteOnlyKeyCommand command)

Specified by:

visitWriteOnlyKeyCommand in interface Visitor

Overrides:

visitWriteOnlyKeyCommand in class DDAsyncInterceptor

visitReadWriteKeyValueCommand

public Object visitReadWriteKeyValueCommand(InvocationContext ctx,
 ReadWriteKeyValueCommand command)

Specified by:

visitReadWriteKeyValueCommand in interface Visitor

Overrides:

visitReadWriteKeyValueCommand in class DDAsyncInterceptor

visitReadWriteKeyCommand

public Object visitReadWriteKeyCommand(InvocationContext ctx,
 ReadWriteKeyCommand command)

Specified by:

visitReadWriteKeyCommand in interface Visitor

Overrides:

visitReadWriteKeyCommand in class DDAsyncInterceptor

visitWriteOnlyKeyValueCommand

public Object visitWriteOnlyKeyValueCommand(InvocationContext ctx,
 WriteOnlyKeyValueCommand command)

Specified by:

visitWriteOnlyKeyValueCommand in interface Visitor

Overrides:

visitWriteOnlyKeyValueCommand in class DDAsyncInterceptor

visitReadWriteManyCommand

public Object visitReadWriteManyCommand(InvocationContext ctx,
 ReadWriteManyCommand command)

Specified by:

visitReadWriteManyCommand in interface Visitor

Overrides:

visitReadWriteManyCommand in class DDAsyncInterceptor

visitReadWriteManyEntriesCommand

public Object visitReadWriteManyEntriesCommand(InvocationContext ctx,
 ReadWriteManyEntriesCommand command)

Specified by:

visitReadWriteManyEntriesCommand in interface Visitor

Overrides:

visitReadWriteManyEntriesCommand in class DDAsyncInterceptor

visitRemoveCommand

public Object visitRemoveCommand(InvocationContext ctx,
 RemoveCommand command)

Specified by:

visitRemoveCommand in interface Visitor

Overrides:

visitRemoveCommand in class DDAsyncInterceptor

getHits

@ManagedAttribute(description="Number of cache attribute hits",
                  displayName="Number of cache hits",
                  measurementType=TRENDSUP)
public long getHits()

getMisses

@ManagedAttribute(description="Number of cache attribute misses",
                  displayName="Number of cache misses",
                  measurementType=TRENDSUP)
public long getMisses()

getRemoveHits

@ManagedAttribute(description="Number of cache removal hits",
                  displayName="Number of cache removal hits",
                  measurementType=TRENDSUP)
public long getRemoveHits()

getRemoveMisses

@ManagedAttribute(description="Number of cache removals where keys were not found",
                  displayName="Number of cache removal misses",
                  measurementType=TRENDSUP)
public long getRemoveMisses()

getStores

@ManagedAttribute(description="Number of cache attribute put operations",
                  displayName="Number of cache puts",
                  measurementType=TRENDSUP)
public long getStores()

getEvictions

@ManagedAttribute(description="Number of cache eviction operations",
                  displayName="Number of cache evictions",
                  measurementType=TRENDSUP)
public long getEvictions()

getHitRatio

@ManagedAttribute(description="Percentage hit/(hit+miss) ratio for the cache",
                  displayName="Hit ratio",
                  units=PERCENTAGE)
public double getHitRatio()

getReadWriteRatio

@ManagedAttribute(description="Read/writes ratio for the cache",
                  displayName="Read/write ratio",
                  units=PERCENTAGE)
public double getReadWriteRatio()

getAverageReadTime

@ManagedAttribute(description="Average number of milliseconds for a read operation on the cache",
                  displayName="Average read time",
                  units=MILLISECONDS)
public long getAverageReadTime()

getAverageReadTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a read operation on the cache",
                  displayName="Average read time",
                  units=NANOSECONDS)
public long getAverageReadTimeNanos()

getAverageWriteTime

@ManagedAttribute(description="Average number of milliseconds for a write operation in the cache",
                  displayName="Average write time",
                  units=MILLISECONDS)
public long getAverageWriteTime()

getAverageWriteTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a write operation in the cache",
                  displayName="Average write time",
                  units=NANOSECONDS)
public long getAverageWriteTimeNanos()

getAverageRemoveTime

@ManagedAttribute(description="Average number of milliseconds for a remove operation in the cache",
                  displayName="Average remove time",
                  units=MILLISECONDS)
public long getAverageRemoveTime()

getAverageRemoveTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a remove operation in the cache",
                  displayName="Average remove time",
                  units=NANOSECONDS)
public long getAverageRemoveTimeNanos()

getApproximateEntries

@ManagedAttribute(description="Approximate number of entries currently in the cache, including persisted and expired entries",
                  displayName="Approximate number of entries")
public long getApproximateEntries()

getApproximateEntriesInMemory

@ManagedAttribute(description="Approximate number of entries currently in memory, including expired entries",
                  displayName="Approximate number of cache entries in memory")
public long getApproximateEntriesInMemory()

getApproximateEntriesUnique

@ManagedAttribute(description="Approximate number of entries currently in the cache for which the local node is a primary owner, including persisted and expired entries",
                  displayName="Approximate number of entries owned as primary")
public long getApproximateEntriesUnique()

getNumberOfEntries

@ManagedAttribute(description="Number of entries in the cache including passivated entries",
                  displayName="Number of current cache entries")
@Deprecated(forRemoval=true,
            since="14.0")
public int getNumberOfEntries()

Deprecated, for removal: This API element is subject to removal in a future version.

getNumberOfEntriesInMemory

@ManagedAttribute(description="Number of entries currently in-memory excluding expired entries",
                  displayName="Number of in-memory cache entries")
@Deprecated(forRemoval=true,
            since="14.0")
public int getNumberOfEntriesInMemory()

Deprecated, for removal: This API element is subject to removal in a future version.

getDataMemoryUsed

@ManagedAttribute(description="Amount of memory in bytes allocated for use in eviction for data in the cache",
                  displayName="Memory used by data in the cache")
public long getDataMemoryUsed()

getOffHeapMemoryUsed

@ManagedAttribute(description="Amount off-heap memory used by this cache (bytes)",
                  displayName="Off-Heap memory used")
public long getOffHeapMemoryUsed()

getRequiredMinimumNumberOfNodes

@ManagedAttribute(description="Amount of nodes required to guarantee data consistency",
                  displayName="Required Minimum Nodes")
public int getRequiredMinimumNumberOfNodes()

calculateRequiredMinimumNumberOfNodes

public static int calculateRequiredMinimumNumberOfNodes(AdvancedCache<?,?> cache,
 ComponentRegistry componentRegistry)

getTimeSinceStart

@ManagedAttribute(description="Number of seconds since cache started",
                  displayName="Seconds since cache started",
                  units=SECONDS,
                  measurementType=TRENDSUP)
public long getTimeSinceStart()

getTimeSinceReset

@ManagedAttribute(description="Number of seconds since the cache statistics were last reset",
                  displayName="Seconds since cache statistics were reset",
                  units=SECONDS)
public long getTimeSinceReset()

resetStatistics

public void resetStatistics()

Description copied from class: JmxStatsCommandInterceptor

Resets statistics gathered. Is a no-op, and should be overridden if it is to be meaningful.

Specified by:

resetStatistics in interface JmxStatisticsExposer

Overrides:

resetStatistics in class JmxStatsCommandInterceptor

addEvictions

public void addEvictions(long numEvictions)