GemFire 7.0.1

com.gemstone.gemfire.management
Interface MemberMXBean


public interface MemberMXBean

MBean that provides access to information and management functionality for a DistributedMember of the GemFire distributed system.

Since:
7.0

Method Summary
 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 CPUs have been in use.
 float getCreatesRate()
          Returns the number of creates per second.
 long getCurrentHeapSize()
          Returns the current size of the heap in megabytes.
 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
 float getDiskReadsRate()
          Returns the average number of disk reads per second.
 String[] getDiskStores()
          Returns a list of all disk stores, including those owned by a Region.
 float getDiskWritesRate()
          Returns the average number of disk writes per second.
 long getFileDescriptorLimit()
          Returns the maximum number of open file descriptors allowed for the member's host operating system.
 long getFreeHeapSize()
          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 occured.
 long getGarbageCollectionTime()
          Returns the amount of time (in milliseconds) spent on garbage collection.
 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.
 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()
          Returns the number of initial images 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()
          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 resutls.
 int getNumThreads()
          Returns the number of threads in use.
 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.
 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 the 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.
 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.
 String getVersion()
          Returns the GemFire version.
 boolean hasGatewayReceiver()
          Returns whether this member has at least one GatewayReceiver.
 boolean hasGatewaySender()
          Returns whether this member has at least one GatewaySender.
 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()
          Returns whether this member is a CacheServer.
 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)
          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()
          Returns the license string for this member.
 

Method Detail

showLog

String showLog(int numberOfLines)
Returns the most recent log entries for the member.

Parameters:
numberOfLines - Number of lines to return, up to a maximum of 100.

viewLicense

String viewLicense()
Returns the license string for this member.


compactAllDiskStores

String[] compactAllDiskStores()
Performs compaction on all of the member's disk stores.

Returns:
A list of names of the disk stores that were compacted.

createManager

boolean createManager()
Creates a Manager MBean on this member.

Returns:
True if the Manager MBean was successfully create, false otherwise.

shutDownMember

void shutDownMember()
Shuts down the member. This is an asynchronous call and it will return immediately without waiting for a result.


showJVMMetrics

JVMMetrics showJVMMetrics()
Returns JVM metrics.


showOSMetrics

OSMetrics showOSMetrics()
Returns operating system metrics.


processCommand

String processCommand(String commandString)
Executes a command on the member.

Parameters:
commandString - Command to be executed.
Returns:
Result of the execution in JSON format.

processCommand

String processCommand(String commandString,
                      Map<String,String> env)
Executes a command on the member.

Parameters:
commandString - Command to be execute.
env - Environmental properties to use during command execution.
Returns:
Result of the execution in JSON format.

processCommand

String processCommand(String commandString,
                      Map<String,String> env,
                      Byte[][] binaryData)
Executes a command on the member.

Parameters:
commandString - Command to be execute.
env - Environmental properties to use during command execution.
binaryData - Binary data specific to the command being executed.
Returns:
Result of the execution in JSON format.

listDiskStores

String[] listDiskStores(boolean includeRegionOwned)
Returns the name of all disk stores in use by this member.

Parameters:
includeRegionOwned - Whether to include disk stores owned by a region.

listGemFireProperties

GemFireProperties listGemFireProperties()
Returns the GemFire specific properties for this member.


getHost

String getHost()
Returns the name or IP address of the host on which this member is running.


getName

String getName()
Returns the name of this member.


getId

String getId()
Returns the ID of this member.


getMember

String getMember()
Returns the name of the member if it's been set, otherwise the ID.


getGroups

String[] getGroups()
Returns the names of the groups this member belongs to.


getProcessId

int getProcessId()
Returns the operating system process ID.


status

String status()
Returns the status.


getVersion

String getVersion()
Returns the GemFire version.


isLocator

boolean isLocator()
Returns whether this member is attached to at least one Locator.

Returns:
True if this member is attached to a Locator, false otherwise.

getLockTimeout

long getLockTimeout()
Returns the number of seconds that this member will wait for a distributed lock.


getLockLease

long getLockLease()
Returns the number of second that this member will lease a distributed lock.


isServer

boolean isServer()
Returns whether this member is a CacheServer.

Returns:
True if this member is a CacheServer, false otherwise.

hasGatewaySender

boolean hasGatewaySender()
Returns whether this member has at least one GatewaySender.

Returns:
True if this member has at least one GatwaySender, false otherwise.

isManager

boolean isManager()
Returns whether this member is running the Manager service.

Returns:
True if this member is running the Manager service, false otherwise.

isManagerCreated

boolean isManagerCreated()
Returns whether this member has created the Manager service (it may be created, but not running).

Returns:
True if this member has created the Manager service, false otherwise.

hasGatewayReceiver

boolean hasGatewayReceiver()
Returns whether this member has at least one GatewayReceiver.

Returns:
True if this member has at least one GatwayReceiver, false otherwise.

getClassPath

String getClassPath()
Returns the ClassPath.


getCurrentTime

long getCurrentTime()
Returns the current time on the member's host.


getMemberUpTime

long getMemberUpTime()
Returns the number of seconds that this member has been running.


getCpuUsage

float getCpuUsage()
Returns the time (as a percentage) that this member's CPUs have been in use.


getCurrentHeapSize

long getCurrentHeapSize()
Returns the current size of the heap in megabytes.


getMaximumHeapSize

long getMaximumHeapSize()
Returns the maximum size of the heap in megabytes.


getFreeHeapSize

long getFreeHeapSize()
Returns the free heap size in megabytes.


fetchJvmThreads

String[] fetchJvmThreads()
Returns the current threads.


getFileDescriptorLimit

long getFileDescriptorLimit()
Returns the maximum number of open file descriptors allowed for the member's host operating system.


getTotalFileDescriptorOpen

long getTotalFileDescriptorOpen()
Returns the current number of open file descriptors.


getTotalRegionCount

int getTotalRegionCount()
Returns the number of Regions present in the Cache.


getPartitionRegionCount

int getPartitionRegionCount()
Returns the number of Partition Regions present in the Cache.


listRegions

String[] listRegions()
Returns a list of all Region names.


getDiskStores

String[] getDiskStores()
Returns a list of all disk stores, including those owned by a Region.


getRootRegionNames

String[] getRootRegionNames()
Returns a list of all root Region names.


getTotalRegionEntryCount

int getTotalRegionEntryCount()
Returns the total number of entries in all regions.


getTotalBucketCount

int getTotalBucketCount()
Returns the total number of buckets.


getTotalPrimaryBucketCount

int getTotalPrimaryBucketCount()
Returns the number of buckets for which this member is the primary holder.


getGetsAvgLatency

long getGetsAvgLatency()
Returns the cache get average latency.


getPutsAvgLatency

long getPutsAvgLatency()
Returns the cache put average latency.


getPutAllAvgLatency

long getPutAllAvgLatency()
Returns the cache putAll average latency.


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.


getGetsRate

float getGetsRate()
Returns the number of gets per second.


getPutsRate

float getPutsRate()
Returns the number of puts per second. Only includes puts done explicitly on this member's cache, not those pushed from another member.


getPutAllRate

float getPutAllRate()
Returns the number of putAlls per second.


getCreatesRate

float getCreatesRate()
Returns the number of creates per second.


getDestroysRate

float getDestroysRate()
Returns the number of destroys per second.


getCacheWriterCallsAvgLatency

long getCacheWriterCallsAvgLatency()
Returns the average latency of a call to a CacheWriter.


getCacheListenerCallsAvgLatency

long getCacheListenerCallsAvgLatency()
Returns the average latency of a call to a CacheListener.


getTotalLoadsCompleted

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.


getLoadsAverageLatency

long getLoadsAverageLatency()
Returns the average latency of a load.


getTotalNetLoadsCompleted

int getTotalNetLoadsCompleted()
Returns the total number of times the a network load initiated by this cache has completed.


getNetLoadsAverageLatency

long getNetLoadsAverageLatency()
Returns the net load average latency.


getTotalNetSearchCompleted

int getTotalNetSearchCompleted()
Returns the total number of times that a network search initiated by this cache has completed.


getNetSearchAverageLatency

long getNetSearchAverageLatency()
Returns the net search average latency.


getTotalDiskTasksWaiting

int getTotalDiskTasksWaiting()
Returns the current number of disk tasks (op-log compaction, asynchronous recovery, etc.) that are waiting for a thread to run.


getBytesSentRate

float getBytesSentRate()
Returns the average number of bytes per second sent.


getBytesReceivedRate

float getBytesReceivedRate()
Returns the average number of bytes per second received.


listConnectedGatewayReceivers

String[] listConnectedGatewayReceivers()
Returns a list of IDs for all connected gateway receivers.


listConnectedGatewaySenders

String[] listConnectedGatewaySenders()
Returns a list of IDs for all gateway senders.


getNumRunningFunctions

int getNumRunningFunctions()
Returns the number of currently executing functions.


getFunctionExecutionRate

float getFunctionExecutionRate()
Returns the average function execution rate.


getNumRunningFunctionsHavingResults

int getNumRunningFunctionsHavingResults()
Returns the number of currently executing functions that will return resutls.


getTotalTransactionsCount

int getTotalTransactionsCount()
Returns the number of current transactions.


getTransactionCommitsAvgLatency

long getTransactionCommitsAvgLatency()
Returns the average commit latency.


getTransactionCommittedTotalCount

int getTransactionCommittedTotalCount()
Returns the number of committed transactions.


getTransactionRolledBackTotalCount

int getTransactionRolledBackTotalCount()
Returns the number of transactions that were rolled back.


getTransactionCommitsRate

float getTransactionCommitsRate()
Returns the average number of transactions committed per second.


getDiskReadsRate

float getDiskReadsRate()
Returns the average number of disk reads per second.


getDiskWritesRate

float getDiskWritesRate()
Returns the average number of disk writes per second.


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.


getTotalBackupCompleted

int getTotalBackupCompleted()
Returns the number of backups that have been completed.


getLockWaitsInProgress

int getLockWaitsInProgress()
Returns the number of threads waiting for a lock.


getTotalLockWaitTime

long getTotalLockWaitTime()
Returns the amount of time (in milliseconds) spent waiting for a lock.


getTotalNumberOfLockService

int getTotalNumberOfLockService()
Returns the number of lock services in use.


getTotalNumberOfGrantors

int getTotalNumberOfGrantors()
Returns the number of locks for which this member is a granter.


getLockRequestQueues

int getLockRequestQueues()
Returns the number of lock request queues in use by this member.


getLruEvictionRate

float getLruEvictionRate()
Returns the entry eviction rate as triggered by the LRU policy.


getLruDestroyRate

float getLruDestroyRate()
Returns the rate of entries destroyed either by destroy cache operations or eviction.


getInitialImagesInProgres

int getInitialImagesInProgres()
Returns the number of initial images in progress.


getInitialImageTime

long getInitialImageTime()
Returns the total amount of time spent performing a "get initial image" operation when creating a region.


getInitialImageKeysReceived

int getInitialImageKeysReceived()
Return the number of keys received while performing a "get initial image" operation when creating a region.


getDeserializationAvgLatency

long getDeserializationAvgLatency()
Returns the average time (in nanoseconds) spent deserializing objects. Includes deserializations that result in a PdxInstance.


getDeserializationLatency

long getDeserializationLatency()
Returns the average latency (in nanoseconds) spent deserializing objects. Includes deserializations that result in a PdxInstance.


getDeserializationRate

float getDeserializationRate()
Returns the instantaneous rate of deserializing objects. Includes deserializations that result in a PdxInstance.


getSerializationAvgLatency

long getSerializationAvgLatency()
Returns the average time (in nanoseconds) spent serializing objects. Includes serializations that result in a PdxInstance.


getSerializationLatency

long getSerializationLatency()
Returns the average latency (in nanoseconds) spent serializing objects. Includes serializations that result in a PdxInstance.


getSerializationRate

float getSerializationRate()
Returns the instantaneous rate of serializing objects. Includes serializations that result in a PdxInstance.


getPDXDeserializationRate

float getPDXDeserializationRate()
Returns the instantaneous rate of PDX instance deserialization.


getPDXDeserializationAvgLatency

long getPDXDeserializationAvgLatency()
Returns the average time, in seconds, spent deserializing PDX instanced.


getTotalDiskUsage

long getTotalDiskUsage()
Returns the total number of bytes used on all disks.


getNumThreads

int getNumThreads()
Returns the number of threads in use.


getLoadAverage

double getLoadAverage()
Returns the system load average for the last minute. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. Pulse Attribute

Returns:
The load average or a negative value if one is not available.

getGarbageCollectionCount

long getGarbageCollectionCount()
Returns the number of times garbage collection has occured.


getGarbageCollectionTime

long getGarbageCollectionTime()
Returns the amount of time (in milliseconds) spent on garbage collection.


getAverageReads

float getAverageReads()
Returns the average number of reads per second.


getAverageWrites

float getAverageWrites()
Returns the average writes per second, including both put and putAll operations.


getJVMPauses

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


GemFire 7.0.1

Copyright © 1997-2013 VMware, Inc. All rights reserved.