JMX Components (Infinispan 10.1 API)

MBean Summary 
Name Description
CacheManagerComponent that acts as a manager, factory and container for caches in the system.
CacheUsageStatisticsKeeps tracks of the accessed keys
ExtendedStatisticsComponent that manages and exposes extended statistics relevant to transactions.
GlobalXSiteAdminOperationsExposes tooling for handling backing up data to remote sites.
InboundInvocationHandlerHandles all the remote requests.
LocalTopologyManagerControls the cache membership and state transfer
ManageableExecutorService
PassivationComponent that handles passivating entries to a CacheStore on eviction.
RecoveryAdminExposes tooling for handling transaction recovery.
RemoteCacheClientStatisticsMXBeanRemoteCache client-side statistics (such as number of connections)
RemoteCacheManagerMXBeanRemoteCacheManager client-side statistics and operations
RollingUpgradeManagerThis component handles the control hooks to handle migrating data from one version of Infinispan to another
RpcManagerManages all remote calls to remote cache instances in the cluster.
StateTransferManagerComponent that handles state transfer
TransportTransport component manages read and write operations to/from server.
WorkerExecutor
XSiteAdminExposes 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 
      NameDescriptionTypeWritable
      CacheManagerStatusThe status of the cache manager instance.java.lang.Stringfalse
      ClusterMembersList of members in the clusterjava.lang.Stringfalse
      ClusterMembersPhysicalAddressesList of members in the clusterjava.lang.Stringfalse
      ClusterNameCluster namejava.lang.Stringfalse
      ClusterSizeSize of the cluster in number of nodesintfalse
      CoordinatorIndicates whether this node is coordinatorbooleanfalse
      CoordinatorAddressThe logical address of the cluster's coordinatorjava.lang.Stringfalse
      CreatedCacheCountThe total number of created caches, including the default cache.java.lang.Stringfalse
      DefinedCacheConfigurationNamesThe defined cache configuration names.java.lang.Stringfalse
      DefinedCacheCountThe total number of defined cache configurations.java.lang.Stringfalse
      DefinedCacheNamesThe defined cache names and their statuses. The default cache is not included in this representation.java.lang.Stringfalse
      GlobalConfigurationAsPropertiesGlobal configuration propertiesjava.util.Propertiesfalse
      NameThe name of this cache managerjava.lang.Stringfalse
      NodeAddressThe network address associated with this instancejava.lang.Stringfalse
      NumberOfCacheConfigurationsThe total number of defined cache configurations.intfalse
      NumberOfCreatedCachesThe total number of created caches, including the default cache.longfalse
      NumberOfRunningCachesThe total number of running caches, including the default cache.longfalse
      PhysicalAddressesThe physical network addresses associated with this instancejava.lang.Stringfalse
      RunningCacheCountThe total number of running caches, including the default cache.java.lang.Stringfalse
      VersionReturns the version of Infinispanjava.lang.Stringfalse
      Operations 
      NameDescriptionSignature
      startCacheStarts a named cache from this cache managervoid startCache(java.lang.String cacheName)
    • CacheUsageStatistics

      Keeps tracks of the accessed keys

      Attributes 
      NameDescriptionTypeWritable
      CapacityShows the current capacity for top-K valuesintfalse
      LocalTopGetsShow the top 10 keys most read locally by this instancejava.util.Mapfalse
      LocalTopPutsShow the top 10 keys most write locally by this instancejava.util.Mapfalse
      RemoteTopGetsShow the top 10 keys most read remotely by this instancejava.util.Mapfalse
      RemoteTopPutsShow the top 10 keys most write remotely by this instancejava.util.Mapfalse
      TopContendedKeysShow the top 10 keys most contendedjava.util.Mapfalse
      TopLockFailedKeysShow the top 10 keys whose lock acquisition failed by timeoutjava.util.Mapfalse
      TopLockedKeysShow the top 10 keys most lockedjava.util.Mapfalse
      TopWriteSkewFailedKeysShow the top 10 keys whose write skew check was failedjava.util.Mapfalse
      Operations 
      NameDescriptionSignature
      getNLocalTopGetsShow the top n keys most read locally by this instancejava.util.Map<java.lang.String,java.lang.Long> getNLocalTopGets(int n)
      getNLocalTopPutsShow the top n keys most write locally by this instancejava.util.Map<java.lang.String,java.lang.Long> getNLocalTopPuts(int n)
      getNRemoteTopGetsShow the top n keys most read remotely by this instancejava.util.Map<java.lang.String,java.lang.Long> getNRemoteTopGets(int n)
      getNRemoteTopPutsShow the top n keys most write remotely by this instancejava.util.Map<java.lang.String,java.lang.Long> getNRemoteTopPuts(int n)
      getNTopContendedKeysShow the top n keys most contendedjava.util.Map<java.lang.String,java.lang.Long> getNTopContendedKeys(int n)
      getNTopLockFailedKeysShow the top n keys whose lock acquisition failed java.util.Map<java.lang.String,java.lang.Long> getNTopLockFailedKeys(int n)
      getNTopLockedKeysShow the top n keys most lockedjava.util.Map<java.lang.String,java.lang.Long> getNTopLockedKeys(int n)
      getNTopWriteSkewFailedKeysShow the top n keys whose write skew check was failedjava.util.Map<java.lang.String,java.lang.Long> getNTopWriteSkewFailedKeys(int n)
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
      setStatisticsEnabledShow the top n keys whose write skew check was failedvoid setStatisticsEnabled(boolean enabled)
      setTopKValueSet K for the top-K valuesvoid setTopKValue(int n)
    • ExtendedStatistics

      Component that manages and exposes extended statistics relevant to transactions.

      Attributes 
      NameDescriptionTypeWritable
      AbortRateAbort Ratedoublefalse
      AvailableExtendedStatisticsReturns all the available statisticsjava.lang.Stringfalse
      AvgAbortedWriteTxDurationAverage aborted write transaction duration (in microseconds)doublefalse
      AvgClusteredGetCommandSizeAverage clustered get command size (in bytes)doublefalse
      AvgCommitCommandSizeAverage commit command size (in bytes)doublefalse
      AvgCommitRttAverage Commit Round-Trip Time duration (in microseconds)doublefalse
      AvgCommitTimeAverage local commit duration time (2nd phase only) (in microseconds)doublefalse
      AvgCompleteNotificationAsyncAverage asynchronous Complete Notification duration (in microseconds)doublefalse
      AvgGetsPerROTransactionAverage number of get operations per (local) read-only transactiondoublefalse
      AvgGetsPerWrTransactionAverage number of get operations per (local) read-write transactiondoublefalse
      AvgLocalCommitTimeAverage time it takes to execute the commit command locally (in microseconds)doublefalse
      AvgLocalGetTimeAverage Local processing Get time (in microseconds)doublefalse
      AvgLocalLockHoldTimeAverage lock local holding time (in microseconds)doublefalse
      AvgLocalPrepareTimeAverage time it takes to execute the prepare command locally (in microseconds)doublefalse
      AvgLocalRollbackTimeAverage time it takes to execute the rollback command locally (in microseconds)doublefalse
      AvgLockHoldTimeAverage lock holding time (in microseconds)doublefalse
      AvgLockWaitingTimeAverage time waiting for the lock acquisition (in microseconds)doublefalse
      AvgNumNodesCommitAverage number of nodes in Commit destination setdoublefalse
      AvgNumNodesCompleteNotificationAverage number of nodes in Complete Notification destination setdoublefalse
      AvgNumNodesPrepareAverage number of nodes in Prepare destination setdoublefalse
      AvgNumNodesRemoteGetAverage number of nodes in Remote Get destination setdoublefalse
      AvgNumNodesRollbackAverage number of nodes in Rollback destination setdoublefalse
      AvgNumOfLockLocalTxAverage number of locks per write local transactiondoublefalse
      AvgNumOfLockRemoteTxAverage number of locks per write remote transactiondoublefalse
      AvgNumOfLockSuccessLocalTxAverage number of locks per successfully write local transactiondoublefalse
      AvgPrepareCommandSizeAverage prepare command size (in bytes)doublefalse
      AvgPrepareRttAverage Prepare Round-Trip Time duration (in microseconds)doublefalse
      AvgPutsPerWrTransactionAverage number of put operations per (local) read-write transactiondoublefalse
      AvgReadOnlyTxDurationAverage successful read-only transaction duration (in microseconds)doublefalse
      AvgRemoteCommitTimeAverage time it takes to execute the commit command remotely (in microseconds)doublefalse
      AvgRemoteGetRttAverage Remote Get Round-Trip Time duration (in microseconds)doublefalse
      AvgRemoteGetsPerROTransactionAverage number of remote get operations per (local) read-only transactiondoublefalse
      AvgRemoteGetsPerWrTransactionAverage number of remote get operations per (local) read-write transactiondoublefalse
      AvgRemoteLockHoldTimeAverage lock remote holding time (in microseconds)doublefalse
      AvgRemotePrepareTimeAverage time it takes to execute the prepare command remotely (in microseconds)doublefalse
      AvgRemotePutsPerWrTransactionAverage number of remote put operations per (local) read-write transactiondoublefalse
      AvgRemoteRollbackTimeAverage time it takes to execute the rollback command remotely (in microseconds)doublefalse
      AvgResponseTimeAverage Response Timedoublefalse
      AvgRollbackRttAverage Rollback Round-Trip Time duration (in microseconds)doublefalse
      AvgRollbackTimeAverage local rollback duration time (2nd phase only) (in microseconds)doublefalse
      AvgTxArrivalRateAverage transaction arrival rate, originated locally and remotely (in transaction per second)doublefalse
      AvgWriteTxDurationAverage successful write transaction duration (in microseconds)doublefalse
      LocalActiveTransactionsNumber of concurrent transactions executing on the current nodedoublefalse
      LocalExecutionTimeWithoutLockLocal execution time of a transaction without the time waiting for lock acquisitiondoublefalse
      NumAbortedTxDueDeadlockThe number of aborted transactions due to deadlockdoublefalse
      NumAbortedTxDueTimeoutThe number of aborted transactions due to timeout in lock acquisitiondoublefalse
      NumNodesNumber of nodes in the clusterdoublefalse
      NumberOfCommitsNumber of committed transactions since last resetdoublefalse
      NumberOfGetsNumber of gets performed since last resetdoublefalse
      NumberOfLocalCommitsNumber of local committed transactions since last resetdoublefalse
      NumberOfPutsNumber of puts performed since last resetdoublefalse
      NumberOfRemoteGetsNumber of remote gets performed since last resetdoublefalse
      NumberOfRemotePutsNumber of remote puts performed since last resetdoublefalse
      PercentageSuccessWriteTransactionsPercentage of Write transaction executed in all successfully executed transactions (local transaction only)doublefalse
      PercentageWriteTransactionsPercentage of Write transaction executed locally (committed and aborted)doublefalse
      RemoteGetExecutionTimeAverage cost of a remote getdoublefalse
      RemotePutExecutionTimeAverage cost of a remote putdoublefalse
      ReplicationDegreeNumber of replicas for each keydoublefalse
      ThroughputThroughput (in transactions per second)doublefalse
      WriteSkewProbabilityWrite skew probabilitydoublefalse
      Operations 
      NameDescriptionSignature
      dumpStatisticToFileDumps the current cache statistic values to a filevoid dumpStatisticToFile(java.lang.String filePath)
      dumpStatisticsDumps the current cache statistic valuesjava.lang.String dumpStatistics()
      dumpStatisticsToSystemOutDumps the current cache statistic values to System.outvoid dumpStatisticsToSystemOut()
      getPercentileLocalRWriteTransactionK-th percentile of local write transactions execution timedouble getPercentileLocalRWriteTransaction(int percentile)
      getPercentileLocalReadOnlyTransactionK-th percentile of local read-only transactions execution timedouble getPercentileLocalReadOnlyTransaction(int percentile)
      getPercentileRemoteReadOnlyTransactionK-th percentile of remote read-only transactions execution timedouble getPercentileRemoteReadOnlyTransaction(int percentile)
      getPercentileRemoteWriteTransactionK-th percentile of remote write transactions execution timedouble getPercentileRemoteWriteTransaction(int percentile)
      getStatisticValueReturns the raw value for the statisticdouble getStatisticValue(java.lang.String statName)
      resetStatisticsReset all the statistics collectedvoid resetStatistics()
    • GlobalXSiteAdminOperations

      Exposes tooling for handling backing up data to remote sites.

      Operations 
      NameDescriptionSignature
      bringSiteOnlineBrings the given site back online on all the caches.java.lang.String bringSiteOnline(java.lang.String site)
      cancelPushStateCancels the push state on all the caches to remote site.java.lang.String cancelPushState(java.lang.String site)
      pushStatePushes the state of all caches to the corresponding remote site if the cache backups to it. The remote site will be bring back onlinejava.lang.String pushState(java.lang.String site)
      takeSiteOfflineTakes this site offline in all caches in the cluster.java.lang.String takeSiteOffline(java.lang.String site)
    • InboundInvocationHandler

      Handles all the remote requests.

      Attributes 
      NameDescriptionTypeWritable
      AsyncXSiteRequestsReceivedReturns the number of async cross-site requests received by this nodelongfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      SyncXSiteRequestsReceivedReturns the number of sync cross-site requests received by this nodelongfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • LocalTopologyManager

      Controls the cache membership and state transfer

      Attributes 
      NameDescriptionTypeWritable
      ClusterAvailabilityCluster availabilityjava.lang.Stringfalse
      RebalancingEnabledRebalancing enabledbooleantrue
    • ManageableExecutorService

      Attributes 
      NameDescriptionTypeWritable
      ActiveCountReturns the number of active executor threads.intfalse
      KeepAliveTimeReturns the keep-alive time for this pool's threadslongfalse
      LargestPoolSizeReturns the largest ever number of executor threads.intfalse
      MaximumPoolSizeReturns the maximum number of executor threads.inttrue
      PoolSizeReturns the number of threads in this executor.intfalse
      QueueSizeReturns the number of elements in this executor's queue.intfalse
    • Passivation

      Component that handles passivating entries to a CacheStore on eviction.

      Attributes 
      NameDescriptionTypeWritable
      PassivationsNumber of passivation eventslongfalse
      Operations 
      NameDescriptionSignature
      passivateAllPassivate all entries to the CacheStorevoid passivateAll()
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • RecoveryAdmin

      Exposes tooling for handling transaction recovery.

      Operations 
      NameDescriptionSignature
      forceCommitForces the commit of an in-doubt transactionjava.lang.String forceCommit(long internalId, int formatId, byte[] globalTxId, byte[] branchQualifier)
      forceRollbackForces the rollback of an in-doubt transactionjava.lang.String forceRollback(long internalId, int formatId, byte[] globalTxId, byte[] branchQualifier)
      forgetRemoves recovery info for the given transaction.java.lang.String forget(int formatId, byte[] globalTxId, byte[] branchQualifier, long internalId)
      showInDoubtTransactionsShows all the prepared transactions for which the originating node crashedjava.lang.String showInDoubtTransactions()
    • RemoteCacheClientStatisticsMXBean

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

      Attributes 
      NameDescriptionTypeWritable
      AverageRemoteReadTimeReturns the average read time, in milliseconds, for a remote cache.longfalse
      AverageRemoteRemovesTimeReturns the average time, in milliseconds, for remove operations in a remote cache.longfalse
      AverageRemoteStoreTimeReturns the average store time, in milliseconds, for a remote cache.longfalse
      NearCacheHitsReturns the number of near-cache hits. Returns a value of 0 if near-caching is disabled.longfalse
      NearCacheInvalidationsReturns the number of near-cache invalidations. Returns a value of 0 if near-caching is disabled.longfalse
      NearCacheMissesReturns the number of near-cache misses. Returns a value of 0 if near-caching is disabled.longfalse
      NearCacheSizeReturns the number of entries currently stored in the near-cache. Returns a value of 0 if near-caching is disabled.longfalse
      RemoteHitsReturns the number of hits for a remote cache.longfalse
      RemoteMissesReturns the number of misses for a remote cache.longfalse
      RemoteRemovesReturns the number of removes for a remote cache.longfalse
      RemoteStoresReturns 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.longfalse
      TimeSinceResetReturns the time, in seconds, since the last reset. See {@link #resetStatistics()}longfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics.void resetStatistics()
    • RemoteCacheManagerMXBean

      RemoteCacheManager client-side statistics and operations

      Attributes 
      NameDescriptionTypeWritable
      ActiveConnectionCountReturns the number of active connectionsintfalse
      ConnectionCountReturns the total number of connectionsintfalse
      IdleConnectionCountReturns the number of idle connectionsintfalse
      RetriesReturns the total number of retries that have been executedlongfalse
      ServersReturns a list of servers to which the client is currently connected in the format of ip_address:port_number.java.lang.String[]false
      Operations 
      NameDescriptionSignature
      switchToClusterSwitch 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)
      switchToDefaultClusterSwitch 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 
      NameDescriptionSignature
      disconnectSourceDisconnects the target cluster from the source cluster according to the specified migratorvoid disconnectSource(java.lang.String migratorName)
      synchronizeDataSynchronizes data from the old cluster to this using the specified migratorlong 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 
      NameDescriptionTypeWritable
      AsyncXSiteAcksCountReturns the number of async cross-site acknowledges receivedlongfalse
      AsyncXSiteCountReturns the number of async cross-site requestslongfalse
      AverageAsyncXSiteReplicationTimeReturns the average replication time, in milliseconds, for an asynchronous cross-site replication requestlongfalse
      AverageReplicationTimeThe average time spent in the transport layer, in millisecondslongfalse
      AverageXSiteReplicationTimeReturns the average replication time, in milliseconds, for a cross-site replication requestlongfalse
      CommittedViewAsStringRetrieves the committed view.java.lang.Stringfalse
      MaximumAsyncXSiteReplicationTimeReturns the maximum replication time, in milliseconds, for an asynchronous cross-site replication requestlongfalse
      MaximumXSiteReplicationTimeReturns the maximum replication time, in milliseconds, for a cross-site replication requestlongfalse
      MinimumAsyncXSiteReplicationTimeReturns the minimum replication time, in milliseconds, for an asynchronous cross-site replication requestlongfalse
      MinimumXSiteReplicationTimeReturns the minimum replication time, in milliseconds, for a cross-site replication requestlongfalse
      PendingViewAsStringRetrieves the pending view.java.lang.Stringfalse
      ReplicationCountNumber of successful replicationslongfalse
      ReplicationFailuresNumber of failed replicationslongfalse
      SitesViewRetrieves the x-site view.java.lang.Stringfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      SuccessRatioSuccessful replications as a ratio of total replicationsjava.lang.Stringfalse
      SuccessRatioFloatingPointSuccessful replications as a ratio of total replications in numeric double formatdoublefalse
      SyncXSiteCountReturns the number of sync cross-site requestslongfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
      setStatisticsEnabledvoid setStatisticsEnabled(boolean statisticsEnabled)
    • StateTransferManager

      Component that handles state transfer

      Attributes 
      NameDescriptionTypeWritable
      JoinCompleteIf true, the node has successfully joined the grid and is considered to hold state. If false, the join process is still in progress.booleanfalse
      RebalancingStatusRetrieves the rebalancing status for this cache. Possible values are PENDING, SUSPENDED, IN_PROGRESS, BALANCEDjava.lang.Stringfalse
      StateTransferInProgressChecks whether there is a pending inbound state transfer on this cluster member.booleanfalse
    • Transport

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

      Attributes 
      NameDescriptionTypeWritable
      HostNameReturns the host to which the transport binds.java.lang.Stringfalse
      IdleTimeoutReturns the idle timeout.intfalse
      NumberIOThreadsReturns the number of I/O threads.intfalse
      NumberOfGlobalConnectionsReturns 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.intfalse
      NumberOfLocalConnectionsReturns a count of active connections this server.intfalse
      PendingTasksReturns the number of pending tasks.intfalse
      PortReturns the port to which the transport binds.intfalse
      ReceiveBufferSizeReturns the receive buffer size.intfalse
      SendBufferSizeReturns the send buffer size.intfalse
      TcpNoDelayReturns whether TCP no delay was configured or not.booleanfalse
      TotalBytesReadReturns the total number of bytes read by the server from clients which includes both protocol and user information.longfalse
      TotalBytesWrittenReturns the total number of bytes written by the server back to clients which includes both protocol and user information.longfalse
    • XSiteAdmin

      Exposes tooling for handling backing up data to remote sites.

      Operations 
      NameDescriptionSignature
      amendTakeOfflineAmends the values for 'TakeOffline' functionality on all the nodes in the cluster.java.lang.String amendTakeOffline(java.lang.String site, int afterFailures, long minTimeToWait)
      bringSiteOnlineBrings the given site back online on all the cluster.java.lang.String bringSiteOnline(java.lang.String site)
      cancelPushStateCancels the push state to remote site.java.lang.String cancelPushState(java.lang.String siteName)
      cancelReceiveStateCancels the push state to this site. All the state received from state transfer will be ignored.java.lang.String cancelReceiveState(java.lang.String siteName)
      clearPushStateStatusClears the state transfer status.java.lang.String clearPushStateStatus()
      getPushStateStatusShows a map with destination site name and the state transfer status.java.util.Map<java.lang.String,java.lang.String> getPushStateStatus()
      getSendingSiteNameReturns the site name from which this site is receiving state.java.lang.String getSendingSiteName()
      getTakeOfflineAfterFailuresReturns the value of the 'afterFailures' for the 'TakeOffline' functionality.java.lang.String getTakeOfflineAfterFailures(java.lang.String site)
      getTakeOfflineMinTimeToWaitReturns the value of the 'minTimeToWait' for the 'TakeOffline' functionality.java.lang.String getTakeOfflineMinTimeToWait(java.lang.String site)
      pushStatePushes the state of this cache to the remote site. The remote site will be bring back onlinejava.lang.String pushState(java.lang.String siteName)
      setTakeOfflineAfterFailuresAmends 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)
      setTakeOfflineMinTimeToWaitAmends 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)
      siteStatusCheck whether the given backup site is offline or not.java.lang.String siteStatus(java.lang.String site)
      statusReturns the the status(offline/online) of all the configured backup sites.java.lang.String status()
      takeSiteOfflineTakes this site offline in all nodes in the cluster.java.lang.String takeSiteOffline(java.lang.String site)