public interface DistributedSystemMXBean
DistributedSystem
.
It also provides an API for navigating the other MBeans exposed by the GemFire distributed
system.
There will be one DistributedSystemMBean per GemFire cluster.
ObjectName : GemFire:service=System,type=Distributed
List of notifications emitted by this MBean.
Notification Type | Notification Source | Message |
---|---|---|
gemfire.distributedsystem.cache.member.joined | Name or ID of member who joined | Member Joined <Member Name or ID> |
gemfire.distributedsystem.cache.member.departed | Name or ID of member who departed | Member Departed <Member Name or ID> has crashed = <true/false> |
gemfire.distributedsystem.cache.member.suspect | Name or ID of member who is suspected | Member Suspected <Member Name or ID> By <Who Suspected> |
system.alert | DistributedSystem("<DistributedSystem ID">) | Alert Message |
Modifier and Type | Method and Description |
---|---|
DiskBackupStatus |
backupAllMembers(String targetDirPath,
String baselineDirPath)
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
RegionMXBean s 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 the 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.
|
int |
getQueryCollectionsDepth()
Number of elements in a collection to be shown in queryData operation if query results contain
collections like Map, List etc.
|
float |
getQueryRequestRate()
Returns the average number of queries per second across all distributed members.
|
int |
getQueryResultSetLimit()
Number of rows DistributedSystemMXBean.queryData() operation will return.
|
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 |
getTotalDiskUsage()
Returns the number of bytes 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
Region s. |
long |
getTotalRegionEntryCount()
Returns the total number of entries in all regions.
|
int |
getTransactionCommitted()
Returns the number of committed transactions across all members.
|
int |
getTransactionRolledBack()
Returns the number of transactions that were rolled back across all members.
|
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
CacheServerMXBean s used to access all cache
servers. |
String[] |
listCacheServers()
Returns a list of names for all cache servers which are able to serve requests from GemFire
clients.
|
ObjectName[] |
listDistributedRegionObjectNames()
Returns a list of object names for the
DistributedRegionMXBean s used to access all
distributed regions. |
ObjectName[] |
listGatewayReceiverObjectNames()
Returns a list of object names for the
GatewayReceiverMXBean s 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
GatewaySenderMXBean s used to access all gateway
senders. |
ObjectName[] |
listGatewaySenderObjectNames(String member)
Returns a list of object names for the
GatewaySenderMXBean s used to access all gateway
senders on a member. |
String[] |
listGatewaySenders()
Returns a list of IDs for all gateway senders.
|
String[] |
listGroups()
Returns a list of names for all groups.
|
String[] |
listLocatorMembers(boolean onlyStandAloneLocators)
Returns a list of names for locator members.
|
String[] |
listLocators()
Returns a list of IDs for all locators.
|
Map<String,String[]> |
listMemberDiskstore()
Returns a map of all
DistributedMember s and their DiskStore s. |
ObjectName[] |
listMemberObjectNames()
Returns a list of object names for the
MemberMXBean s 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.
|
String[] |
listServers()
Returns a list of names for all servers where server means any long-running GemFire process
that was started with "start server" command from GFSH.
|
String |
queryData(String queryString,
String members,
int limit)
This API is used to query data from GemFire system.
|
byte[] |
queryDataForCompressedResult(String queryString,
String members,
int limit)
Functionality is same as queryData() method.
|
boolean |
revokeMissingDiskStores(String diskStoreId)
Removes a disk store from the distributed system.
|
void |
setQueryCollectionsDepth(int queryCollectionsDepth) |
void |
setQueryResultSetLimit(int queryResultSetLimit) |
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.
|
int getDistributedSystemId()
int getMemberCount()
String[] listMembers()
String[] listLocatorMembers(boolean onlyStandAloneLocators)
onlyStandAloneLocators
- if set to true
, includes only stand alone locator
members.String[] listGroups()
int getLocatorCount()
String[] listLocators()
int getSystemDiskStoreCount()
Map<String,String[]> listMemberDiskstore()
DistributedMember
s and their DiskStore
s.DistributedMember
s and their DiskStore
sString[] listGatewaySenders()
String[] listGatewayReceivers()
String getAlertLevel()
void changeAlertLevel(String alertLevel) throws Exception
alertLevel
- Minimum level for alerts to be delivered. Must be one of: WARNING, ERROR,
SEVERE or NONE.Exception
- if the alertLevel is invalidlong getTotalHeapSize()
long getTotalRegionEntryCount()
int getTotalRegionCount()
Region
s.Region
sint getTotalMissCount()
int getTotalHitCount()
int getNumClients()
float getDiskReadsRate()
float getDiskWritesRate()
long getDiskFlushAvgLatency()
int getTotalBackupInProgress()
int getNumInitialImagesInProgress()
long getActiveCQCount()
float getQueryRequestRate()
DiskBackupStatus backupAllMembers(String targetDirPath, String baselineDirPath) throws Exception
targetDirPath
- Directory to which backup files will be writtenbaselineDirPath
- path of the directory for baseline backup.Exception
- is an exception is encountered while backing up membersGemFireProperties fetchMemberConfiguration(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.long fetchMemberUpTime(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.String[] listCacheServers()
String[] listServers()
JVMMetrics showJVMMetrics(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.OSMetrics showOSMetrics(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.NetworkMetrics showNetworkMetric(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.DiskMetrics showDiskMetrics(String member) throws Exception
member
- Name or ID of the member.Exception
- for an invalid member ID.String[] shutDownAllMembers() throws Exception
Exception
- if an exception is encountered when shutting down the membersString[] listRegions()
String[] listAllRegionPaths()
boolean revokeMissingDiskStores(String diskStoreId)
diskStoreId
- UUID of the disk store to removePersistentMemberDetails[] listMissingDiskStores()
ObjectName getMemberObjectName()
MemberMXBean
used to access this distributed member.
allow anyone to access this methodMemberMXBean
used to access this distributed memberObjectName getManagerObjectName()
ManagerMXBean
used to access the management service
running on this distributed member.ManagerMXBean
used to access the management service
running on this distributed memberObjectName[] listMemberObjectNames()
MemberMXBean
s used to access all distributed
members.MemberMXBean
s used to access all distributed
membersObjectName fetchMemberObjectName(String member) throws Exception
MemberMXBean
used to access a distributed member.member
- Name or ID of the member.MemberMXBean
used to access a distributed memberException
- if the member cannot be foundObjectName[] fetchRegionObjectNames(ObjectName memberMBeanName) throws Exception
RegionMXBean
s used to access all regions on a
distributed member.memberMBeanName
- ObjectName of the member.Exception
- if the member cannot be foundObjectName[] listDistributedRegionObjectNames()
DistributedRegionMXBean
s used to access all
distributed regions.ObjectName fetchDistributedRegionObjectName(String regionPath) throws Exception
DistributedRegionMXBean
used to access a distributed
region.regionPath
- Full path of the region.DistributedRegionMXBean
used to access a distributed
regionException
- if the member cannot be foundObjectName fetchRegionObjectName(String member, String regionPath) throws Exception
RegionMXBean
used to access a region.member
- Name or ID of the member.regionPath
- Full path of the region.GatewayReceiverMXBean
used to access a regionException
- if the member name is invalid or the member cannot be foundObjectName fetchGatewaySenderObjectName(String member, String senderId) throws Exception
GatewaySenderMXBean
used to access a gateway sender.member
- Name or ID of the member.senderId
- ID of a gateway sender.GatewayReceiverMXBean
used to access a gateway senderException
- if the member name is invalid or the member cannot be foundObjectName fetchGatewayReceiverObjectName(String member) throws Exception
GatewayReceiverMXBean
used to access a gateway receiver.member
- Name or ID of the member.GatewayReceiverMXBean
used to access a gateway receiverException
- if the member name is invalid or the member cannot be foundObjectName[] listGatewaySenderObjectNames()
GatewaySenderMXBean
s used to access all gateway
senders.ObjectName[] listGatewaySenderObjectNames(String member) throws Exception
GatewaySenderMXBean
s used to access all gateway
senders on a member.member
- Name or ID of the member.Exception
- if the member name is invalid or the member cannot be foundObjectName[] listGatewayReceiverObjectNames()
GatewayReceiverMXBean
s used to access all
gateway senders.ObjectName fetchDistributedLockServiceObjectName(String lockServiceName) throws Exception
DistributedLockServiceMXBean
used to access a distributed
lock service.lockServiceName
- Name of the lock service.DistributedLockServiceMXBean
used to access a distributed
lock serviceException
- if the member name is invalid or the member cannot be foundObjectName fetchLockServiceObjectName(String member, String lockService) throws Exception
LockServiceMXBean
used to access a lock service.member
- Name or Id of the member.lockService
- Name of the lock service.LockServiceMXBean
used to access a lock serviceException
- if the member name is invalid or the member cannot be foundObjectName fetchDiskStoreObjectName(String member, String diskStoreName) throws Exception
DiskStoreMXBean
for a given name and membermember
- name or id of the memberdiskStoreName
- name of the disk storeException
- if the member name is invalid or the member cannot be foundObjectName fetchCacheServerObjectName(String member, int port) throws Exception
CacheServerMXBean
used to access a cache server.member
- Name or ID of the member.port
- Port of the server.CacheServerMXBean
used to access a cache serverException
- if the member name is invalid or the member cannot be foundObjectName[] listCacheServerObjectNames()
CacheServerMXBean
s used to access all cache
servers.CacheServerMXBean
s used to access all cache
serversint getNumRunningFunctions()
long getRegisteredCQCount()
long getTotalDiskUsage()
long getUsedHeapSize()
float getAverageReads()
float getAverageWrites()
int getNumSubscriptions()
long getGarbageCollectionCount()
Map<String,Boolean> viewRemoteClusterStatus()
long getJVMPauses()
String queryData(String queryString, String members, int limit) throws Exception
queryString
- GemFire supported OQL querymembers
- comma separated list of members on which the query is to be executed. It is not
mandatory to give this input barring join queries on PR. If member list is not provided
query will be for the whole cluster.limit
- result set limit. If not set or 0 is passed default limit of 1000 will be set.Exception
- if an exception is encountered while executing the querybyte[] queryDataForCompressedResult(String queryString, String members, int limit) throws Exception
queryString
- GemFire supported OQL querymembers
- comma separated list of members on which the query is to be executed. It is not
mandatory to give this input barring join queries on PR. If member list is not provided
query will be for the whole cluster.limit
- result set limit. If not set or 0 is passed default limit of 1000 will be set.Exception
- if an exception is encountered while executing the queryint getTransactionCommitted()
int getTransactionRolledBack()
int getQueryResultSetLimit()
void setQueryResultSetLimit(int queryResultSetLimit)
int getQueryCollectionsDepth()
void setQueryCollectionsDepth(int queryCollectionsDepth)