public interface MemberMXBean
DistributedMember
of the GemFire distributed system.
ObjectName of the MBean :GemFire:type=Member,member=<name-or-dist-member-id>
There will be one instance of this MBean per GemFire node.
List of notification emitted by MemberMXBean.
Notification Type | Notification Source | Message |
---|---|---|
gemfire.distributedsystem.cache.region.created | Member name or ID | Region Created with Name <Region Name> |
gemfire.distributedsystem.cache.region.closed | Member name or ID | Region Destroyed/Closed with Name <Region Name> |
gemfire.distributedsystem.cache.disk.created | Member name or ID | DiskStore Created with Name <DiskStore Name> |
gemfire.distributedsystem.cache.disk.closed | Member name or ID | DiskStore Destroyed/Closed with Name <DiskStore Name> |
gemfire.distributedsystem.cache.lockservice.created | Member name or ID | LockService Created with Name <LockService Name> |
gemfire.distributedsystem.cache.lockservice.closed | Member name or ID | Lockservice Closed with Name <LockService Name> |
gemfire.distributedsystem.gateway.sender.created | Member name or ID | GatewaySender Created in the VM |
gemfire.distributedsystem.gateway.sender.started | Member name or ID | GatewaySender Started in the VM <Sender Id> |
gemfire.distributedsystem.gateway.sender.stopped | Member name or ID | GatewaySender Stopped in the VM <Sender Id> |
gemfire.distributedsystem.gateway.sender.paused | Member name or ID | GatewaySender Paused in the VM <Sender Id> |
gemfire.distributedsystem.gateway.sender.resumed | Member name or ID | GatewaySender Resumed in the VM <Sender Id> |
gemfire.distributedsystem.async.event.queue.created | Member name or ID | Async Event Queue is Created in the VM |
gemfire.distributedsystem.gateway.receiver.created | Member name or ID | GatewayReceiver Created in the VM |
gemfire.distributedsystem.gateway.receiver.started | Member name or ID | GatewayReceiver Started in the VM |
gemfire.distributedsystem.gateway.receiver.stopped | Member name or ID | GatewayReceiver Stopped in the VM |
gemfire.distributedsystem.cache.server.started | Member name or ID | Cache Server is Started in the VM |
gemfire.distributedsystem.cache.server.stopped | Member name or ID | Cache Server is stopped in the VM |
gemfire.distributedsystem.locator.started | Member name or ID | Locator is Started in the VM |
Modifier and Type | Method and Description |
---|---|
String[] |
compactAllDiskStores()
Performs compaction on all of the member's disk stores.
|
boolean |
createManager()
Creates a Manager MBean on this member.
|
String[] |
fetchJvmThreads()
Returns the current threads.
|
float |
getAverageReads()
Returns the average number of reads per second.
|
float |
getAverageWrites()
Returns the average writes per second, including both put and putAll operations.
|
float |
getBytesReceivedRate()
Returns the average number of bytes per second received.
|
float |
getBytesSentRate()
Returns the average number of bytes per second sent.
|
long |
getCacheListenerCallsAvgLatency()
Returns the average latency of a call to a CacheListener.
|
long |
getCacheWriterCallsAvgLatency()
Returns the average latency of a call to a CacheWriter.
|
String |
getClassPath()
Returns the ClassPath.
|
float |
getCpuUsage()
Returns the time (as a percentage) that this member's process time with respect to Statistics
sample time interval.
|
float |
getCreatesRate()
Returns the number of creates per second.
|
long |
getCurrentHeapSize()
Deprecated.
Please use
getUsedMemory() instead. |
long |
getCurrentTime()
Returns the current time on the member's host.
|
long |
getDeserializationAvgLatency()
Returns the average time (in nanoseconds) spent deserializing objects.
|
long |
getDeserializationLatency()
Returns the average latency (in nanoseconds) spent deserializing objects.
|
float |
getDeserializationRate()
Returns the instantaneous rate of deserializing objects.
|
float |
getDestroysRate()
Returns the number of destroys per second.
|
long |
getDiskFlushAvgLatency()
Returns the average disk flush latency time in nanoseconds.
|
float |
getDiskReadsRate()
Returns the number of bytes reads per second from all the disks of the member.
|
String[] |
getDiskStores()
Returns a list of all disk stores, including those owned by a Region.
|
float |
getDiskWritesRate()
Returns the number of bytes written per second to disk to all the disks of the member.
|
long |
getFileDescriptorLimit()
Returns the maximum number of open file descriptors allowed for the member's host operating
system.
|
long |
getFreeHeapSize()
Deprecated.
Please use
getFreeMemory() instead. |
long |
getFreeMemory()
Returns the free heap size in megabytes.
|
float |
getFunctionExecutionRate()
Returns the average function execution rate.
|
long |
getGarbageCollectionCount()
Returns the number of times garbage collection has occurred.
|
long |
getGarbageCollectionTime()
Returns the amount of time (in milliseconds) spent on garbage collection.
|
String |
getGeodeReleaseVersion()
returns only the Geode version string
|
long |
getGetsAvgLatency()
Returns the cache get average latency.
|
float |
getGetsRate()
Returns the number of gets per second.
|
String[] |
getGroups()
Returns the names of the groups this member belongs to.
|
String |
getHost()
Returns the name or IP address of the host on which this member is running.
|
int |
getHostCpuUsage()
Returns the underlying host's current cpuActive percentage
|
String |
getId()
Returns the ID of this member.
|
int |
getInitialImageKeysReceived()
Return the number of keys received while performing a "get initial image" operation when
creating a region.
|
int |
getInitialImagesInProgres()
Deprecated.
as typo in name has been corrected: use
getInitialImagesInProgress() instead. |
int |
getInitialImagesInProgress()
Returns the number of "get initial image" operations in progress.
|
long |
getInitialImageTime()
Returns the total amount of time spent performing a "get initial image" operation when creating
a region.
|
long |
getJVMPauses()
Returns the number JVM pauses (which may or may not include full garbage collection pauses)
detected by GemFire.
|
double |
getLoadAverage()
Returns the system load average for the last minute.
|
long |
getLoadsAverageLatency()
Returns the average latency of a load.
|
long |
getLockLease()
Returns the number of second that this member will lease a distributed lock.
|
int |
getLockRequestQueues()
Returns the number of lock request queues in use by this member.
|
long |
getLockTimeout()
Returns the number of seconds that this member will wait for a distributed lock.
|
int |
getLockWaitsInProgress()
Returns the number of threads waiting for a lock.
|
float |
getLruDestroyRate()
Returns the rate of entries destroyed either by destroy cache operations or eviction.
|
float |
getLruEvictionRate()
Returns the entry eviction rate as triggered by the LRU policy.
|
long |
getMaximumHeapSize()
Deprecated.
Please use
getMaxMemory() instead. |
long |
getMaxMemory()
Returns the maximum size of the heap in megabytes.
|
String |
getMember()
Returns the name of the member if it's been set, otherwise the ID.
|
long |
getMemberUpTime()
Returns the number of seconds that this member has been running.
|
String |
getName()
Returns the name of this member.
|
long |
getNetLoadsAverageLatency()
Returns the net load average latency.
|
long |
getNetSearchAverageLatency()
Returns the net search average latency.
|
int |
getNumRunningFunctions()
Returns the number of currently executing functions.
|
int |
getNumRunningFunctionsHavingResults()
Returns the number of currently executing functions that will return results.
|
int |
getNumThreads()
Returns the number of threads in use.
|
long |
getOffHeapCompactionTime()
Returns the total time spent compacting in milliseconds.
|
int |
getOffHeapFragmentation()
Returns the percentage of off-heap memory fragmentation.
|
long |
getOffHeapFragments() |
long |
getOffHeapFreedChunks() |
long |
getOffHeapFreeMemory()
Returns the size of available (or unallocated) off-heap memory in bytes.
|
int |
getOffHeapLargestFragment() |
long |
getOffHeapMaxMemory()
Returns the size of the maximum configured off-heap memory in bytes.
|
int |
getOffHeapObjects()
Returns the number of off heap objects.
|
long |
getOffHeapUsedMemory()
Returns the size of utilized off-heap memory in bytes.
|
int |
getPartitionRegionCount()
Returns the number of Partition Regions present in the Cache.
|
long |
getPDXDeserializationAvgLatency()
Returns the average time, in seconds, spent deserializing PDX instanced.
|
float |
getPDXDeserializationRate()
Returns the instantaneous rate of PDX instance deserialization.
|
int |
getProcessId()
Returns the operating system process ID.
|
long |
getPutAllAvgLatency()
Returns the cache putAll average latency.
|
float |
getPutAllRate()
Returns the number of putAlls per second.
|
long |
getPutsAvgLatency()
Returns the cache put average latency.
|
float |
getPutsRate()
Returns the number of puts per second.
|
int |
getRebalancesInProgress()
Returns current number of cache rebalance operations being directed by this process.
|
String |
getRedundancyZone()
Returns the redundancy-zone of the member.
|
String |
getReleaseVersion()
returns only the version string
|
int |
getReplyWaitsCompleted()
Returns total number of times waits for a reply have completed.
|
int |
getReplyWaitsInProgress()
Returns current number of threads waiting for a reply.
|
String[] |
getRootRegionNames()
Returns a list of all root Region names.
|
long |
getSerializationAvgLatency()
Returns the average time (in nanoseconds) spent serializing objects.
|
long |
getSerializationLatency()
Returns the average latency (in nanoseconds) spent serializing objects.
|
float |
getSerializationRate()
Returns the instantaneous rate of serializing objects.
|
int |
getTotalBackupCompleted()
Returns the number of backups that have been completed.
|
int |
getTotalBackupInProgress()
Returns the number of backups currently in progress for all disk stores.
|
int |
getTotalBucketCount()
Returns the total number of buckets.
|
int |
getTotalDiskTasksWaiting()
Returns the current number of disk tasks (op-log compaction, asynchronous recovery, etc.) that
are waiting for a thread to run.
|
long |
getTotalDiskUsage()
Returns the total number of bytes used on all disks.
|
long |
getTotalFileDescriptorOpen()
Returns the current number of open file descriptors.
|
int |
getTotalHitCount()
Returns the number of times that a hit occurred for all regions.
|
int |
getTotalLoadsCompleted()
Returns the total number of times that a load on this cache has completed, as a result of
either a local get or a remote net load.
|
long |
getTotalLockWaitTime()
Returns the amount of time (in milliseconds) spent waiting for a lock.
|
int |
getTotalMissCount()
Returns the number of times that a cache miss occurred for all regions.
|
int |
getTotalNetLoadsCompleted()
Returns the total number of times that a network load initiated by this cache has completed.
|
int |
getTotalNetSearchCompleted()
Returns the total number of times that a network search initiated by this cache has completed.
|
int |
getTotalNumberOfGrantors()
Returns the number of locks for which this member is a granter.
|
int |
getTotalNumberOfLockService()
Returns the number of lock services in use.
|
int |
getTotalPrimaryBucketCount()
Returns the number of buckets for which this member is the primary holder.
|
int |
getTotalRegionCount()
Returns the number of Regions present in the Cache.
|
int |
getTotalRegionEntryCount()
Returns the total number of entries in all regions.
|
int |
getTotalTransactionsCount()
Returns the number of current transactions.
|
long |
getTransactionCommitsAvgLatency()
Returns the average commit latency in nanoseconds.
|
float |
getTransactionCommitsRate()
Returns the average number of transactions committed per second.
|
int |
getTransactionCommittedTotalCount()
Returns the number of committed transactions.
|
int |
getTransactionRolledBackTotalCount()
Returns the number of transactions that were rolled back.
|
long |
getUsedMemory()
Returns the current size of the heap in megabytes.
|
String |
getVersion()
Returns the GemFire version, including build id, jdk version, product name and release version
etc.
|
int |
getVisibleNodes()
The current number of nodes in this distributed system visible to this member.
|
boolean |
hasGatewayReceiver()
Returns whether this member has at least one GatewayReceiver.
|
boolean |
hasGatewaySender()
Returns whether this member has at least one GatewaySender.
|
boolean |
isCacheServer()
Returns true if a cache server is running on this member and able to serve requests from
clients
|
boolean |
isLocator()
Returns whether this member is attached to at least one Locator.
|
boolean |
isManager()
Returns whether this member is running the Manager service.
|
boolean |
isManagerCreated()
Returns whether this member has created the Manager service (it may be created, but not
running).
|
boolean |
isServer()
Any long-running GemFire process that was started with "start server" command from GFSH.
|
String[] |
listConnectedGatewayReceivers()
Returns a list of IDs for all connected gateway receivers.
|
String[] |
listConnectedGatewaySenders()
Returns a list of IDs for all gateway senders.
|
String[] |
listDiskStores(boolean includeRegionOwned)
Returns the name of all disk stores in use by this member.
|
GemFireProperties |
listGemFireProperties()
Returns the GemFire specific properties for this member.
|
String[] |
listRegions()
Returns a list of all Region names.
|
String |
processCommand(String commandString)
Executes a command on the member.
|
String |
processCommand(String commandString,
Map<String,String> env)
Executes a command on the member.
|
String |
processCommand(String commandString,
Map<String,String> env,
Byte[][] binaryData)
Deprecated.
since 1.4 use processCommand(String commandString, Map$lt;String, String$gt; env,
List$lt;String$gt; stagedFilePaths) instead
|
String |
processCommand(String commandString,
Map<String,String> env,
List<String> stagedFilePaths)
Executes a command on the member.
|
JVMMetrics |
showJVMMetrics()
Returns JVM metrics.
|
String |
showLog(int numberOfLines)
Returns the most recent log entries for the member.
|
OSMetrics |
showOSMetrics()
Returns operating system metrics.
|
void |
shutDownMember()
Shuts down the member.
|
String |
status()
Returns the status.
|
String |
viewLicense()
Deprecated.
Removed licensing in 8.0.
|
String showLog(int numberOfLines)
numberOfLines
- Number of lines to return, up to a maximum of 100.@Deprecated String viewLicense()
String[] compactAllDiskStores()
boolean createManager()
void shutDownMember()
JVMMetrics showJVMMetrics()
OSMetrics showOSMetrics()
String processCommand(String commandString)
commandString
- Command to be executed.String processCommand(String commandString, Map<String,String> env)
commandString
- Command to be execute.env
- Environmental properties to use during command execution.String processCommand(String commandString, Map<String,String> env, List<String> stagedFilePaths)
commandString
- Command to be execute.env
- Environmental properties to use during command execution.stagedFilePaths
- Local files (as relevant to the command). May be null.@Deprecated String processCommand(String commandString, Map<String,String> env, Byte[][] binaryData)
commandString
- Command to be execute.env
- Environmental properties to use during command execution.binaryData
- Binary data specific to the command being executed.String[] listDiskStores(boolean includeRegionOwned)
includeRegionOwned
- Whether to include disk stores owned by a region.GemFireProperties listGemFireProperties()
String getHost()
String getName()
String getId()
String getMember()
String[] getGroups()
int getProcessId()
String status()
String getVersion()
String getReleaseVersion()
String getGeodeReleaseVersion()
boolean isLocator()
long getLockTimeout()
long getLockLease()
boolean isServer()
boolean hasGatewaySender()
boolean isManager()
boolean isManagerCreated()
boolean hasGatewayReceiver()
String getClassPath()
long getCurrentTime()
long getMemberUpTime()
float getCpuUsage()
@Deprecated long getCurrentHeapSize()
getUsedMemory()
instead.@Deprecated long getMaximumHeapSize()
getMaxMemory()
instead.@Deprecated long getFreeHeapSize()
getFreeMemory()
instead.long getMaxMemory()
long getFreeMemory()
long getUsedMemory()
String[] fetchJvmThreads()
long getFileDescriptorLimit()
long getTotalFileDescriptorOpen()
int getTotalRegionCount()
int getPartitionRegionCount()
String[] listRegions()
String[] getDiskStores()
String[] getRootRegionNames()
int getTotalRegionEntryCount()
int getTotalBucketCount()
int getTotalPrimaryBucketCount()
long getGetsAvgLatency()
long getPutsAvgLatency()
long getPutAllAvgLatency()
int getTotalMissCount()
int getTotalHitCount()
float getGetsRate()
float getPutsRate()
float getPutAllRate()
float getCreatesRate()
float getDestroysRate()
long getCacheWriterCallsAvgLatency()
long getCacheListenerCallsAvgLatency()
int getTotalLoadsCompleted()
long getLoadsAverageLatency()
int getTotalNetLoadsCompleted()
long getNetLoadsAverageLatency()
int getTotalNetSearchCompleted()
long getNetSearchAverageLatency()
int getTotalDiskTasksWaiting()
float getBytesSentRate()
float getBytesReceivedRate()
String[] listConnectedGatewayReceivers()
String[] listConnectedGatewaySenders()
int getNumRunningFunctions()
float getFunctionExecutionRate()
int getNumRunningFunctionsHavingResults()
int getTotalTransactionsCount()
long getTransactionCommitsAvgLatency()
int getTransactionCommittedTotalCount()
int getTransactionRolledBackTotalCount()
float getTransactionCommitsRate()
float getDiskReadsRate()
float getDiskWritesRate()
long getDiskFlushAvgLatency()
int getTotalBackupInProgress()
int getTotalBackupCompleted()
int getLockWaitsInProgress()
long getTotalLockWaitTime()
int getTotalNumberOfLockService()
int getTotalNumberOfGrantors()
int getLockRequestQueues()
float getLruEvictionRate()
float getLruDestroyRate()
@Deprecated int getInitialImagesInProgres()
getInitialImagesInProgress()
instead.int getInitialImagesInProgress()
long getInitialImageTime()
int getInitialImageKeysReceived()
long getDeserializationAvgLatency()
long getDeserializationLatency()
float getDeserializationRate()
long getSerializationAvgLatency()
long getSerializationLatency()
float getSerializationRate()
float getPDXDeserializationRate()
long getPDXDeserializationAvgLatency()
long getTotalDiskUsage()
int getNumThreads()
double getLoadAverage()
long getGarbageCollectionCount()
long getGarbageCollectionTime()
float getAverageReads()
float getAverageWrites()
long getJVMPauses()
int getHostCpuUsage()
boolean isCacheServer()
String getRedundancyZone()
int getRebalancesInProgress()
int getReplyWaitsInProgress()
int getReplyWaitsCompleted()
int getVisibleNodes()
int getOffHeapObjects()
long getOffHeapMaxMemory()
long getOffHeapFreeMemory()
long getOffHeapUsedMemory()
int getOffHeapFragmentation()
long getOffHeapFragments()
long getOffHeapFreedChunks()
int getOffHeapLargestFragment()
long getOffHeapCompactionTime()