Appendix D. JMX MBeans in Red Hat JBoss Data Grid

D.1. Activation

org.infinispan.eviction.ActivationManagerImpl

Activates entries that have been passivated to the CacheStore by loading the entries into memory.

Table D.1. Attributes

NameDescriptionTypeWritable

activations

Number of activation events.

String

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.2. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.2. Cache

org.infinispan.CacheImpl

The Cache component represents an individual cache instance.

Table D.3. Attributes

NameDescriptionTypeWritable

cacheName

Returns the cache name.

String

No

cacheStatus

Returns the cache status.

String

No

configurationAsProperties

Returns the cache configuration in form of properties.

Properties

No

version

Returns the version of Infinispan

String

No

cacheAvailability

Returns the cache availability

String

Yes

Table D.4. Operations

NameDescriptionSignature

start

Starts the cache.

void start()

stop

Stops the cache.

void stop()

clear

Clears the cache.

void clear()

D.3. CacheContainerStats

org.infinispan.stats.impl.CacheContainerStatsImpl

The CacheContainerStats component contains statistics such as timings, hit/miss ratio, and operation information.

Table D.5. Attributes

NameDescriptionTypeWritable

averageReadTime

Cache container total average number of milliseconds for all read operations in this cache container.

long

No

averageReadTimeNanos

Cache container total average number of nanoseconds for all read operations in this cache container.

long

No

averageRemoveTime

Cache container total average number of milliseconds for all remove operations in this cache container.

long

No

averageRemoveTimeNanos

Cache container total average number of nanoseconds for all remove operations in this cache container.

long

No

averageWriteTime

Cache container total average number of milliseconds for all write operations in this cache container.

long

No

averageWriteTimeNanos

Cache container total average number of nanoseconds for all write operations in this cache container.

long

No

currentNumberOfEntriesInMemory

Total number of entries that are currently in memory for all caches in this cache container.

int

No

dataMemoryUsed

Amount of memory, in bytes, allocated for a cache container for entries when eviction is enabled.

long

No

evictions

Cache container total number of cache eviction operations.

long

No

hitRatio

Cache container total percentage hit/(hit+miss) ratio for this cache.

double

No

hits

Cache container total number of cache attribute hits.

long

No

misses

Cache container total number of cache attribute misses.

long

No

numberOfEntries

Cache container total number of entries currently in all caches from this cache container.

int

No

offHeapMemoryUsed

Amount of off-heap memory, in bytes, that this cache container uses.

long

No

readWriteRatio

Cache container read/writes ratio in all caches from this cache container.

double

No

removeHits

Cache container total number of removal hits.

double

No

removeMisses

Cache container total number of cache removals where keys were not found.

long

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

stores

Cache container total number of cache attribute put operations.

long

No

timeSinceReset

Number of seconds since the statistics were reset for the cache container.

long

No

D.4. CacheLoader

org.infinispan.interceptors.CacheLoaderInterceptor

This component loads entries from a CacheStore into memory.

Table D.6. Attributes

NameDescriptionTypeWritable

cacheLoaderLoads

Number of entries loaded from the cache store.

long

No

cacheLoaderMisses

Number of entries that did not exist in cache store.

long

No

stores

Returns a collection of cache loader types which are configured and enabled.

Collection

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.7. Operations

NameDescriptionSignature

disableStore

Disable all cache loaders of a given type, where type is a fully qualified class name of the cache loader to disable.

void disableStore(String storeType)

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.5. CacheManager

org.infinispan.manager.DefaultCacheManager

The CacheManager component acts as a manager, factory, and container for caches in the system.

Table D.8. Attributes

NameDescriptionTypeWritable

cacheManagerStatus

The status of the cache manager instance.

String

No

clusterMembers

Lists members in the cluster.

String

No

clusterName

Cluster name.

String

No

clusterSize

Size of the cluster in the number of nodes.

int

No

createdCacheCount

The total number of created caches, including the default cache.

String

No

definedCacheCount

The total number of defined caches, excluding the default cache.

String

No

definedCacheNames

The defined cache names and their statuses. The default cache is not included in this representation.

String

No

name

The name of this cache manager.

String

No

nodeAddress

The network address associated with this instance.

String

No

physicalAddresses

The physical network addresses associated with this instance.

String

No

runningCacheCount

The total number of running caches, including the default cache.

String

No

version

Infinispan version.

String

No

globalConfigurationAsProperties

Global configuration properties

Properties

No

Table D.9. Operations

NameDescriptionSignature

startCache

Starts the default cache associated with this cache manager.

void startCache()

startCache

Starts a named cache from this cache manager.

void startCache (String p0)

D.6. CacheStore

org.infinispan.interceptors.CacheWriterInterceptor

The CacheStore component stores entries to a CacheStore from memory.

Table D.10. Attributes

NameDescriptionTypeWritable

writesToTheStores

Number of writes to the store.

long

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.11. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.7. ClusterCacheStats

org.infinispan.stats.impl.ClusterCacheStatsImpl

The ClusterCacheStats component contains statistics such as timings, hit/miss ratio, and operation information for the whole cluster.

Table D.12. Attributes

NameDescriptionTypeWritable

activations

The total number of activations in the cluster.

long

No

averageReadTime

Cluster-wide total average number of milliseconds for a read operation on the cache.

long

No

averageReadTimeNanos

Cluster-wide total average number of nanoseconds for a read operation on the cache.

long

No

averageRemoveTime

Cluster-wide total average number of milliseconds for a remove operation in the cache.

long

No

averageRemoveTimeNanos

Cluster-wide total average number of nanoseconds for a remove operation in the cache.

long

No

averageWriteTime

Cluster-wide average number of milliseconds for a write operation in the cache.

long

No

averageWriteTimeNanos

Cluster-wide average number of nanoseconds for a write operation in the cache.

long

No

cacheLoaderLoads

The total number of cacheloader load operations in the cluster.

long

No

cacheLoaderMisses

The total number of cacheloader load misses in the cluster.

long

No

currentNumberOfEntriesInMemory

Cluster-wide total number of entries currently stored in memory.

int

No

dataMemoryUsed

Amount of memory, in bytes, allocated across the cluster for entries in the cache when eviction is enabled.

long

No

evictions

Cluster-wide total number of cache eviction operations.

long

No

hitRatio

Cluster-wide total percentage hit/(hit+miss) ratio for this cache.

double

No

hits

Cluster-wide total number of cache hits.

long

No

invalidations

The total number of invalidations in the cluster.

long

No

misses

Cluster-wide total number of cache attribute misses.

long

No

numberOfEntries

Cluster-wide total number of entries currently in the cache.

int

No

numberOfLocksAvailable

Total number of exclusive locks available in the cluster.

int

No

numberOfLocksHeld

The total number of locks held in the cluster.

int

No

offHeapMemoryUsed

Cluster-wide amount of off-heap memory, in bytes, that this cache uses.

long

No

passivations

The total number of passivations in the cluster.

long

No

readWriteRatio

Cluster-wide read/writes ratio for the cache.

double

No

removeHits

Cluster-wide total number of cache removal hits.

double

No

removeMisses

Cluster-wide total number of cache removals where keys were not found.

long

No

staleStatsThreshold

Returns the threshold for refreshing cluster-wide stats in milliseconds.

long

Yes

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

storeWrites

The total number of cachestore store operations in the cluster.

long

No

stores

Cluster-wide total number of cache attribute put operations.

long

No

timeSinceReset

Number of seconds since the cluster-wide statistics were last reset.

long

No

timeSinceStart

Number of seconds since the first cache node started.

long

No

Table D.13. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.8. ClusterContainerStats

org.infinispan.stats.impl.ClusterContainerStatsImpl

The ClusterContainerStats component contains statistics on Java Virtual Machines (JVM) memory for the whole cluster.

Table D.14. Attributes

NameDescriptionTypeWritable

timeSinceReset

Number of seconds since the cluster-wide statistics were last reset.

long

No

memoryAvailable

Amount of free memory, in bytes, for JVMs across the cluster.

long

No

memoryMax

Maximum amount of memory, in bytes, that JVMs across the cluster will attempt to use.

long

No

memoryTotal

Total amount of memory, in bytes, in JVMs across the cluster.

long

No

memoryUsed

Amount of memory, in bytes, used by JVMs across the cluster.

long

No

staleStatsThreshold

Returns the threshold for refreshing cluster-wide stats in milliseconds.

long

Yes

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.15. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.9. DeadlockDetectingLockManager

org.infinispan.util.concurrent.locks.DeadlockDetectingLockManager

This component provides information about the number of deadlocks that were detected.

Table D.16. Attributes

NameDescriptionTypeWritable

detectedLocalDeadlocks

Number of local transactions that were rolled back due to deadlocks.

long

No

detectedRemoteDeadlocks

Number of remote transactions that were rolled back due to deadlocks.

long

No

overlapWithNotDeadlockAwareLockOwners

Number of situations when we try to determine a deadlock and the other lock owner is NOT a transaction. In this scenario we cannot run the deadlock detection mechanism.

long

No

totalNumberOfDetectedDeadlocks

Total number of local detected deadlocks.

long

No

concurrencyLevel

The concurrency level that the MVCC Lock Manager has been configured with.

int

No

numberOfLocksAvailable

The number of exclusive locks that are available.

int

No

numberOfLocksHeld

The number of exclusive locks that are held.

int

No

Table D.17. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.10. DistributionManager

org.infinispan.distribution.DistributionManagerImpl

The DistributionManager component handles the distribution of content across a cluster.

Note

The DistrubutionManager component is only available in clustered mode.

Table D.18. Operations

NameDescriptionSignature

isAffectedByRehash

Determines whether a given key is affected by an ongoing rehash.

boolean isAffectedByRehash(Object p0)

isLocatedLocally

Indicates whether a given key is local to this instance of the cache. Only works with String keys.

boolean isLocatedLocally(String p0)

locateKey

Locates an object in a cluster. Only works with String keys.

List locateKey(String p0)

D.11. Interpreter

org.infinispan.cli.interpreter.Interpreter

The Interpreter component executes command line interface (CLI operations).

Table D.19. Attributes

NameDescriptionTypeWritable

cacheNames

Retrieves a list of caches for the cache manager.

String[]

No

Table D.20. Operations

NameDescriptionSignature

createSessionId

Creates a new interpreter session.

String createSessionId(String cacheName)

execute

Parses and executes IspnCliQL statements.

String execute(String p0, String p1)

D.12. Invalidation

org.infinispan.interceptors.InvalidationInterceptor

The Invalidation component invalidates entries on remote caches when entries are written locally.

Table D.21. Attributes

NameDescriptionTypeWritable

invalidations

Number of invalidations.

long

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.22. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.13. LockManager

org.infinispan.util.concurrent.locks.LockManagerImpl

The LockManager component handles MVCC locks for entries.

Table D.23. Attributes

NameDescriptionTypeWritable

concurrencyLevel

The concurrency level that the MVCC Lock Manager has been configured with.

int

No

numberOfLocksAvailable

The number of exclusive locks that are available.

int

No

numberOfLocksHeld

The number of exclusive locks that are held.

int

No

D.14. LocalTopologyManager

org.infinispan.topology.LocalTopologyManagerImpl

The LocalTopologyManager component controls the cache membership and state transfer in Red Hat JBoss Data Grid.

Note

The LocalTopologyManager component is only available in clustered mode.

Table D.24. Attributes

NameDescriptionTypeWritable

rebalancingEnabled

If false, newly started nodes will not join the existing cluster nor will the state be transferred to them. If any of the current cluster members are stopped when rebalancing is disabled, the nodes will leave the cluster but the state will not be rebalanced among the remaining nodes. This will result in fewer copies than specified by the owners attribute until rebalancing is enabled again.

boolean

Yes

clusterAvailability

If AVAILABLE the node is currently operating regularly. If DEGRADED then data can not be safely accessed due to either a network split, or successive nodes leaving.

String

No

D.15. MassIndexer

org.infinispan.query.MassIndexer

The MassIndexer component rebuilds the index using cached data.

Table D.25. Operations

NameDescriptionSignature

start

Starts rebuilding the index.

void start()

Note

This operation is available only for caches with indexing enabled. For more information, see the Red Hat JBoss Data Grid Developer Guide

D.16. Passivation

org.infinispan.eviction.PassivationManager

The Passivation component handles the passivation of entries to a CacheStore on eviction.

Table D.26. Attributes

NameDescriptionTypeWritable

passivations

Number of passivation events.

String

No

statisticsEnabled

Enables or disables the gathering of statistics by this component

boolean

Yes

Table D.27. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.17. RecoveryAdmin

org.infinispan.transaction.xa.recovery.RecoveryAdminOperations

The RecoveryAdmin component exposes tooling for handling transaction recovery.

Table D.28. Operations

NameDescriptionSignature

forceCommit

Forces the commit of an in-doubt transaction.

String forceCommit(long p0)

forceCommit

Forces the commit of an in-doubt transaction

String forceCommit(int p0, byte[] p1, byte[] p2)

forceRollback

Forces the rollback of an in-doubt transaction.

String forceRollback(long p0)

forceRollback

Forces the rollback of an in-doubt transaction

String forceRollback(int p0, byte[] p1, byte[] p2)

forget

Removes recovery info for the given transaction.

String forget(long p0)

forget

Removes recovery info for the given transaction.

String forget(int p0, byte[] p1, byte[] p2)

showInDoubtTransactions

Shows all the prepared transactions for which the originating node crashed.

String showInDoubtTransactions()

D.18. RollingUpgradeManager

org.infinispan.upgrade.RollingUpgradeManager

The RollingUpgradeManager component handles the control hooks in order to migrate data from one version of Red Hat JBoss Data Grid to another.

Table D.29. Operations

NameDescriptionSignature

disconnectSource

Disconnects the target cluster from the source cluster according to the specified migrator.

void disconnectSource(String p0)

recordKnownGlobalKeyset

Dumps the global known keyset to a well-known key for retrieval by the upgrade process.

void recordKnownGlobalKeyset()

synchronizeData

Synchronizes data from the old cluster to this using the specified migrator.

long synchronizeData(String p0)

D.19. RpcManager

org.infinispan.remoting.rpc.RpcManagerImpl

The RpcManager component manages all remote calls to remote cache instances in the cluster.

Note

The RpcManager component is only available in clustered mode.

Table D.30. Attributes

NameDescriptionTypeWritable

averageReplicationTime

The average time spent in the transport layer, in milliseconds.

long

No

committedViewAsString

Retrieves the committed view.

String

No

pendingViewAsString

Retrieves the pending view.

String

No

replicationCount

Number of successful replications.

long

No

replicationFailures

Number of failed replications.

long

No

successRatio

Successful replications as a ratio of total replications.

String

No

successRatioFloatingPoint

Successful replications as a ratio of total replications in numeric double format.

double

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.31. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

setStatisticsEnabled

Whether statistics should be enabled or disabled (true/false)

void setStatisticsEnabled(boolean enabled)

D.20. StateTransferManager

org.infinispan.statetransfer.StateTransferManager

The StateTransferManager component handles state transfer in Red Hat JBoss Data Grid.

Note

The StateTransferManager component is only available in clustered mode.

Table D.32. Attributes

NameDescriptionTypeWritable

joinComplete

If true, the cluster topology is updated to include the node. If false, the node is not yet joined to the cluster.

boolean

No

stateTransferInProgress

Checks whether there is a pending inbound state transfer on this node.

boolean

No

rebalancingStatus

Checks if there is a state transfer in progress for the cache.

String

No

D.21. Statistics

org.infinispan.interceptors.CacheMgmtInterceptor

The CacheMgmtInterceptor component handles general statistics such as timings, hit/miss ratio, etc.

Table D.33. Attributes

NameDescriptionTypeWritable

averageReadTime

Average number of milliseconds for a read operation on the cache.

long

No

averageReadTimeNanos

Average number of nanoseconds for a read operation on the cache.

long

No

averageRemoveTime

Average number of milliseconds for a remove operation in the cache

long

No

averageRemoveTimeNanos

Average number of nanoseconds for a remove operation in the cache

long

No

averageWriteTime

Average number of milliseconds for a write operation in the cache.

long

No

averageWriteTimeNanos

Average number of nanoseconds for a write operation in the cache.

long

No

dataMemoryUsed

Amount of memory, in bytes, allocated for the cache entries when eviction is enabled.

long

No

elapsedTime

Number of seconds since cache started.

long

No

evictions

Number of cache eviction operations.

long

No

hitRatio

Percentage hit/(hit+miss) ratio for the cache.

double

No

hits

Number of cache attribute hits.

long

No

misses

Number of cache attribute misses.

long

No

numberOfEntries

Number of entries currently in the cache.

int

No

numberOfEntriesInMemory

Total number of entries that are currently in memory excluding expired entries.

int

No

offHeapMemoryUsed

Amount of off-heap memory, in bytes, that is allocated.

long

No

readWriteRatio

Read/writes ratio for the cache.

double

No

removeHits

Number of cache removal hits.

long

No

removeMisses

Number of cache removals where keys were not found.

long

No

requiredMinimumNumberOfNodes

Number of nodes that are required to guarantee data consistency.

int

No

stores

Number of cache attribute PUT operations.

long

No

timeSinceReset

Number of seconds since the cache statistics were last reset.

long

No

timeSinceStart

Number of seconds since the cache started.

long

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.34. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.22. Transactions

org.infinispan.interceptors.TxInterceptor

The Transactions component manages the cache’s participation in JTA transactions.

Table D.35. Attributes

NameDescriptionTypeWritable

commits

Number of transaction commits performed since last reset.

long

No

prepares

Number of transaction prepares performed since last reset.

long

No

rollbacks

Number of transaction rollbacks performed since last reset.

long

No

statisticsEnabled

Enables or disables the gathering of statistics by this component.

boolean

Yes

Table D.36. Operations

NameDescriptionSignature

resetStatistics

Resets statistics gathered by this component.

void resetStatistics()

D.23. Transport

org.infinispan.server.core.transport.NettyTransport

The Transport component manages read and write operations to and from the server.

Table D.37. Attributes

NameDescriptionTypeWritable

hostName

Returns the host to which the transport binds.

String

No

idleTimeout

Returns the idle timeout.

String

No

numberOfGlobalConnections

Returns a count of active connections in the cluster. This operation will make remote calls to aggregate results, so latency may have an impact on the speed of calculation for this attribute.

Integer

false

numberOfLocalConnections

Returns a count of active connections this server.

Integer

No

numberWorkerThreads

Returns the number of worker threads.

String

No

port

Returns the port to which the transport binds.

String

receiveBufferSize

Returns the receive buffer size.

String

No

sendBufferSize

Returns the send buffer size.

String

No

totalBytesRead

Returns the total number of bytes read by the server from clients, including both protocol and user information.

String

No

totalBytesWritten

Returns the total number of bytes written by the server back to clients, including both protocol and user information.

String

No

tcpNoDelay

D.24. XSiteAdmin

org.infinispan.xsite.XSiteAdminOperations

The XSiteAdmin component exposes tooling for backing up data to remote sites.

Table D.38. Operations

NameDescriptionSignature

bringSiteOnline

Brings the given site back online on all the cluster.

String bringSiteOnline(String p0)

amendTakeOffline

Amends the values for 'TakeOffline' functionality on all the nodes in the cluster.

String amendTakeOffline(String p0, int p1, long p2)

getTakeOfflineAfterFailures

Returns the value of the 'afterFailures' for the 'TakeOffline' functionality.

String getTakeOfflineAfterFailures(String p0)

getTakeOfflineMinTimeToWait

Returns the value of the 'minTimeToWait' for the 'TakeOffline' functionality.

String getTakeOfflineMinTimeToWait(String p0)

setTakeOfflineAfterFailures

Amends the values for 'afterFailures' for the 'TakeOffline' functionality on all the nodes in the cluster.

String setTakeOfflineAfterFailures(String p0, int p1)

setTakeOfflineMinTimeToWait

Amends the values for 'minTimeToWait' for the 'TakeOffline' functionality on all the nodes in the cluster.

String setTakeOfflineMinTimeToWait(String p0, long p1)

siteStatus

Check whether the given backup site is offline or not.

String siteStatus(String p0)

status

Returns the status(offline/online) of all the configured backup sites.

String status()

takeSiteOffline

Takes this site offline in all nodes in the cluster.

String takeSiteOffline(String p0)

pushState

Starts the cross-site state transfer to the site name specified.

String pushState(String p0)

cancelPushState

Cancels the cross-site state transfer to the site name specified.

String cancelPushState(String p0)

getSendingSiteName

Returns the site name that is pushing state to this site.

String getSendingSiteName()

cancelReceiveState

Restores the site to the normal state. It is used when the link between the sites is broken during the state transfer.

String cancelReceiveState(String p0)

getPushStateStatus

Returns the status of completed and running cross-site state transfer.

String getPushStateStatus()

clearPushStateStatus

Clears the status of completed cross-site state transfer.

String clearPushStateStatus()