com.gemstone.gemfire.management
Interface DistributedSystemMXBean

public interface DistributedSystemMXBean

MBean that provides access to information and management operations for a DistributedSystem. It also provides an API for navigating the other MBeans exposed by the GemFire distributed system.

Since:

7.0

Method Summary

DiskBackupStatus	backupAllMembers(String targetDirPath) Performs a backup on all members.
void	changeAlertLevel(String alertLevel) Sets the minimum level for alerts to be delivered to listeners.
ObjectName	fetchCacheServerObjectName(String member, int port) Returns the object name for a CacheServerMXBean used to access a cache server.
ObjectName	fetchDiskStoreObjectName(String member, String diskStoreName) Returns object name of a DiskStoreMXBean for a given name and member
ObjectName	fetchDistributedLockServiceObjectName(String lockServiceName) Returns the object name for a DistributedLockServiceMXBean used to access a distributed lock service.
ObjectName	fetchDistributedRegionObjectName(String regionPath) Returns the object name for a DistributedRegionMXBean used to access a distributed region.
ObjectName	fetchGatewayReceiverObjectName(String member) Returns the object name for a GatewayReceiverMXBean used to access a gateway receiver.
ObjectName	fetchGatewaySenderObjectName(String member, String senderId) Returns the object name for a GatewaySenderMXBean used to access a gateway sender.
ObjectName	fetchLockServiceObjectName(String member, String lockService) Returns the object name for a LockServiceMXBean used to access a lock service.
GemFireProperties	fetchMemberConfiguration(String member) Returns the configuration information for a distributed member.
ObjectName	fetchMemberObjectName(String member) Returns the object name for a MemberMXBean used to access a distributed member..
long	fetchMemberUpTime(String member) Returns the total time (in seconds) since a distributed member was started.
ObjectName	fetchRegionObjectName(String member, String regionPath) Returns the object name for a RegionMXBean used to access a region.
ObjectName[]	fetchRegionObjectNames(ObjectName memberMBeanName) Returns a list of object names for the RegionMXBeans used to access all regions on a distributed member.
long	getActiveCQCount() Returns the number of active (currently executing) CQs for all cache servers.
String	getAlertLevel() Returns the minimum level set for alerts to be delivered to listeners.
float	getAverageReads() Returns the average number of reads per second for all members.
float	getAverageWrites() Returns the average writes per second, including both put and putAll operations, for all members.
long	getDiskFlushAvgLatency() Returns the average disk flush latency time.
float	getDiskReadsRate() Returns the average number of disk reads per second across all distributed members.
float	getDiskWritesRate() Returns the average number of disk writes per second across all distributed members.
int	getDistributedSystemId() Returns the ID of thie DistributedSystem.
long	getGarbageCollectionCount() Returns the number of garbage collection operations for all members.
long	getJVMPauses() Returns the number JVM pauses (which may or may not include full garbage collection pauses) detected by GemFire.
int	getLocatorCount() Returns the number of locators in the distributed system.
ObjectName	getManagerObjectName() Returns the object name for a ManagerMXBean used to access the management service running on this distributed member.
int	getMemberCount() Returns the number of members in the distributed system.
ObjectName	getMemberObjectName() Returns the object name for a MemberMXBean used to access this distributed member.
int	getNumClients() Returns the number of connected clients.
int	getNumInitialImagesInProgress() Returns the number of initial images in progress.
int	getNumRunningFunctions() Returns the number of map-reduce jobs currently running on all members in the distributed system.
int	getNumSubscriptions() Returns the number of subscriptions for all members.
float	getQueryRequestRate() Returns the average number of queries per second across all distributed members.
long	getRegisteredCQCount() Returns the number of CQs registers on all members.
int	getSystemDiskStoreCount() Returns the number of disks stores in the distributed system.
int	getTotalBackupInProgress() Returns the number of backups currently in progress for all disk stores.
long	getTotalBytesOnDisk() Returns the total number of bytes used on all disks.
long	getTotalDiskUsage() Returns the number of megabytes used on all disks.
long	getTotalHeapSize() Returns the total available heap (in megabytes) across all distributed members.
int	getTotalHitCount() Returns the number of times that a hit occurred for all regions.
int	getTotalMissCount() Returns the number of times that a cache miss occurred for all regions.
int	getTotalRegionCount() Returns the number of Regions.
long	getTotalRegionEntryCount() Returns the total number of entries in all regions.
long	getUsedHeapSize() Returns the total heap used on all members.
String[]	listAllRegionPaths() Returns a list of full paths for all regions.
ObjectName[]	listCacheServerObjectNames() Returns a list of object names for the CacheServerMXBeans used to access all cache servers.
String[]	listCacheServers() Returns a list of names for all cache servers.
ObjectName[]	listDistributedRegionObjectNames() Returns a list of object names for the DistributedRegionMXBeans used to access all distributed regions.
ObjectName[]	listGatewayReceiverObjectNames() Returns a list of object names for the GatewayReceiverMXBeans used to access all gateway senders.
String[]	listGatewayReceivers() Returns a list of IDs for all gateway receivers.
ObjectName[]	listGatewaySenderObjectNames() Returns a list of object names for the GatewaySenderMXBeans used to access all gateway senders.
ObjectName[]	listGatewaySenderObjectNames(String member) Returns a list of object names for the GatewaySenderMXBeans used to access all gateway senders on a member.
String[]	listGatwaySenders() Returns a list of IDs for all gateway senders.
String[]	listGroups() Returns a list of names for all groups.
String[]	listLocators() Returns a list of IDs for all locators.
Map<String,String[]>	listMemberDiskstore() Returns a map of all DistributedMembers and their DiskStores.
ObjectName[]	listMemberObjectNames() Returns a list of object names for the MemberMXBeans used to access all distributed members.
String[]	listMembers() Returns a list of names for all members.
PersistentMemberDetails[]	listMissingDiskStores() Returns a list of details for disk stores which have been determined to be unavailable during the recovery of region.
String[]	listRegions() Returns a list of names for all regions.
boolean	revokeMissingDiskStores(String diskStoreId) Removes a disk store from the distributed system.
DiskMetrics	showDiskMetrics(String member) Returns disk metrics for a distributed member.
JVMMetrics	showJVMMetrics(String member) Returns JVM metrics for a distributed member.
NetworkMetrics	showNetworkMetric(String member) Returns network metrics for a distributed member.
OSMetrics	showOSMetrics(String member) Returns operating system metrics for a distributed member.
String[]	shutDownAllMembers() Shuts down all members of a distributed system except for the managing member.
Map<String,Boolean>	viewRemoteClusterStatus() Returns a map of remote distributed system IDs and the current connection status for each.

Method Detail

getDistributedSystemId

int getDistributedSystemId()

Returns the ID of thie DistributedSystem.

Returns:

The DistributedSystem ID or -1 if not set.

getMemberCount

int getMemberCount()

Returns the number of members in the distributed system.

listMembers

String[] listMembers()

Returns a list of names for all members.

listGroups

String[] listGroups()

Returns a list of names for all groups.

getLocatorCount

int getLocatorCount()

Returns the number of locators in the distributed system.

listLocators

String[] listLocators()

Returns a list of IDs for all locators.

getSystemDiskStoreCount

int getSystemDiskStoreCount()

Returns the number of disks stores in the distributed system.

listMemberDiskstore

Map<String,String[]> listMemberDiskstore()

Returns a map of all DistributedMembers and their DiskStores.

listGatwaySenders

String[] listGatwaySenders()

Returns a list of IDs for all gateway senders.

listGatewayReceivers

String[] listGatewayReceivers()

Returns a list of IDs for all gateway receivers.

getAlertLevel

String getAlertLevel()

Returns the minimum level set for alerts to be delivered to listeners.

changeAlertLevel

void changeAlertLevel(String alertLevel)
                      throws Exception

Sets the minimum level for alerts to be delivered to listeners.

Parameters:

alertLevel - Minimum level for alerts to be delivered. Must be one of: WARNING, ERROR, SEVERE or NONE.

Throws:

Exception

getTotalHeapSize

long getTotalHeapSize()

Returns the total available heap (in megabytes) across all distributed members.

getTotalRegionEntryCount

long getTotalRegionEntryCount()

Returns the total number of entries in all regions.

getTotalRegionCount

int getTotalRegionCount()

Returns the number of Regions.

getTotalMissCount

int getTotalMissCount()

Returns the number of times that a cache miss occurred for all regions.

getTotalHitCount

int getTotalHitCount()

Returns the number of times that a hit occurred for all regions.

getNumClients

int getNumClients()

Returns the number of connected clients.

getDiskReadsRate

float getDiskReadsRate()

Returns the average number of disk reads per second across all distributed members.

getDiskWritesRate

float getDiskWritesRate()

Returns the average number of disk writes per second across all distributed members.

getDiskFlushAvgLatency

long getDiskFlushAvgLatency()

Returns the average disk flush latency time.

getTotalBackupInProgress

int getTotalBackupInProgress()

Returns the number of backups currently in progress for all disk stores.

getNumInitialImagesInProgress

int getNumInitialImagesInProgress()

Returns the number of initial images in progress.

getActiveCQCount

long getActiveCQCount()

Returns the number of active (currently executing) CQs for all cache servers.

getQueryRequestRate

float getQueryRequestRate()

Returns the average number of queries per second across all distributed members.

backupAllMembers

DiskBackupStatus backupAllMembers(String targetDirPath)
                                  throws Exception

Performs a backup on all members.

Parameters:

targetDirPath - Directory to which backup files will be written

Returns:

The results of the backup request.

Throws:

Exception

fetchMemberConfiguration

GemFireProperties fetchMemberConfiguration(String member)
                                           throws Exception

Returns the configuration information for a distributed member.

Parameters:

member - Name or ID of the member.

Returns:

The configuration information for a member.

Throws:

Exception - for an invalid member ID.

fetchMemberUpTime

long fetchMemberUpTime(String member)
                       throws Exception

Returns the total time (in seconds) since a distributed member was started.

Parameters:

member - Name or ID of the member.

Returns:

The total time (in seconds) since a member was started.

Throws:

Exception - for an invalid member ID.

listCacheServers

String[] listCacheServers()

Returns a list of names for all cache servers.

showJVMMetrics

JVMMetrics showJVMMetrics(String member)
                          throws Exception

Returns JVM metrics for a distributed member.

Parameters:

member - Name or ID of the member.

Throws:

Exception - for an invalid member ID.

showOSMetrics

OSMetrics showOSMetrics(String member)
                        throws Exception

Returns operating system metrics for a distributed member.

Parameters:

member - Name or ID of the member.

Throws:

Exception - for an invalid member ID.

showNetworkMetric

NetworkMetrics showNetworkMetric(String member)
                                 throws Exception

Returns network metrics for a distributed member.

Parameters:

member - Name or ID of the member.

Throws:

Exception - for an invalid member ID.

showDiskMetrics

DiskMetrics showDiskMetrics(String member)
                            throws Exception

Returns disk metrics for a distributed member.

Parameters:

member - Name or ID of the member.

Throws:

Exception - for an invalid member ID.

shutDownAllMembers

String[] shutDownAllMembers()
                            throws Exception

Shuts down all members of a distributed system except for the managing member.

Returns:

List of names of all distributed members that were shutdown.

Throws:

Exception

listRegions

String[] listRegions()

Returns a list of names for all regions.

listAllRegionPaths

String[] listAllRegionPaths()

Returns a list of full paths for all regions.

revokeMissingDiskStores

boolean revokeMissingDiskStores(String diskStoreId)
                                throws Exception

Removes a disk store from the distributed system.

Parameters:

diskStoreId - UUID of the disk store to remove

Returns:

True if the request is successful, false otherwise.

Throws:

Exception

listMissingDiskStores

PersistentMemberDetails[] listMissingDiskStores()

Returns a list of details for disk stores which have been determined to be unavailable during the recovery of region.

getMemberObjectName

ObjectName getMemberObjectName()

Returns the object name for a MemberMXBean used to access this distributed member.

getManagerObjectName

ObjectName getManagerObjectName()

Returns the object name for a ManagerMXBean used to access the management service running on this distributed member.

listMemberObjectNames

ObjectName[] listMemberObjectNames()

Returns a list of object names for the MemberMXBeans used to access all distributed members.

fetchMemberObjectName

ObjectName fetchMemberObjectName(String member)
                                 throws Exception

Returns the object name for a MemberMXBean used to access a distributed member..

Parameters:

member - Name or ID of the member.

Throws:

Exception

fetchRegionObjectNames

ObjectName[] fetchRegionObjectNames(ObjectName memberMBeanName)
                                    throws Exception

Returns a list of object names for the RegionMXBeans used to access all regions on a distributed member.

Parameters:

memberMBeanName - ObjectName of the member.

Throws:

Exception

listDistributedRegionObjectNames

ObjectName[] listDistributedRegionObjectNames()

Returns a list of object names for the DistributedRegionMXBeans used to access all distributed regions.

Returns:

An array of object names or an empty array if no distributed regions are found.

fetchDistributedRegionObjectName

ObjectName fetchDistributedRegionObjectName(String regionPath)
                                            throws Exception

Returns the object name for a DistributedRegionMXBean used to access a distributed region.

Parameters:

regionPath - Full path of the region.

Throws:

Exception

fetchRegionObjectName

ObjectName fetchRegionObjectName(String member,
                                 String regionPath)
                                 throws Exception

Returns the object name for a RegionMXBean used to access a region.

Parameters:

member - Name or ID of the member.

regionPath - Full path of the region.

Throws:

Exception

fetchGatewaySenderObjectName

ObjectName fetchGatewaySenderObjectName(String member,
                                        String senderId)
                                        throws Exception

Returns the object name for a GatewaySenderMXBean used to access a gateway sender.

Parameters:

member - Name or ID of the member.

senderId - ID of a gateway sender.

Throws:

Exception

fetchGatewayReceiverObjectName

ObjectName fetchGatewayReceiverObjectName(String member)
                                          throws Exception

Returns the object name for a GatewayReceiverMXBean used to access a gateway receiver.

Parameters:

member - Name or ID of the member.

Throws:

Exception

listGatewaySenderObjectNames

ObjectName[] listGatewaySenderObjectNames()

Returns a list of object names for the GatewaySenderMXBeans used to access all gateway senders.

Returns:

An array of object names or an empty array if no gateway senders are found.

listGatewaySenderObjectNames

ObjectName[] listGatewaySenderObjectNames(String member)
                                          throws Exception

Returns a list of object names for the GatewaySenderMXBeans used to access all gateway senders on a member.

Parameters:

member - Name or ID of the member.

Throws:

Exception

listGatewayReceiverObjectNames

ObjectName[] listGatewayReceiverObjectNames()

Returns a list of object names for the GatewayReceiverMXBeans used to access all gateway senders.

Returns:

An array of object names or an empty array if no gateway receivers are found.

fetchDistributedLockServiceObjectName

ObjectName fetchDistributedLockServiceObjectName(String lockServiceName)
                                                 throws Exception

Returns the object name for a DistributedLockServiceMXBean used to access a distributed lock service.

Parameters:

lockServiceName - Name of the lock service.

Throws:

Exception

fetchLockServiceObjectName

ObjectName fetchLockServiceObjectName(String member,
                                      String lockService)
                                      throws Exception

Returns the object name for a LockServiceMXBean used to access a lock service.

Parameters:

member - Name or Id of the member.

lockService - Name of the lock service.

Throws:

Exception

fetchDiskStoreObjectName

ObjectName fetchDiskStoreObjectName(String member,
                                    String diskStoreName)
                                    throws Exception

Returns object name of a DiskStoreMXBean for a given name and member

Parameters:

member - name or id of the member

diskStoreName - name of the disk store

Returns:

a ObjectName

Throws:

Exception

fetchCacheServerObjectName

ObjectName fetchCacheServerObjectName(String member,
                                      int port)
                                      throws Exception

Returns the object name for a CacheServerMXBean used to access a cache server.

Parameters:

member - Name or ID of the member.

port - Port of the server.

Throws:

Exception

listCacheServerObjectNames

ObjectName[] listCacheServerObjectNames()

Returns a list of object names for the CacheServerMXBeans used to access all cache servers.

getNumRunningFunctions

int getNumRunningFunctions()

Returns the number of map-reduce jobs currently running on all members in the distributed system.

getRegisteredCQCount

long getRegisteredCQCount()

Returns the number of CQs registers on all members.

getTotalDiskUsage

long getTotalDiskUsage()

Returns the number of megabytes used on all disks.

getUsedHeapSize

long getUsedHeapSize()

Returns the total heap used on all members.

getAverageReads

float getAverageReads()

Returns the average number of reads per second for all members.

getAverageWrites

float getAverageWrites()

Returns the average writes per second, including both put and putAll operations, for all members.

getNumSubscriptions

int getNumSubscriptions()

Returns the number of subscriptions for all members.

getTotalBytesOnDisk

long getTotalBytesOnDisk()

Returns the total number of bytes used on all disks.

getGarbageCollectionCount

long getGarbageCollectionCount()

Returns the number of garbage collection operations for all members.

viewRemoteClusterStatus

Map<String,Boolean> viewRemoteClusterStatus()

Returns a map of remote distributed system IDs and the current connection status for each.

getJVMPauses

long getJVMPauses()

Returns the number JVM pauses (which may or may not include full garbage collection pauses) detected by GemFire.