GemFire Management Beans

This document describes the attributes, operations, and notifications of the GemFire Administration Management Beans (MBeans).

GemFireAgent MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
logFileSizeLimit int The maximum size of the JMX Agent log file; a value (in megabytes) in the range 0..1000000. true
logDiskSpaceLimit int The maximum disk space to allocate for logging; a value (in megabytes) in the range 0..1000000. true
logFile java.lang.String The name and path of this Agent's log file. true
logLevel java.lang.String A keyword or integer that defines the minimum level of alerts to be written to the log - for example, only those alerts that are at level WARNING or higher. true
autoConnect boolean If true, the JMX Agent will automatically connect to the distributed system when the Agent is started. The distributed system is specified by the following arguments: mcast-port, mcast-address, locators, remote-command. You can specify these arguments on the agent command line or in the Agent properties file. true
connected boolean True if this Agent is connected to a distributed system. false
propertyFile java.lang.String Name and path of this Agent's properties file. Identical to the argument on the agent command line. true
version java.lang.String The Agent's version. false
systemId java.lang.String A string that describes the associated distributed system. true
mcastAddress java.lang.String Multicast address of the associated distributed system. true
mcastPort int Multicast port of the associated distributed system. true
locators java.lang.String List of locators for connecting to the distributed system. Each locator is uniquely identified by the host on which it is running and the port on which it is listening. true
membershipPortRange java.lang.String The allowed range of UDP ports for use in forming an unique membership identifier. true
bindAddress java.lang.String An IP address that the JMX Agent uses to communicate with members of the distributed system. On a multi-homed host - a machine with multiple network cards - you must explicitly specify the bind address. true
sslEnabled boolean Indicates whether to use the Secure Sockets Layer (SSL) protocol for communication between members of this distributed system. Valid values are "true" and "false". A "true" setting requires the use of locators. true
sslProtocols java.lang.String A space-separated list of the valid SSL protocols for this connection. You can specify "any" to use any protocol that is enabled by default in the configured Java Secure Sockets Extension (JSSE) provider. true
sslCiphers java.lang.String A space-separated list of the valid SSL ciphers for this connection. You can specify "any" to use any ciphers that are enabled by default in the configured JSSE provider. true
sslAuthenticationRequired boolean Indicates whether to require SSL authentication for communication between members of the distributed system. Valid values are "true" and "false". true
sslProperties java.util.Properties The SSL vendor properties to use for the distributed system. false
Operations and Parameters
addSSLProperty void Add an SSL vendor property with the specified key and value.
key java.lang.String Property key
value java.lang.String Property value
removeSSLProperty void Remove the specified SSL vendor property.
key java.lang.String Property key
getLog java.lang.String Display the tail of the Agent's log file.
stop void Stop the Agent after closing all managed resources
saveProperties void Persist the Agent's current configuration to its properties file
connectToSystem javax.management.ObjectName Connect to the distributed system described by this Agent. Returns the ObjectName of the corresponding DistributedSystem MBean.
disconnectFromSystem void Disconnect from the currently connected distributed system.
manageDistributedSystem javax.management.ObjectName Return the ObjectName of the currently connected distributed system. If not connected, return null.

AdminDistributedSystem MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
id java.lang.String A string that uniquely identifies this distributed system. false
systemName java.lang.String Display name of the distributed system true
remoteCommand java.lang.String A default remote command prefix to use for command invocation on remote machines. null
alertLevel com.gemstone.gemfire.admin.AlertLevel Minimum level for alerts to be delivered to listeners. null
mcastAddress java.lang.String Multicast address of this distributed system. false
mcastPort int Multicast port of this distributed system. false
locators java.lang.String List of locators for connecting to this distributed system. Each locator is uniquely identified by the host on which it is running and the port on which it is listening. false
membershipPortRange java.lang.String The allowed range of UDP ports for use in forming an unique membership identifier. false
refreshIntervalForStatAlerts int The interval (in seconds) between auto-polling for checking whether the Stat has exceeded a threshold for which the Stat Alert Definition is defined. null
refreshInterval int The interval (in seconds) between auto-polling for updating AdminDistributedSystem constituents including SystemMember and StatisticResource. This applies only to the default interval set when the resource is created. This interval is read-only and retains the value set when the Agent config is created false
canPersistStatAlertDefs boolean Indicates whether Statistics Alert definitions could be persisted across runs/sessions of the JMX Agent. false
missingPersistentMembers javax.management.openmbean.TabularData Retrieve the set of persistent files that the existing members are waiting for. false
Notifications and Fields
gemfire.distributedsystem.member.joined A GemFire manager, cache, or other member has joined this distributed system.
name gemfire.distributedsystem.member.joined
severity 6
descriptorType notification
gemfire.distributedsystem.member.left A GemFire manager, cache, or other member has left the distributed system.
name gemfire.distributedsystem.member.left
severity 6
descriptorType notification
gemfire.distributedsystem.member.crashed A member of this distributed system has crashed instead of leaving cleanly.
name gemfire.distributedsystem.member.crashed
severity 4
descriptorType notification
gemfire.distributedsystem.alert A member of this distributed system has generated an alert.
name gemfire.distributedsystem.alert
severity 0
descriptorType notification
Operations and Parameters
waitToBeConnected boolean Wait for the connection to the distributed system to be established
timeout long Number of milliseconds to wait to be connected
start void Start all locators defined for this distributed system.
stop void Stop all locators defined for this distributed system.
manageDistributionLocator javax.management.ObjectName Creates a new distribution locator that is ready to configure and start
manageDistributionLocators [Ljavax.management.ObjectName; Return an array of JMX ObjectNames for all locators known to this distributed system.
manageCacheVm javax.management.ObjectName Create a new CacheVm MBean (that is, make this distributed system aware of a cache server that has not been started ).
manageCacheVms [Ljavax.management.ObjectName; Return an array of JMX ObjectNames for all cache vms known to this distributed system.
manageCacheServer javax.management.ObjectName Create a new CacheVm MBean (that is, make this distributed system aware of a cache vm that has not been started ). This action is deprecated as of 5.7 use manageCacheVm instead.
manageCacheServers [Ljavax.management.ObjectName; Return an array of JMX ObjectNames for all cache vms known to this distributed system. This action is deprecated as of 5.7 use manageCacheVm instead.
manageSystemMemberApplications [Ljavax.management.ObjectName; Return an array of JMX ObjectNames for all applications that are members of this distributed system.
monitorGemFireHealth javax.management.ObjectName Return the ObjectName for the GemFireHealth MBean.
displayMergedLogs java.lang.String Combine the tails of all system members' logs into a merged log, with the entries ordered by timestamp.
getLicense java.util.Properties Display GemFire licensing information.
getLatestAlert java.lang.String Display the most recent system alert.
createDistributionLocator javax.management.ObjectName Create a DistributionLocator MBean. The parameters specify the locator's host machine, the port on which it listens, the working directory hosting the locator, and product directory used by the locator.
host java.lang.String Host machine for the Locator
port int Port for the Locator to listen on
workingDirectory java.lang.String The working directory hosting the Locator
productDirectory java.lang.String The GemFire product directory used by the Locator
manageSystemMember javax.management.ObjectName Return the ObjectName for the SystemMemberMBean representing the specified distributed member or null if the member is not found.
distributedMember com.gemstone.gemfire.distributed.DistributedMember The distributed member to manage
getAllStatAlertDefinitions [Lcom.gemstone.gemfire.internal.admin.StatAlertDefinition; Return an array of all available Stat Alert Definitions objects.
updateAlertDefinition void Update/Add an Admin Stat Alert Definition to the Aggregator. Sends the updated definition to all the Managers/Members.
alertDefinition com.gemstone.gemfire.internal.admin.StatAlertDefinition The Admin Stat Alert Definition to be updated/added to the Aggregator
removeAlertDefinition void Remove an Admin Stat Alert Definition from the Aggregator and all the Managers/Members.
defId java.lang.Integer The unique id of the Admin Stat Alert Definition to be removed from the Aggregator
isAlertDefinitionCreated boolean Check whether the alert definition is already created.
alertDefinition com.gemstone.gemfire.internal.admin.StatAlertDefinition The Admin Stat Alert Definition to be checked
revokePersistentMember void Indicate to the distributed system that persistent files have been lost.
host java.lang.String The host of the members to revoke. If null, it will match all hosts
directory java.lang.String The directory on the members to revoke. If null, it will match all directories
shutDownAllMembers void Shutting down all members with cache in the distributed system gracefully.

SystemMember MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
id java.lang.String A string that uniquely identifies the application within the distributed system. false
name java.lang.String The application-defined member name. false
host java.lang.String The host machine on which this application is running. false
refreshInterval int The interval (in seconds) between auto-refreshes of this application;s configuration attributes, as defined in the gemfire.properties file. To disable the JMX Timer service's auto-refresh feature, set this attribute to zero or less. Effective 6.0, any changes to this parameter wil not affect the current refreshInterval. To change the refreshInterval use AdminDistributedSystem.refreshInterval null
version java.lang.String Display GemFire version information. false
hasCache boolean Does the system member host a GemFire Cache? false
distributedMember com.gemstone.gemfire.distributed.DistributedMember Distributed membership identity. false
Notifications and Fields
gemfire.distributedsystem.cache.created A cache got created on a member of this distributed system.
name gemfire.distributedsystem.cache.created
severity 6
descriptorType notification
gemfire.distributedsystem.cache.closed A cache is closed on a member of this distributed system.
name gemfire.distributedsystem.cache.closed
severity 6
descriptorType notification
gemfire.distributedsystem.cache.region.created A region is created in a cache on a member of this distributed system.
name gemfire.distributedsystem.cache.region.created
severity 6
descriptorType notification
gemfire.distributedsystem.cache.region.lost A region was removed from a cache on a member of this distributed system.
name gemfire.distributedsystem.cache.region.lost
severity 6
descriptorType notification
Operations and Parameters
getRoles [Ljava.lang.String; Get the membership roles filled by this member.
getLog java.lang.String Display the main log for this system member.
getLicense java.util.Properties Display GemFire licensing information.
manageCache javax.management.ObjectName Create a SystemMemberCache MBean for this application.
manageStats [Ljavax.management.ObjectName; Create a StatisticResource MBean for each statistic resource in this member.
manageStat [Ljavax.management.ObjectName; Create a StatisticResource MBean for each statistic resource in this member, given the underlying Statistics Type name.
statisticsTypeName java.lang.String Name of the underlying Statistics Type eg. DistributionStats
refreshConfig void Refresh configuration attributes for this application, using the gemfire.properties file.
getConfiguration [Lcom.gemstone.gemfire.admin.ConfigurationParameter; Returns the current configuration attributes for this application, using the gemfire.properties file.

StatisticResource MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
name java.lang.String The JMX ObjectName of this statistic resource. false
description java.lang.String Description of this statistic resource. false
type java.lang.String Classification type of this statistic resource. false
owner java.lang.String Name of the source process. false
refreshInterval int The interval (in seconds) between auto-refreshes of statistical information. To turn off the JMX Timer service's auto-refresh feature, set this attribute to zero or less. If you're concerned about system performance, leave this set to zero. Effective 6.0, any changes to this parameter wil not affect the current refreshInterval. To change the refreshInterval use AdminDistributedSystem.refreshInterval null
Operations and Parameters
refresh void Refresh values of statistics.
getStatistics [Lcom.gemstone.gemfire.admin.Statistic; Returns a current snapshot of statistics.

DistributionLocator MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
id java.lang.String Id of the distribution locator. false
host java.lang.String The host machine on which this locator is running. false
workingDirectory java.lang.String The current working directory of the locator. true
productDirectory java.lang.String The location of the GemFire installation used to run this locator. true
port int The port on which this locator is listening: a value in the range 0..65535. true
bindAddress java.lang.String The interface address to which the locator binds. true
running boolean True if this locator is running. false
Operations and Parameters
start void Start this distribution locator.
waitToStart boolean Wait for the distribution locator to start
timeout long Number of milliseconds to wait to start
waitToStop boolean Wait for the distribution locator to stop
timeout long Number of milliseconds to wait to stop
stop void Stop this distribution locator.
getLog java.lang.String Display the tail of the locator service's log.
remove void Remove this distribution locator.

SystemMemberCache MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
name java.lang.String The name of the Cache false
closed boolean True if this cache has been closed. false
lockTimeout int Seconds that a cache operation will wait to obtain a distributed lock lease. true
lockLease int The length, in seconds, of distributed lock leases obtained by this cache. true
searchTimeout int Seconds that a cache get operation can spend searching for a value before it times out. true
upTime int Seconds that this cache has been open. false
rootRegionNames java.util.Set A set of the names of each root region currently in this cache. false
server boolean Is this a cache server? true
Operations and Parameters
getSnapshot com.gemstone.gemfire.admin.GemFireMemberStatus Get Member Cache Status
getRegionSnapshot com.gemstone.gemfire.admin.RegionSubRegionSnapshot Get Member Cache's Region Snapshot
manageRegion javax.management.ObjectName Creates a SystemMemberRegion MBean for the region with the specified path.
path java.lang.String Full path of region to create an mbean for.
getStatistics [Lcom.gemstone.gemfire.admin.Statistic; Returns a current snapshot of cache statistics.
refresh void Updates each attribute in this MBean.
manageBridgeServer javax.management.ObjectName Creates a new, unstarted bridge server for the cache. Deprecated as of 5.7 use manageCacheServer instead.
manageBridgeServers [Ljavax.management.ObjectName; Returns the names of the MBeans for the cache's bridge servers. Deprecated as of 5.7 use manageCacheServer instead.
manageCacheServer javax.management.ObjectName Creates a new, unstarted cache server for the cache
manageCacheServers [Ljavax.management.ObjectName; Returns the names of the MBeans for the cache's cache servers

SystemMemberRegion MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
name java.lang.String The name (not the full-path) of this region. false
fullPath java.lang.String The full path name of this region false
userAttribute java.lang.String Description of the region's user attribute object. false
cacheLoader java.lang.String Description of the region's cache loader. false
cacheWriter java.lang.String Description of the region's cache writer. false
evictionAttributes com.gemstone.gemfire.cache.EvictionAttributes Description of the region's eviction attributes. false
cacheListener java.lang.String Description of the region's cache listener. This attribute is deprecated as of 6.0. Use getCacheListeners method instead. false
keyConstraint java.lang.String Name of the class that keys in this region are constrained to be false
regionTimeToLiveTimeLimit int This region's time to live time limit. false
regionTimeToLiveAction java.lang.Object This region's time to live action. false
entryTimeToLiveTimeLimit int This region's entry time to live time limit. false
entryTimeToLiveAction java.lang.Object This region's entry time to live action. false
regionIdleTimeoutTimeLimit int This region's idle timeout time limit. false
regionIdleTimeoutAction java.lang.Object This region's idle timeout action. false
entryIdleTimeoutTimeLimit int This region's entry idle timeout time limit. false
entryIdleTimeoutAction java.lang.Object This region's entry idle timeout action. false
mirrorType java.lang.Object This region's mirror type. false
dataPolicy java.lang.Object This region's data policy. false
scope java.lang.Object This region's scope. false
initialCapacity int This region's initial capacity. false
loadFactor float This region's load factor. false
concurrencyLevel int This region's concurrency level. false
statisticsEnabled boolean True if statistics are enabled on this region. false
persistBackup boolean true if the contents of the region are persisted to disk false
earlyAck boolean false if ack is sent after processing update; true if sent early false
diskWriteAttributes com.gemstone.gemfire.cache.DiskWriteAttributes Description of how the region's contents is written to disk false
diskDirs [Ljava.io.File; Directories to which the region's contents are written false
entryCount int Number of entries in this region. false
subregionCount int Number of subregions in this region. false
lastModifiedTime long Last time an entry's value in this region or one of its subregions was modified. false
lastAccessedTime long Last time an entry in this region or one of its subregions was accessed. false
hitCount long Number of times that a get on this region found a local value. false
missCount long Number of times that a get on this region did not find a local value. false
hitRatio float Ratio of hits to total get calls. false
subregionNames java.util.Set A set of the names of each subregion of this region. false
subregionFullPaths java.util.Set A set of the full paths of each subregion of this region. false
membershipAttributes com.gemstone.gemfire.cache.MembershipAttributes Description of the region's membership attributes. false
subscriptionAttributes com.gemstone.gemfire.cache.SubscriptionAttributes Description of the region's subscription attributes. false
partitionAttributes com.gemstone.gemfire.cache.PartitionAttributes Description of the region's partition attributes. false
Operations and Parameters
refresh void Updates each attribute in this MBean.
getCacheListeners [Ljava.lang.String; Descriptions of all CacheListeners on this region as a String array. If there are no cacheListeners defined on the region an empty array is returned.

SystemMemberCacheServer MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
port int The port on which this cache server listens for clients. true
bindAddress java.lang.String The address on which this cache server listens for clients. true
hostnameForClients java.lang.String The host name or ip address that will be given to clients who discover this cache server true
notifyBySubscription boolean Whether or not this cache server should notify clients based on key subscription. true
socketBufferSize int The socket buffer size in bytes for connections made by clients to this server. true
maximumTimeBetweenPings int The maximum amount of time, in milliseconds, between pinging a client to determine its health. true
maxConnections int The maxium number of client connections allowed by this server. true
maxThreads int The maxium number of threads allowed in this server to service client requests. true
maximumMessageCount int The maximum number of messages that can be enqueued in a client-queue on this server. true
messageTimeToLive int The time, in seconds, after which a message in a client-queue on this server will expire. true
groups [Ljava.lang.String; The list of server groups that this cache server belongs to. true
loadPollInterval long The period, in milliseconds, to test the load for this cache server using the load probe true
loadProbe java.lang.String The period, in milliseconds, to test the load for this cache server using the load probe false
running boolean True if cache server is running. false
Operations and Parameters
start void Starts the cache server.
stop void Stops the cache server.
refresh void Updates each attribute in this MBean.

CacheVm MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
id java.lang.String A string that uniquely identifies the cache vm. false
name java.lang.String The JMX ObjectName of this managed resource. false
host java.lang.String The host machine on which the cache vm is running. false
refreshInterval int The interval (in seconds) between auto-refreshes of this application;s configuration attributes, as defined in the gemfire.properties file. To disable the JMX Timer service's auto-refresh feature, set this attribute to zero or less. null
version java.lang.String Display GemFire version information. false
hasCache boolean Does the cache vm host a GemFire Cache? false
distributedMember com.gemstone.gemfire.distributed.DistributedMember Distributed membership identity. false
productDirectory java.lang.String The location of the GemFire installation used to run this cache vm. true
workingDirectory java.lang.String The directory in which the cache vm was launched. true
running boolean True if this cache vm is running. false
cacheXMLFile java.lang.String The declarative caching file user to configure this cache vm. true
classPath java.lang.String Location(s) of user classes required by cache vm true
Notifications and Fields
gemfire.distributedsystem.cache.created A cache got created on a member of this distributed system.
name gemfire.distributedsystem.cache.created
severity 6
descriptorType notification
gemfire.distributedsystem.cache.closed A cache is closed on a member of this distributed system.
name gemfire.distributedsystem.cache.closed
severity 6
descriptorType notification
gemfire.distributedsystem.cache.region.created A region is created in a cache on a member of this distributed system.
name gemfire.distributedsystem.cache.region.created
severity 6
descriptorType notification
gemfire.distributedsystem.cache.region.lost A region was removed from a cache on a member of this distributed system.
name gemfire.distributedsystem.cache.region.lost
severity 6
descriptorType notification
Operations and Parameters
getRoles [Ljava.lang.String; Get the membership roles filled by this member.
start void Start this cache vm.
waitToStart boolean Wait for the cache vm to start
timeout long Number of milliseconds to wait to start
waitToStop boolean Wait for the cache vm to stop
timeout long Number of milliseconds to wait to stop
stop void Stop this cache vm.
getLog java.lang.String Display the log for this cache vm.
getLicense java.util.Properties Display GemFire licensing information.
manageCache javax.management.ObjectName Create a SystemMemberCache MBean for the cache in this cache vm.
manageStats [Ljavax.management.ObjectName; Create a StatisticResource MBean for each statistic resource in this member.
manageStat [Ljavax.management.ObjectName; Create a StatisticResource MBean for each statistic resource in this member, given the underlying Statistics Type name.
statisticsTypeName java.lang.String Name of the underlying Statistics Type eg. DistributionStats
refreshConfig void Refresh configuration attributes for this application, using the gemfire.properties file.
getConfiguration [Lcom.gemstone.gemfire.admin.ConfigurationParameter; Returns the current configuration attributes for this application, using the gemfire.properties file.

GemFireHealth MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
health com.gemstone.gemfire.admin.GemFireHealth$Health The overall health of the distributed system: Good, Okay, or Poor. false
healthStatus java.lang.String The current status of the overall health of GemFire false
Operations and Parameters
resetHealth void Resets the overall health of the distributed system to Good (optimal).
getDiagnosis java.lang.String Returns a description of any causes of ill health in the distributed system.
manageGemFireHealthConfig javax.management.ObjectName Registers a new GemFireHealthConfig MBean and returns its ObjectName
host java.lang.String The host to monitor the health of

DistributedSystemHealthConfig MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
maxDepartedApplications long The maximum number of system members that can unexpectedly leave a healthy distributed system. true
Operations and Parameters
applyChanges void Applies these configuration attributes to the GemFire health monitor.

GemFireHealthConfig MBean

Description: GemFire distributed system
Attributes Name Type Description Writable
healthEvaluationInterval int The number of seconds to wait between two health assessments of this distributed system. true
maxNetSearchTime long The maximum time (in milliseconds) that a netSearch operation can take before the cache member is considered to be unhealthy. true
maxLoadTime long The maximum time (in milliseconds) that a cache load operation can take before the cache member is considered to be unhealthy. true
minHitRatio double The minimum hit ratio in order for a cache member to be considered healthy. true
maxEventQueueSize long The maximum number of entries in the event delivery queue of a healthy cache member. true
maxVMProcessSize long The maximum process size (in megabytes) of a healthy member of the distributed system. true
maxMessageQueueSize long The maximum number of enqueued incoming or outgoing messages that a healthy member of a distributed system can have. true
maxReplyTimeouts long The maximum number of message replies that can time out in a healthy member. true
Operations and Parameters
applyChanges void Applies this configuration to the GemFire health monitor.