JMX Components (Infinispan 10.1 API)

MBean Summary
Name	Description
CacheManager	Component that acts as a manager, factory and container for caches in the system.
CacheUsageStatistics	Keeps tracks of the accessed keys
ExtendedStatistics	Component that manages and exposes extended statistics relevant to transactions.
GlobalXSiteAdminOperations	Exposes tooling for handling backing up data to remote sites.
InboundInvocationHandler	Handles all the remote requests.
LocalTopologyManager	Controls the cache membership and state transfer
ManageableExecutorService
RecoveryAdmin	Exposes tooling for handling transaction recovery.
RemoteCacheClientStatisticsMXBean	RemoteCache client-side statistics (such as number of connections)
RemoteCacheManagerMXBean	RemoteCacheManager client-side statistics and operations
RollingUpgradeManager	This component handles the control hooks to handle migrating data from one version of Infinispan to another
RpcManager	Manages all remote calls to remote cache instances in the cluster.
StateTransferManager	Component that handles state transfer
Transport	Transport component manages read and write operations to/from server.
WorkerExecutor
XSiteAdmin	Exposes tooling for handling backing up data to remote sites.

CacheManager

Component that acts as a manager, factory and container for caches in the system.

Attributes
Name	Description	Type	Writable
`CacheManagerStatus`	The status of the cache manager instance.	`java.lang.String`	false
`ClusterMembers`	List of members in the cluster	`java.lang.String`	false
`ClusterMembersPhysicalAddresses`	List of members in the cluster	`java.lang.String`	false
`ClusterName`	Cluster name	`java.lang.String`	false
`ClusterSize`	Size of the cluster in number of nodes	`int`	false
`Coordinator`	Indicates whether this node is coordinator	`boolean`	false
`CoordinatorAddress`	The logical address of the cluster's coordinator	`java.lang.String`	false
`CreatedCacheCount`	The total number of created caches, including the default cache.	`java.lang.String`	false
`DefinedCacheConfigurationNames`	The defined cache configuration names.	`java.lang.String`	false
`DefinedCacheCount`	The total number of defined cache configurations.	`java.lang.String`	false
`DefinedCacheNames`	The defined cache names and their statuses. The default cache is not included in this representation.	`java.lang.String`	false
`GlobalConfigurationAsProperties`	Global configuration properties	`java.util.Properties`	false
`Name`	The name of this cache manager	`java.lang.String`	false
`NodeAddress`	The network address associated with this instance	`java.lang.String`	false
`NumberOfCacheConfigurations`	The total number of defined cache configurations.	`int`	false
`NumberOfCreatedCaches`	The total number of created caches, including the default cache.	`long`	false
`NumberOfRunningCaches`	The total number of running caches, including the default cache.	`long`	false
`PhysicalAddresses`	The physical network addresses associated with this instance	`java.lang.String`	false
`RunningCacheCount`	The total number of running caches, including the default cache.	`java.lang.String`	false
`Version`	Returns the version of Infinispan	`java.lang.String`	false

Operations
Name	Description	Signature
`startCache`	Starts a named cache from this cache manager	`void startCache(java.lang.String cacheName)`

CacheUsageStatistics

Keeps tracks of the accessed keys

Attributes
Name	Description	Type	Writable
`Capacity`	Shows the current capacity for top-K values	`int`	false
`LocalTopGets`	Show the top 10 keys most read locally by this instance	`java.util.Map`	false
`LocalTopPuts`	Show the top 10 keys most write locally by this instance	`java.util.Map`	false
`RemoteTopGets`	Show the top 10 keys most read remotely by this instance	`java.util.Map`	false
`RemoteTopPuts`	Show the top 10 keys most write remotely by this instance	`java.util.Map`	false
`TopContendedKeys`	Show the top 10 keys most contended	`java.util.Map`	false
`TopLockFailedKeys`	Show the top 10 keys whose lock acquisition failed by timeout	`java.util.Map`	false
`TopLockedKeys`	Show the top 10 keys most locked	`java.util.Map`	false
`TopWriteSkewFailedKeys`	Show the top 10 keys whose write skew check was failed	`java.util.Map`	false

Operations
Name	Description	Signature
`getNLocalTopGets`	Show the top n keys most read locally by this instance	`java.util.Map<java.lang.String,java.lang.Long> getNLocalTopGets(int n)`
`getNLocalTopPuts`	Show the top n keys most write locally by this instance	`java.util.Map<java.lang.String,java.lang.Long> getNLocalTopPuts(int n)`
`getNRemoteTopGets`	Show the top n keys most read remotely by this instance	`java.util.Map<java.lang.String,java.lang.Long> getNRemoteTopGets(int n)`
`getNRemoteTopPuts`	Show the top n keys most write remotely by this instance	`java.util.Map<java.lang.String,java.lang.Long> getNRemoteTopPuts(int n)`
`getNTopContendedKeys`	Show the top n keys most contended	`java.util.Map<java.lang.String,java.lang.Long> getNTopContendedKeys(int n)`
`getNTopLockFailedKeys`	Show the top n keys whose lock acquisition failed	`java.util.Map<java.lang.String,java.lang.Long> getNTopLockFailedKeys(int n)`
`getNTopLockedKeys`	Show the top n keys most locked	`java.util.Map<java.lang.String,java.lang.Long> getNTopLockedKeys(int n)`
`getNTopWriteSkewFailedKeys`	Show the top n keys whose write skew check was failed	`java.util.Map<java.lang.String,java.lang.Long> getNTopWriteSkewFailedKeys(int n)`
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`
`setStatisticsEnabled`	Show the top n keys whose write skew check was failed	`void setStatisticsEnabled(boolean enabled)`
`setTopKValue`	Set K for the top-K values	`void setTopKValue(int n)`

ExtendedStatistics

Component that manages and exposes extended statistics relevant to transactions.

Attributes
Name	Description	Type	Writable
`AbortRate`	Abort Rate	`double`	false
`AvailableExtendedStatistics`	Returns all the available statistics	`java.lang.String`	false
`AvgAbortedWriteTxDuration`	Average aborted write transaction duration (in microseconds)	`double`	false
`AvgClusteredGetCommandSize`	Average clustered get command size (in bytes)	`double`	false
`AvgCommitCommandSize`	Average commit command size (in bytes)	`double`	false
`AvgCommitRtt`	Average Commit Round-Trip Time duration (in microseconds)	`double`	false
`AvgCommitTime`	Average local commit duration time (2nd phase only) (in microseconds)	`double`	false
`AvgCompleteNotificationAsync`	Average asynchronous Complete Notification duration (in microseconds)	`double`	false
`AvgGetsPerROTransaction`	Average number of get operations per (local) read-only transaction	`double`	false
`AvgGetsPerWrTransaction`	Average number of get operations per (local) read-write transaction	`double`	false
`AvgLocalCommitTime`	Average time it takes to execute the commit command locally (in microseconds)	`double`	false
`AvgLocalGetTime`	Average Local processing Get time (in microseconds)	`double`	false
`AvgLocalLockHoldTime`	Average lock local holding time (in microseconds)	`double`	false
`AvgLocalPrepareTime`	Average time it takes to execute the prepare command locally (in microseconds)	`double`	false
`AvgLocalRollbackTime`	Average time it takes to execute the rollback command locally (in microseconds)	`double`	false
`AvgLockHoldTime`	Average lock holding time (in microseconds)	`double`	false
`AvgLockWaitingTime`	Average time waiting for the lock acquisition (in microseconds)	`double`	false
`AvgNumNodesCommit`	Average number of nodes in Commit destination set	`double`	false
`AvgNumNodesCompleteNotification`	Average number of nodes in Complete Notification destination set	`double`	false
`AvgNumNodesPrepare`	Average number of nodes in Prepare destination set	`double`	false
`AvgNumNodesRemoteGet`	Average number of nodes in Remote Get destination set	`double`	false
`AvgNumNodesRollback`	Average number of nodes in Rollback destination set	`double`	false
`AvgNumOfLockLocalTx`	Average number of locks per write local transaction	`double`	false
`AvgNumOfLockRemoteTx`	Average number of locks per write remote transaction	`double`	false
`AvgNumOfLockSuccessLocalTx`	Average number of locks per successfully write local transaction	`double`	false
`AvgPrepareCommandSize`	Average prepare command size (in bytes)	`double`	false
`AvgPrepareRtt`	Average Prepare Round-Trip Time duration (in microseconds)	`double`	false
`AvgPutsPerWrTransaction`	Average number of put operations per (local) read-write transaction	`double`	false
`AvgReadOnlyTxDuration`	Average successful read-only transaction duration (in microseconds)	`double`	false
`AvgRemoteCommitTime`	Average time it takes to execute the commit command remotely (in microseconds)	`double`	false
`AvgRemoteGetRtt`	Average Remote Get Round-Trip Time duration (in microseconds)	`double`	false
`AvgRemoteGetsPerROTransaction`	Average number of remote get operations per (local) read-only transaction	`double`	false
`AvgRemoteGetsPerWrTransaction`	Average number of remote get operations per (local) read-write transaction	`double`	false
`AvgRemoteLockHoldTime`	Average lock remote holding time (in microseconds)	`double`	false
`AvgRemotePrepareTime`	Average time it takes to execute the prepare command remotely (in microseconds)	`double`	false
`AvgRemotePutsPerWrTransaction`	Average number of remote put operations per (local) read-write transaction	`double`	false
`AvgRemoteRollbackTime`	Average time it takes to execute the rollback command remotely (in microseconds)	`double`	false
`AvgResponseTime`	Average Response Time	`double`	false
`AvgRollbackRtt`	Average Rollback Round-Trip Time duration (in microseconds)	`double`	false
`AvgRollbackTime`	Average local rollback duration time (2nd phase only) (in microseconds)	`double`	false
`AvgTxArrivalRate`	Average transaction arrival rate, originated locally and remotely (in transaction per second)	`double`	false
`AvgWriteTxDuration`	Average successful write transaction duration (in microseconds)	`double`	false
`LocalActiveTransactions`	Number of concurrent transactions executing on the current node	`double`	false
`LocalExecutionTimeWithoutLock`	Local execution time of a transaction without the time waiting for lock acquisition	`double`	false
`NumAbortedTxDueDeadlock`	The number of aborted transactions due to deadlock	`double`	false
`NumAbortedTxDueTimeout`	The number of aborted transactions due to timeout in lock acquisition	`double`	false
`NumNodes`	Number of nodes in the cluster	`double`	false
`NumberOfCommits`	Number of committed transactions since last reset	`double`	false
`NumberOfGets`	Number of gets performed since last reset	`double`	false
`NumberOfLocalCommits`	Number of local committed transactions since last reset	`double`	false
`NumberOfPuts`	Number of puts performed since last reset	`double`	false
`NumberOfRemoteGets`	Number of remote gets performed since last reset	`double`	false
`NumberOfRemotePuts`	Number of remote puts performed since last reset	`double`	false
`PercentageSuccessWriteTransactions`	Percentage of Write transaction executed in all successfully executed transactions (local transaction only)	`double`	false
`PercentageWriteTransactions`	Percentage of Write transaction executed locally (committed and aborted)	`double`	false
`RemoteGetExecutionTime`	Average cost of a remote get	`double`	false
`RemotePutExecutionTime`	Average cost of a remote put	`double`	false
`ReplicationDegree`	Number of replicas for each key	`double`	false
`Throughput`	Throughput (in transactions per second)	`double`	false
`WriteSkewProbability`	Write skew probability	`double`	false

Operations
Name	Description	Signature
`dumpStatisticToFile`	Dumps the current cache statistic values to a file	`void dumpStatisticToFile(java.lang.String filePath)`
`dumpStatistics`	Dumps the current cache statistic values	`java.lang.String dumpStatistics()`
`dumpStatisticsToSystemOut`	Dumps the current cache statistic values to System.out	`void dumpStatisticsToSystemOut()`
`getPercentileLocalRWriteTransaction`	K-th percentile of local write transactions execution time	`double getPercentileLocalRWriteTransaction(int percentile)`
`getPercentileLocalReadOnlyTransaction`	K-th percentile of local read-only transactions execution time	`double getPercentileLocalReadOnlyTransaction(int percentile)`
`getPercentileRemoteReadOnlyTransaction`	K-th percentile of remote read-only transactions execution time	`double getPercentileRemoteReadOnlyTransaction(int percentile)`
`getPercentileRemoteWriteTransaction`	K-th percentile of remote write transactions execution time	`double getPercentileRemoteWriteTransaction(int percentile)`
`getStatisticValue`	Returns the raw value for the statistic	`double getStatisticValue(java.lang.String statName)`
`resetStatistics`	Reset all the statistics collected	`void resetStatistics()`

GlobalXSiteAdminOperations

Exposes tooling for handling backing up data to remote sites.

Operations
Name	Description	Signature
`bringSiteOnline`	Brings the given site back online on all the caches.	`java.lang.String bringSiteOnline(java.lang.String site)`
`cancelPushState`	Cancels the push state on all the caches to remote site.	`java.lang.String cancelPushState(java.lang.String site)`
`pushState`	Pushes the state of all caches to the corresponding remote site if the cache backups to it. The remote site will be bring back online	`java.lang.String pushState(java.lang.String site)`
`takeSiteOffline`	Takes this site offline in all caches in the cluster.	`java.lang.String takeSiteOffline(java.lang.String site)`

InboundInvocationHandler

Handles all the remote requests.

Attributes
Name	Description	Type	Writable
`AsyncXSiteRequestsReceived`	Returns the number of async cross-site requests received by this node	`long`	false
`StatisticsEnabled`	Enables or disables the gathering of statistics by this component	`boolean`	true
`SyncXSiteRequestsReceived`	Returns the number of sync cross-site requests received by this node	`long`	false

Operations
Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`

LocalTopologyManager
Controls the cache membership and state transfer
Attributes
Name Description Type Writable

ClusterAvailability Cluster availability java.lang.String false

RebalancingEnabled Rebalancing enabled boolean true

Attributes
Name	Description	Type	Writable
`ClusterAvailability`	Cluster availability	`java.lang.String`	false
`RebalancingEnabled`	Rebalancing enabled	`boolean`	true

ManageableExecutorService

Attributes
Name	Description	Type	Writable
`ActiveCount`	Returns the number of active executor threads.	`int`	false
`KeepAliveTime`	Returns the keep-alive time for this pool's threads	`long`	false
`LargestPoolSize`	Returns the largest ever number of executor threads.	`int`	false
`MaximumPoolSize`	Returns the maximum number of executor threads.	`int`	true
`PoolSize`	Returns the number of threads in this executor.	`int`	false
`QueueSize`	Returns the number of elements in this executor's queue.	`int`	false

RecoveryAdmin

Exposes tooling for handling transaction recovery.

Operations
Name	Description	Signature
`forceCommit`	Forces the commit of an in-doubt transaction	`java.lang.String forceCommit(long internalId, int formatId, byte[] globalTxId, byte[] branchQualifier)`
`forceRollback`	Forces the rollback of an in-doubt transaction	`java.lang.String forceRollback(long internalId, int formatId, byte[] globalTxId, byte[] branchQualifier)`
`forget`	Removes recovery info for the given transaction.	`java.lang.String forget(int formatId, byte[] globalTxId, byte[] branchQualifier, long internalId)`
`showInDoubtTransactions`	Shows all the prepared transactions for which the originating node crashed	`java.lang.String showInDoubtTransactions()`

RemoteCacheClientStatisticsMXBean

RemoteCache client-side statistics (such as number of connections)

Attributes
Name	Description	Type	Writable
`AverageRemoteReadTime`	Returns the average read time, in milliseconds, for a remote cache.	`long`	false
`AverageRemoteRemovesTime`	Returns the average time, in milliseconds, for remove operations in a remote cache.	`long`	false
`AverageRemoteStoreTime`	Returns the average store time, in milliseconds, for a remote cache.	`long`	false
`NearCacheHits`	Returns the number of near-cache hits. Returns a value of 0 if near-caching is disabled.	`long`	false
`NearCacheInvalidations`	Returns the number of near-cache invalidations. Returns a value of 0 if near-caching is disabled.	`long`	false
`NearCacheMisses`	Returns the number of near-cache misses. Returns a value of 0 if near-caching is disabled.	`long`	false
`NearCacheSize`	Returns the number of entries currently stored in the near-cache. Returns a value of 0 if near-caching is disabled.	`long`	false
`RemoteHits`	Returns the number of hits for a remote cache.	`long`	false
`RemoteMisses`	Returns the number of misses for a remote cache.	`long`	false
`RemoteRemoves`	Returns the number of removes for a remote cache.	`long`	false
`RemoteStores`	Returns the number of remote cache stores (put, replace) that the client applied. Failed conditional operations do not increase the count of entries in the remote cache. Put operations always increase the count even if an operation replaces an equal value.	`long`	false
`TimeSinceReset`	Returns the time, in seconds, since the last reset. See {@link #resetStatistics()}	`long`	false

Operations
Name	Description	Signature
`resetStatistics`	Resets statistics.	`void resetStatistics()`

RemoteCacheManagerMXBean

RemoteCacheManager client-side statistics and operations

Attributes
Name	Description	Type	Writable
`ActiveConnectionCount`	Returns the number of active connections	`int`	false
`ConnectionCount`	Returns the total number of connections	`int`	false
`IdleConnectionCount`	Returns the number of idle connections	`int`	false
`Retries`	Returns the total number of retries that have been executed	`long`	false
`Servers`	Returns a list of servers to which the client is currently connected in the format of ip_address:port_number.	`java.lang.String[]`	false

Operations
Name	Description	Signature
`switchToCluster`	Switch remote cache manager to a different cluster, previously declared via configuration. If the switch was completed successfully, this method returns {@code true}, otherwise it returns {@code false}.	`boolean switchToCluster(java.lang.String clusterName)`
`switchToDefaultCluster`	Switch remote cache manager to a the default cluster, previously declared via configuration. If the switch was completed successfully, this method returns {@code true}, otherwise it returns {@code false}.	`boolean switchToDefaultCluster()`

RollingUpgradeManager

This component handles the control hooks to handle migrating data from one version of Infinispan to another

Operations
Name	Description	Signature
`disconnectSource`	Disconnects the target cluster from the source cluster according to the specified migrator	`void disconnectSource(java.lang.String migratorName)`
`synchronizeData`	Synchronizes data from the old cluster to this using the specified migrator	`long synchronizeData(java.lang.String migratorName, java.lang.String migratorName, int readBatch, int threads)`

RpcManager

Manages all remote calls to remote cache instances in the cluster.

Attributes
Name	Description	Type	Writable
`AsyncXSiteAcksCount`	Returns the number of async cross-site acknowledges received	`long`	false
`AsyncXSiteCount`	Returns the number of async cross-site requests	`long`	false
`AverageAsyncXSiteReplicationTime`	Returns the average replication time, in milliseconds, for an asynchronous cross-site replication request	`long`	false
`AverageReplicationTime`	The average time spent in the transport layer, in milliseconds	`long`	false
`AverageXSiteReplicationTime`	Returns the average replication time, in milliseconds, for a cross-site replication request	`long`	false
`CommittedViewAsString`	Retrieves the committed view.	`java.lang.String`	false
`MaximumAsyncXSiteReplicationTime`	Returns the maximum replication time, in milliseconds, for an asynchronous cross-site replication request	`long`	false
`MaximumXSiteReplicationTime`	Returns the maximum replication time, in milliseconds, for a cross-site replication request	`long`	false
`MinimumAsyncXSiteReplicationTime`	Returns the minimum replication time, in milliseconds, for an asynchronous cross-site replication request	`long`	false
`MinimumXSiteReplicationTime`	Returns the minimum replication time, in milliseconds, for a cross-site replication request	`long`	false
`PendingViewAsString`	Retrieves the pending view.	`java.lang.String`	false
`ReplicationCount`	Number of successful replications	`long`	false
`ReplicationFailures`	Number of failed replications	`long`	false
`SitesView`	Retrieves the x-site view.	`java.lang.String`	false
`StatisticsEnabled`	Enables or disables the gathering of statistics by this component	`boolean`	true
`SuccessRatio`	Successful replications as a ratio of total replications	`java.lang.String`	false
`SuccessRatioFloatingPoint`	Successful replications as a ratio of total replications in numeric double format	`double`	false
`SyncXSiteCount`	Returns the number of sync cross-site requests	`long`	false

Operations
Name	Description	Signature
`resetStatistics`	Resets statistics gathered by this component	`void resetStatistics()`
`setStatisticsEnabled`		`void setStatisticsEnabled(boolean statisticsEnabled)`

StateTransferManager

Component that handles state transfer

Attributes
Name	Description	Type	Writable
`JoinComplete`	If true, the node has successfully joined the grid and is considered to hold state. If false, the join process is still in progress.	`boolean`	false
`RebalancingStatus`	Retrieves the rebalancing status for this cache. Possible values are PENDING, SUSPENDED, IN_PROGRESS, BALANCED	`java.lang.String`	false
`StateTransferInProgress`	Checks whether there is a pending inbound state transfer on this cluster member.	`boolean`	false

Transport

Transport component manages read and write operations to/from server.

Attributes
Name	Description	Type	Writable
`HostName`	Returns the host to which the transport binds.	`java.lang.String`	false
`IdleTimeout`	Returns the idle timeout.	`int`	false
`NumberIOThreads`	Returns the number of I/O threads.	`int`	false
`NumberOfGlobalConnections`	Returns a count of active connections in the cluster. This operation will make remote calls to aggregate results, so latency might have an impact on the speed of calculation of this attribute.	`int`	false
`NumberOfLocalConnections`	Returns a count of active connections this server.	`int`	false
`PendingTasks`	Returns the number of pending tasks.	`int`	false
`Port`	Returns the port to which the transport binds.	`int`	false
`ReceiveBufferSize`	Returns the receive buffer size.	`int`	false
`SendBufferSize`	Returns the send buffer size.	`int`	false
`TcpNoDelay`	Returns whether TCP no delay was configured or not.	`boolean`	false
`TotalBytesRead`	Returns the total number of bytes read by the server from clients which includes both protocol and user information.	`long`	false
`TotalBytesWritten`	Returns the total number of bytes written by the server back to clients which includes both protocol and user information.	`long`	false

WorkerExecutor

XSiteAdmin

Exposes tooling for handling backing up data to remote sites.

Operations
Name	Description	Signature
`amendTakeOffline`	Amends the values for 'TakeOffline' functionality on all the nodes in the cluster.	`java.lang.String amendTakeOffline(java.lang.String site, int afterFailures, long minTimeToWait)`
`bringSiteOnline`	Brings the given site back online on all the cluster.	`java.lang.String bringSiteOnline(java.lang.String site)`
`cancelPushState`	Cancels the push state to remote site.	`java.lang.String cancelPushState(java.lang.String siteName)`
`cancelReceiveState`	Cancels the push state to this site. All the state received from state transfer will be ignored.	`java.lang.String cancelReceiveState(java.lang.String siteName)`
`clearPushStateStatus`	Clears the state transfer status.	`java.lang.String clearPushStateStatus()`
`getPushStateStatus`	Shows a map with destination site name and the state transfer status.	`java.util.Map<java.lang.String,java.lang.String> getPushStateStatus()`
`getSendingSiteName`	Returns the site name from which this site is receiving state.	`java.lang.String getSendingSiteName()`
`getTakeOfflineAfterFailures`	Returns the value of the 'afterFailures' for the 'TakeOffline' functionality.	`java.lang.String getTakeOfflineAfterFailures(java.lang.String site)`
`getTakeOfflineMinTimeToWait`	Returns the value of the 'minTimeToWait' for the 'TakeOffline' functionality.	`java.lang.String getTakeOfflineMinTimeToWait(java.lang.String site)`
`pushState`	Pushes the state of this cache to the remote site. The remote site will be bring back online	`java.lang.String pushState(java.lang.String siteName)`
`setTakeOfflineAfterFailures`	Amends the values for 'afterFailures' for the 'TakeOffline' functionality on all the nodes in the cluster.	`java.lang.String setTakeOfflineAfterFailures(java.lang.String site, int afterFailures)`
`setTakeOfflineMinTimeToWait`	Amends the values for 'minTimeToWait' for the 'TakeOffline' functionality on all the nodes in the cluster.	`java.lang.String setTakeOfflineMinTimeToWait(java.lang.String site, long minTimeToWait)`
`siteStatus`	Check whether the given backup site is offline or not.	`java.lang.String siteStatus(java.lang.String site)`
`status`	Returns the the status(offline/online) of all the configured backup sites.	`java.lang.String status()`
`takeSiteOffline`	Takes this site offline in all nodes in the cluster.	`java.lang.String takeSiteOffline(java.lang.String site)`