JMX Components (Infinispan 12.0 API)

MBean Summary 
Name Description
AbstractClusterStats
ActivationComponent that handles activating entries that have been passivated to a CacheStore by loading them into memory.
CacheComponent that represents a simplified cache instance.
CacheComponent that represents an individual cache instance.
CacheComponent that represents an individual cache instance.
CacheContainerStatsGeneral cache container statistics such as timings, hit/miss ratio, etc. for a single node.
CacheLoaderComponent that handles loading entries from a CacheStore into memory.
CacheManagerComponent that acts as a manager, factory and container for caches in the system.
CacheStoreComponent that handles storing of entries to a CacheStore from memory.
CacheUsageStatisticsKeeps tracks of the accessed keys
ClusterCacheStatsGeneral cluster statistics such as timings, hit/miss ratio, etc. for a cache.
ClusterContainerStatsGeneral container statistics aggregated across the cluster.
ConfigurationRuntime cache configuration attributes
DistributionManagerComponent that handles distribution of content across a cluster
ExtendedStatisticsComponent that manages and exposes extended statistics relevant to transactions.
GlobalSecurityManagerControls global ACL caches
GlobalXSiteAdminOperationsExposes tooling for handling backing up data to remote sites.
InboundInvocationHandlerHandles all the remote requests.
InvalidationComponent responsible for invalidating entries on remote caches when entries are written to locally.
JmxStatsCommandInterceptor
LocalTopologyManagerControls the cache membership and state transfer
LockManagerManager that handles MVCC locks for entries
ManageableExecutorService
PassivationComponent that handles passivating entries to a CacheStore on eviction.
ProtobufMetadataManagerComponent that acts as a manager and persistent container for Protocol Buffers message type definitions in the scope of a CacheManger.
RecoveryAdminExposes tooling for handling transaction recovery.
RemoteCacheClientStatisticsMXBeanRemoteCache client-side statistics (such as number of connections)
RemoteCacheManagerMXBeanRemoteCacheManager client-side statistics and operations
RollingUpgradeManagerHandles the migration of data when upgrading between versions.
RpcManagerManages all remote calls to remote cache instances in the cluster.
StateTransferManagerComponent that handles state transfer
StatisticsGeneral statistics such as timings, hit/miss ratio, etc.
StatisticsGeneral statistics such as timings, hit/miss ratio, etc.
StatisticsStatistics for index based query
TransactionsComponent that manages the cache's participation in JTA transactions.
TransportTransport component manages read and write operations to/from server.
WorkerExecutor
XSiteAdminExposes tooling for handling backing up data to remote sites.
    • AbstractClusterStats

      Attributes 
      NameDescriptionTypeWritable
      StaleStatsThresholdGets the threshold for cluster wide stats refresh (milliseconds)longtrue
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      TimeSinceResetNumber of seconds since the cluster-wide statistics were last resetlongfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • Activation

      Component that handles activating entries that have been passivated to a CacheStore by loading them into memory.

      Attributes 
      NameDescriptionTypeWritable
      ActivationCountNumber of activation eventslongfalse
      ActivationsNumber of activation eventsjava.lang.Stringfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • Cache

      Component that represents a simplified cache instance.

      Attributes 
      NameDescriptionTypeWritable
      CacheNameReturns the cache namejava.lang.Stringfalse
      CacheStatusReturns the cache statusjava.lang.Stringfalse
      ConfigurationAsPropertiesReturns the cache configuration in form of propertiesjava.util.Propertiesfalse
      VersionReturns the version of Infinispanjava.lang.Stringfalse
      Operations 
      NameDescriptionSignature
      clearClears the cachevoid clear()
      startStarts the cache.void start()
      stopStops the cache.void stop()
    • Cache

      Component that represents an individual cache instance.

      Attributes 
      NameDescriptionTypeWritable
      CacheAvailabilityReturns the cache availabilityjava.lang.Stringtrue
      CacheNameReturns the cache namejava.lang.Stringfalse
      CacheStatusReturns the cache statusjava.lang.Stringfalse
      ConfigurationAsPropertiesReturns the cache configuration in form of propertiesjava.util.Propertiesfalse
      RebalancingEnabledReturns whether cache rebalancing is enabledbooleantrue
      VersionReturns the version of Infinispanjava.lang.Stringfalse
      Operations 
      NameDescriptionSignature
      clearOperationClears the cachevoid clearOperation()
      shutdownShuts down the cache across the clustervoid shutdown()
      startStarts the cache.void start()
      stopStops the cache.void stop()
    • Cache

      Component that represents an individual cache instance.

      Attributes 
      NameDescriptionTypeWritable
      CacheNameReturns the cache namejava.lang.Stringfalse
      CacheStatusReturns the cache statusjava.lang.Stringfalse
      ConfigurationAsPropertiesReturns the cache configuration in form of propertiesjava.util.Propertiesfalse
      VersionReturns the version of Infinispanjava.lang.Stringfalse
      Operations 
      NameDescriptionSignature
      clearClears the cachevoid clear()
      shutdownShuts down the cache across the clustervoid shutdown()
      startStarts the cache.void start()
      stopStops the cache.void stop()
    • CacheContainerStats

      General cache container statistics such as timings, hit/miss ratio, etc. for a single node.

      Attributes 
      NameDescriptionTypeWritable
      AverageReadTimeCache container total average number of milliseconds for all read operation in this cache containerlongfalse
      AverageReadTimeNanosCache container total average number of nanoseconds for all read operation in this cache containerlongfalse
      AverageRemoveTimeCache container total average number of milliseconds for all remove operation in this cache containerlongfalse
      AverageRemoveTimeNanosCache container total average number of nanoseconds for all remove operation in this cache containerlongfalse
      AverageWriteTimeCache container average number of milliseconds for all write operation in this cache containerlongfalse
      AverageWriteTimeNanosCache container average number of nanoseconds for all write operation in this cache containerlongfalse
      CurrentNumberOfEntriesInMemoryCache container total number of entries currently in-memory for all caches in this cache containerintfalse
      DataMemoryUsedAmount in bytes of memory used in a given cache container for entries with evictionlongfalse
      EvictionsCache container total number of cache eviction operationslongfalse
      HitRatioCache container total percentage hit/(hit+miss) ratio for this cachedoublefalse
      HitsCache container total number of cache attribute hitslongfalse
      MissesCache container total number of cache attribute misseslongfalse
      NumberOfEntriesCache container total number of entries currently in all caches from this cache containerintfalse
      OffHeapMemoryUsedAmount in bytes of off-heap memory used by this cache containerlongfalse
      ReadWriteRatioCache container read/writes ratio in all caches from this cache containerdoublefalse
      RemoveHitsCache container total number of cache removal hitslongfalse
      RemoveMissesCache container total number of cache removals where keys were not foundlongfalse
      RequiredMinimumNumberOfNodesRequired minimum number of nodes to hold current cache dataintfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      StoresCache container total number of cache put operationslongfalse
      TimeSinceResetNumber of seconds since the cache container statistics were last resetlongfalse
      TimeSinceStartNumber of seconds since cache startedlongfalse
    • CacheLoader

      Component that handles loading entries from a CacheStore into memory.

      Attributes 
      NameDescriptionTypeWritable
      CacheLoaderLoadsNumber of entries loaded from cache storelongfalse
      CacheLoaderMissesNumber of entries that did not exist in cache storelongfalse
      StoresReturns a collection of cache loader types which are configured and enabledjava.util.Collectionfalse
      Operations 
      NameDescriptionSignature
      disableStoreDisable all stores of a given type, where type is a fully qualified class name of the cache loader to disablevoid disableStore(java.lang.String storeType)
    • 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)
    • CacheStore

      Component that handles storing of entries to a CacheStore from memory.

      Attributes 
      NameDescriptionTypeWritable
      NumberOfPersistedEntriesNumber of entries currently persisted excluding expired entriesintfalse
      WritesToTheStoresNumber of writes to the storelongfalse
    • 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)
    • ClusterCacheStats

      General cluster statistics such as timings, hit/miss ratio, etc. for a cache.

      Attributes 
      NameDescriptionTypeWritable
      ActivationsThe total number of activations in the clusterlongfalse
      AverageReadTimeCluster wide total average number of milliseconds for a read operation on the cachelongfalse
      AverageReadTimeNanosCluster wide total average number of nanoseconds for a read operation on the cachelongfalse
      AverageRemoveTimeCluster wide total average number of milliseconds for a remove operation in the cachelongfalse
      AverageRemoveTimeNanosCluster wide total average number of nanoseconds for a remove operation in the cachelongfalse
      AverageWriteTimeCluster wide average number of milliseconds for a write operation in the cachelongfalse
      AverageWriteTimeNanosCluster wide average number of nanoseconds for a write operation in the cachelongfalse
      CacheLoaderLoadsThe total number of cacheloader load operations in the clusterlongfalse
      CacheLoaderMissesThe total number of cacheloader load misses in the clusterlongfalse
      CurrentNumberOfEntriesInMemoryCluster wide total number of entries currently stored in-memoryintfalse
      DataMemoryUsedAmount in bytes of memory used across the cluster for entries in this cache with evictionlongfalse
      EvictionsCluster wide total number of cache eviction operationslongfalse
      HitRatioCluster wide total percentage hit/(hit+miss) ratio for this cachedoublefalse
      HitsCluster wide total number of cache attribute hitslongfalse
      InvalidationsThe total number of invalidations in the clusterlongfalse
      MissesCluster wide total number of cache attribute misseslongfalse
      NumberOfEntriesCluster wide total number of entries currently in the cache, including passivated entriesintfalse
      NumberOfLocksAvailableTotal number of exclusive locks available in the clusterintfalse
      NumberOfLocksHeldTotal number of locks held in the clusterintfalse
      OffHeapMemoryUsedAmount in bytes of off-heap memory used across the cluster for this cachelongfalse
      PassivationsThe total number of passivations in the clusterlongfalse
      ReadWriteRatioCluster wide read/writes ratio for the cachedoublefalse
      RemoveHitsCluster wide total number of cache removal hitslongfalse
      RemoveMissesCluster wide total number of cache removals where keys were not foundlongfalse
      RequiredMinimumNumberOfNodesRequired minimum number of nodes to hold current cache dataintfalse
      StoreWritesThe total number of cachestore store operations in the clusterlongfalse
      StoresCluster wide total number of cache put operationslongfalse
      TimeSinceStartNumber of seconds since the first cache node startedlongfalse
    • ClusterContainerStats

      General container statistics aggregated across the cluster.

      Attributes 
      NameDescriptionTypeWritable
      MemoryAvailableThe maximum amount of free memory in bytes across the cluster JVMslongfalse
      MemoryMaxThe maximum amount of memory that JVMs across the cluster will attempt to utilise in byteslongfalse
      MemoryTotalThe total amount of memory in the JVMs across the cluster in byteslongfalse
      MemoryUsedThe amount of memory used by JVMs across the cluster in byteslongfalse
    • Configuration

      Runtime cache configuration attributes

      Attributes 
      NameDescriptionTypeWritable
      EvictionSizeGets the eviction size for the cachelongtrue
    • DistributionManager

      Component that handles distribution of content across a cluster

      Operations 
      NameDescriptionSignature
      isAffectedByRehashDetermines whether a given key is affected by an ongoing rehash, if any.boolean isAffectedByRehash(java.lang.Object key)
      isLocatedLocallyTells you whether a given key would be written to this instance of the cache according to the consistent hashing algorithm. Only works with String keys.boolean isLocatedLocally(java.lang.String key)
      locateKeyShows the addresses of the nodes where a write operation would store the entry associated with the specified key. Only works with String keys.java.util.List<java.lang.String> locateKey(java.lang.String key)
    • 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()
    • GlobalSecurityManager

      Controls global ACL caches

      Operations 
      NameDescriptionSignature
      flushGlobalACLCacheFlushes the global ACL cache for this nodevoid flushGlobalACLCache()
    • 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
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      XSiteRequestsReceivedReturns the number of cross-site requests received by this nodelongfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • Invalidation

      Component responsible for invalidating entries on remote caches when entries are written to locally.

      Attributes 
      NameDescriptionTypeWritable
      InvalidationsNumber of invalidationslongfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • JmxStatsCommandInterceptor

      Attributes 
      NameDescriptionTypeWritable
      StatisticsEnabledEnables or disables the gathering of statistics by this componentbooleantrue
      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
    • LockManager

      Manager that handles MVCC locks for entries

      Attributes 
      NameDescriptionTypeWritable
      ConcurrencyLevelThe concurrency level that the MVCC Lock Manager has been configured with.intfalse
      NumberOfLocksAvailableThe number of exclusive locks that are available.intfalse
      NumberOfLocksHeldThe number of exclusive locks that are held.intfalse
    • 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()
    • ProtobufMetadataManager

      Component that acts as a manager and persistent container for Protocol Buffers message type definitions in the scope of a CacheManger.

      Attributes 
      NameDescriptionTypeWritable
      FilesWithErrorsThe names of the files that have errors, if anyjava.lang.String[]false
      ProtofileNamesThe names of all Protobuf filesjava.lang.String[]false
      Operations 
      NameDescriptionSignature
      getFileErrorsObtains the errors associated with a protobuf definition filejava.lang.String getFileErrors(java.lang.String fileName)
      getProtofileGet the contents of a protobuf definition filejava.lang.String getProtofile(java.lang.String fileName)
      registerProtofileRegisters a Protobuf definition filevoid registerProtofile(java.lang.String fileName, java.lang.String contents)
      registerProtofilesRegisters multiple Protobuf definition filesvoid registerProtofiles(java.lang.String[] fileNames, java.lang.String[] contents)
      unregisterProtofileUnregisters a Protobuf definition filesvoid unregisterProtofile(java.lang.String fileName)
      unregisterProtofilesUnregisters multiple Protobuf definition filesvoid unregisterProtofiles(java.lang.String[] fileNames)
    • 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

      Handles the migration of data when upgrading between versions.

      Operations 
      NameDescriptionSignature
      disconnectSourceDisconnects target clusters from source clusters.void disconnectSource(java.lang.String migratorName)
      synchronizeDataSynchronizes data from source clusters to target clusters with 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 
      NameDescriptionTypeWritable
      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
      MaximumXSiteReplicationTimeReturns the maximum replication time, in milliseconds, for a cross-site replication requestlongfalse
      MinimumXSiteReplicationTimeReturns the minimum replication time, in milliseconds, for a cross-site replication requestlongfalse
      NumberXSiteRequestsReturns the number of sync cross-site requestslongfalse
      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
      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
    • Statistics

      General statistics such as timings, hit/miss ratio, etc.

      Attributes 
      NameDescriptionTypeWritable
      AverageReadTimeAverage number of milliseconds for a read operation on the cachelongfalse
      AverageReadTimeNanosAverage number of nanoseconds for a read operation on the cachelongfalse
      AverageRemoveTimeAverage number of milliseconds for a remove operation in the cachelongfalse
      AverageRemoveTimeNanosAverage number of nanoseconds for a remove operation in the cachelongfalse
      AverageWriteTimeAverage number of milliseconds for a write operation in the cachelongfalse
      AverageWriteTimeNanosAverage number of nanoseconds for a write operation in the cachelongfalse
      DataMemoryUsedAmount of memory in bytes allocated for use in eviction for data in the cachelongfalse
      ElapsedTimeNumber of seconds since cache startedlongfalse
      EvictionsNumber of cache eviction operationslongfalse
      HitRatioPercentage hit/(hit+miss) ratio for the cachedoublefalse
      HitTimesHit TimeshitTimesfalse
      HitsNumber of cache attribute hitslongfalse
      MissTimesMiss timesmissTimesfalse
      MissesNumber of cache attribute misseslongfalse
      NumberOfEntriesNumber of entries in the cache including passivated entriesintfalse
      NumberOfEntriesInMemoryNumber of entries currently in-memory excluding expired entriesintfalse
      OffHeapMemoryUsedAmount off-heap memory used by this cache (bytes)longfalse
      ReadWriteRatioRead/writes ratio for the cachedoublefalse
      RemoveHitsNumber of cache removal hitslongfalse
      RemoveMissesNumber of cache removals where keys were not foundlongfalse
      RemoveTimesRemove TimesremoveTimesfalse
      RequiredMinimumNumberOfNodesAmount of nodes required to guarantee data consistencyintfalse
      StoreTimesStore TimesstoreTimesfalse
      StoresNumber of cache attribute put operationslongfalse
      TimeSinceResetNumber of seconds since the cache statistics were last resetlongfalse
      TimeSinceStartNumber of seconds since cache startedlongfalse
    • Statistics

      General statistics such as timings, hit/miss ratio, etc.

      Attributes 
      NameDescriptionTypeWritable
      AverageReadTimeAverage number of milliseconds for a read operation on the cachelongfalse
      AverageReadTimeNanosAverage number of nanoseconds for a read operation on the cachelongfalse
      AverageRemoveTimeAverage number of milliseconds for a remove operation in the cachelongfalse
      AverageRemoveTimeNanosAverage number of nanoseconds for a remove operation in the cachelongfalse
      AverageWriteTimeAverage number of milliseconds for a write operation in the cachelongfalse
      AverageWriteTimeNanosAverage number of nanoseconds for a write operation in the cachelongfalse
      CurrentNumberOfEntriesInMemoryNumber of entries currently in-memory excluding expired entriesintfalse
      DataMemoryUsedAmount of memory in bytes allocated for use in eviction for data in the cachelongfalse
      EvictionsNumber of cache eviction operationslongfalse
      HitRatioPercentage hit/(hit+miss) ratio for the cachedoublefalse
      HitsNumber of cache attribute hitslongfalse
      MissesNumber of cache attribute misseslongfalse
      NumberOfEntriesNumber of entries in the cache including passivated entriesintfalse
      OffHeapMemoryUsedAmount off-heap memory used by this cache (bytes)longfalse
      ReadWriteRatioRead/writes ratio for the cachedoublefalse
      RemoveHitsNumber of cache removal hitslongfalse
      RemoveMissesNumber of cache removals where keys were not foundlongfalse
      RequiredMinimumNumberOfNodesRequired minimum number of nodes to hold current cache dataintfalse
      StatisticsEnabledEnables or disables the gathering of statistics by this componentenabledtrue
      StoresNumber of cache attribute put operationslongfalse
      TimeSinceResetNumber of seconds since the cache statistics were last resetlongfalse
      TimeSinceStartNumber of seconds since cache startedlongfalse
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • Statistics

      Statistics for index based query

      Attributes 
      NameDescriptionTypeWritable
      IndexedClassNamesjava.util.Setfalse
      ObjectLoadingExecutionAvgTimelongfalse
      ObjectLoadingExecutionMaxTimelongfalse
      ObjectLoadingTotalTimelongfalse
      ObjectsLoadedCountlongfalse
      SearchQueryExecutionAvgTimelongfalse
      SearchQueryExecutionCountlongfalse
      SearchQueryExecutionMaxTimelongfalse
      SearchQueryExecutionMaxTimeQueryStringjava.lang.Stringfalse
      SearchQueryTotalTimelongfalse
      SearchVersionjava.lang.Stringfalse
      StatisticsEnabledbooleantrue
      Operations 
      NameDescriptionSignature
      clearvoid clear()
      getIndexSizelong getIndexSize(java.lang.String indexName)
      getNumberOfIndexedEntitiesint getNumberOfIndexedEntities(java.lang.String entity)
      indexSizesjava.util.Map<java.lang.String,java.lang.Long> indexSizes()
      indexedEntitiesCountjava.util.Map<java.lang.String,java.lang.Integer> indexedEntitiesCount()
    • Transactions

      Component that manages the cache's participation in JTA transactions.

      Attributes 
      NameDescriptionTypeWritable
      CommitsNumber of transaction commits performed since last resetlongfalse
      PreparesNumber of transaction prepares performed since last resetlongfalse
      RollbacksNumber of transaction rollbacks performed since last resetlongfalse
      StatisticsEnabledbooleantrue
      Operations 
      NameDescriptionSignature
      resetStatisticsResets statistics gathered by this componentvoid resetStatistics()
    • 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)