Red Hat SummitAppendix 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.
| Name | Description | Type | Writable |
|---|---|---|---|
| activations | Number of activation events. | String | No |
| statisticsEnabled | Enables or disables the gathering of statistics by this component. | boolean | Yes |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.2. Cache
org.infinispan.CacheImpl
The Cache component represents an individual cache instance.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| 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.
| Name | Description | Type | Writable |
|---|---|---|---|
| averageReadTime | Cache container total average number of milliseconds 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 |
| averageWriteTime | Cache container total average number of milliseconds for all write operations in this cache container. | 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 |
| 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 |
D.4. CacheLoader
org.infinispan.interceptors.CacheLoaderInterceptor
This component loads entries from a CacheStore into memory.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| 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.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| 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.
| Name | Description | Type | Writable |
|---|---|---|---|
| writesToTheStores | Number of writes to the store. | long | No |
| statisticsEnabled | Enables or disables the gathering of statistics by this component. | boolean | Yes |
| Name | Description | Signature |
|---|---|---|
| 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.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| averageRemoveTime | Cluster wide total average number of milliseconds 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| timeSinceStart | Number of seconds since the first cache node started. | long | No |
| Name | Description | Signature |
|---|---|---|
| setStaleStatsTreshold | Sets the threshold for cluster wide stats refresh (in milliseconds). | void setStaleStatsTreshold(long staleStatsThreshold) |
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.8. DeadlockDetectingLockManager
org.infinispan.util.concurrent.locks.DeadlockDetectingLockManager
This component provides information about the number of deadlocks that were detected.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.9. DistributionManager
org.infinispan.distribution.DistributionManagerImpl
The DistributionManager component handles the distribution of content across a cluster.
The DistrubutionManager component is only available in clustered mode.
| Name | Description | Signature |
|---|---|---|
| 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.10. Interpreter
org.infinispan.cli.interpreter.Interpreter
The Interpreter component executes command line interface (CLI operations).
| Name | Description | Type | Writable |
|---|---|---|---|
| cacheNames | Retrieves a list of caches for the cache manager. | String[] | No |
| Name | Description | Signature |
|---|---|---|
| createSessionId | Creates a new interpreter session. | String createSessionId(String cacheName) |
| execute | Parses and executes IspnCliQL statements. | String execute(String p0, String p1) |
D.11. Invalidation
org.infinispan.interceptors.InvalidationInterceptor
The Invalidation component invalidates entries on remote caches when entries are written locally.
| Name | Description | Type | Writable |
|---|---|---|---|
| invalidations | Number of invalidations. | long | No |
| statisticsEnabled | Enables or disables the gathering of statistics by this component. | boolean | Yes |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.12. LockManager
org.infinispan.util.concurrent.locks.LockManagerImpl
The LockManager component handles MVCC locks for entries.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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.13. LocalTopologyManager
org.infinispan.topology.LocalTopologyManagerImpl
The LocalTopologyManager component controls the cache membership and state transfer in Red Hat JBoss Data Grid.
The LocalTopologyManager component is only available in clustered mode.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 | boolean | Yes |
| clusterAvailability |
If | String | No |
D.14. MassIndexer
org.infinispan.query.MassIndexer
The MassIndexer component rebuilds the index using cached data.
| Name | Description | Signature |
|---|---|---|
| start | Starts rebuilding the index. | void start() |
This operation is available only for caches with indexing enabled. For more information, see the Red Hat JBoss Data Grid Developer Guide
D.15. Passivation
org.infinispan.eviction.PassivationManager
The Passivation component handles the passivation of entries to a CacheStore on eviction.
| Name | Description | Type | Writable |
|---|---|---|---|
| passivations | Number of passivation events. | String | No |
| statisticsEnabled | Enables or disables the gathering of statistics by this component | boolean | Yes |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.16. RecoveryAdmin
org.infinispan.transaction.xa.recovery.RecoveryAdminOperations
The RecoveryAdmin component exposes tooling for handling transaction recovery.
| Name | Description | Signature |
|---|---|---|
| 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.17. 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.
| Name | Description | Signature |
|---|---|---|
| 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.18. RpcManager
org.infinispan.remoting.rpc.RpcManagerImpl
The RpcManager component manages all remote calls to remote cache instances in the cluster.
The RpcManager component is only available in clustered mode.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
| setStatisticsEnabled | Whether statistics should be enabled or disabled (true/false) | void setStatisticsEnabled(boolean enabled) |
D.19. StateTransferManager
org.infinispan.statetransfer.StateTransferManager
The StateTransferManager component handles state transfer in Red Hat JBoss Data Grid.
The StateTransferManager component is only available in clustered mode.
| Name | Description | Type | Writable |
|---|---|---|---|
|
| If true, the cluster topology is updated to include the node. If false, the node is not yet joined to the cluster. | boolean | No |
|
| Checks whether there is a pending inbound state transfer on this node. | boolean | No |
|
| Checks if there is a state transfer in progress for the cache. | String | No |
D.20. Statistics
org.infinispan.interceptors.CacheMgmtInterceptor
This component handles general statistics such as timings, hit/miss ratio, etc.
| Name | Description | Type | Writable |
|---|---|---|---|
| averageReadTime | Average number of milliseconds for a read operation on the cache. | long | No |
| averageWriteTime | Average number of milliseconds for a write operation in the cache. | 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 |
| 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 |
| stores | Number of cache attribute PUT operations. | long | No |
| timeSinceReset | Number of seconds since the cache statistics were last reset. | long | No |
| averageRemoveTime | Average number of milliseconds for a remove operation in the cache | long | No |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.21. Transactions
org.infinispan.interceptors.TxInterceptor
The Transactions component manages the cache’s participation in JTA transactions.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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 |
| Name | Description | Signature |
|---|---|---|
| resetStatistics | Resets statistics gathered by this component. | void resetStatistics() |
D.22. Transport
org.infinispan.server.core.transport.NettyTransport
The Transport component manages read and write operations to and from the server.
| Name | Description | Type | Writable |
|---|---|---|---|
| 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.23. XSiteAdmin
org.infinispan.xsite.XSiteAdminOperations
The XSiteAdmin component exposes tooling for backing up data to remote sites.
| Name | Description | Signature |
|---|---|---|
| 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() |
