com.gemstone.gemfire.management
Interface DistributedRegionMXBean

public interface DistributedRegionMXBean

MBean that provides access to information and management functionality for a Region.

Since:

7.0

Method Summary

float	getAverageReads() Returns the average number of read requests per second.
float	getAverageWrites() Returns the average number of write requests per second.
int	getAvgBucketSize() Returns the average number of entries in bucket.
int	getBucketCount() Returns the number of buckets on this member.
long	getCacheListenerCallsAvgLatency() Returns the average latency of a call to a CacheListener.
long	getCacheWriterCallsAvgLatency() Returns the average latency of a call to a CacheWriter.
float	getCreatesRate() Returns the number of creates per second.
float	getDestroyRate() Returns the number of destroys per second.
float	getDiskReadsRate() Returns the number of reads per second for all disks.
long	getDiskTaskWaiting() Returns the current number of disk tasks (op-log compaction, asynchronous recoveries, etc) that are waiting for a thread to run.
long	getDiskUsage() Returns the total number of megabytes used by all disks.
float	getDiskWritesRate() Returns the number of writes per second for all disks.
int	getEmptyNodes() Returns the number of members whose entry count is 0.
long	getEntrySize() Returns the aggregate entry size (in megabytes) of all entries.
String	getFullPath() Returns the full path of the Region.
float	getGetsRate() Returns the number of gets per second.
long	getHitCount() Returns the number of times that a hit occurred.
float	getHitRatio() Returns the hit to miss ratio.
long	getLastAccessedTime() Returns the time of the most recent access.
long	getLastModifiedTime() Returns the time of the most recent modification.
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.
int	getMaxBucketSize() Returns the maximum number of entries in a bucket.
int	getMemberCount() Returns the number of members hosting/using the Region.
String[]	getMembers() Returns a list of names of the members hosting the Region.
int	getMinBucketSize() Returns the minimum number of entries in a bucket.
long	getMissCount() Returns the number of times that a cache miss occurred.
String	getName() Returns the name of the Region.
int	getNumBucketsWithoutRedundancy() Returns the number of buckets without full redundancy.
String	getParentRegion() Returns the name of the parent Region.
int	getPrimaryBucketCount() Returns the number of primary buckets on this member.
float	getPutAllRate() Returns the number of putAlls per second.
float	getPutLocalRate() Returns the local number of puts per second.
long	getPutRemoteAvgLatency() Return the average latency for remote puts.
long	getPutRemoteLatency() Returns the latency for the most recent remote put.
float	getPutRemoteRate() Returns the remote number of puts per second.
float	getPutsRate() Returns the number of puts per second.
String	getRegionType() Returns the type of the Region.
long	getSystemRegionEntryCount() Returns the number of entries in the Region.
int	getTotalBucketSize() Returns the total number of entries in all buckets.
long	getTotalBytesOnDisk() Returns the total number of bytes stored on all disks.
long	getTotalDiskEntriesInVM() Returns the current number of entries held in memory.
long	getTotalDiskWritesProgress() Returns the current number of disk writes in progress.
long	getTotalEntriesOnlyOnDisk() Returns the current number of entries whose values are only on disk (not in memory).
boolean	isGatewayEnabled() Returns whether the Region sends data to a GatewaySender.
boolean	isPersistentEnabled() Returns whether persistence is enabled
EvictionAttributesData	listEvictionAttributes() Returns the eviction attributes of the Region.
FixedPartitionAttributesData[]	listFixedPartitionAttributesData() Returns the fixed partition attributes of the Region.
MembershipAttributesData	listMembershipAttributes() Returns the membership attributes of the Region.
PartitionAttributesData	listPartitionAttributes() Returns the partition attributes of the Region.
RegionAttributesData	listRegionAttributes() Returns the attributes of the Region.
String[]	listSubRegionPaths(boolean recursive) Returns a list of the names of the sub-regions.

Method Detail

getName

String getName()

Returns the name of the Region.

getMemberCount

int getMemberCount()

Returns the number of members hosting/using the Region.

getMembers

String[] getMembers()

Returns a list of names of the members hosting the Region.

getRegionType

String getRegionType()

Returns the type of the Region.

getFullPath

String getFullPath()

Returns the full path of the Region.

getParentRegion

String getParentRegion()

Returns the name of the parent Region.

listSubRegionPaths

String[] listSubRegionPaths(boolean recursive)

Returns a list of the names of the sub-regions.

Parameters:

recursive - true to recursively traverse and find sub-regions.

listRegionAttributes

RegionAttributesData listRegionAttributes()

Returns the attributes of the Region.

listPartitionAttributes

PartitionAttributesData listPartitionAttributes()

Returns the partition attributes of the Region.

listFixedPartitionAttributesData

FixedPartitionAttributesData[] listFixedPartitionAttributesData()

Returns the fixed partition attributes of the Region.

listEvictionAttributes

EvictionAttributesData listEvictionAttributes()

Returns the eviction attributes of the Region.

listMembershipAttributes

MembershipAttributesData listMembershipAttributes()

Returns the membership attributes of the Region.

getLastModifiedTime

long getLastModifiedTime()

Returns the time of the most recent modification.

getLastAccessedTime

long getLastAccessedTime()

Returns the time of the most recent access.

getMissCount

long getMissCount()

Returns the number of times that a cache miss occurred.

getHitCount

long getHitCount()

Returns the number of times that a hit occurred.

getHitRatio

float getHitRatio()

Returns the hit to miss ratio.

getSystemRegionEntryCount

long getSystemRegionEntryCount()

Returns the number of entries in the Region.

getGetsRate

float getGetsRate()

Returns the number of gets per second.

getPutsRate

float getPutsRate()

Returns the number of puts per second.

getCreatesRate

float getCreatesRate()

Returns the number of creates per second.

getDestroyRate

float getDestroyRate()

Returns the number of destroys per second.

getPutAllRate

float getPutAllRate()

Returns the number of putAlls per second.

getPutLocalRate

float getPutLocalRate()

Returns the local number of puts per second.

getPutRemoteRate

float getPutRemoteRate()

Returns the remote number of puts per second.

getPutRemoteLatency

long getPutRemoteLatency()

Returns the latency for the most recent remote put.

getPutRemoteAvgLatency

long getPutRemoteAvgLatency()

Return the average latency for remote puts.

getTotalEntriesOnlyOnDisk

long getTotalEntriesOnlyOnDisk()

Returns the current number of entries whose values are only on disk (not in memory). Entries may not exist in memory if they have been overflowed to disk or not yet been faulted in after a recovery.

getTotalDiskEntriesInVM

long getTotalDiskEntriesInVM()

Returns the current number of entries held in memory.

getTotalBytesOnDisk

long getTotalBytesOnDisk()

Returns the total number of bytes stored on all disks.

getDiskReadsRate

float getDiskReadsRate()

Returns the number of reads per second for all disks.

getDiskWritesRate

float getDiskWritesRate()

Returns the number of writes per second for all disks.

getDiskTaskWaiting

long getDiskTaskWaiting()

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

getTotalDiskWritesProgress

long getTotalDiskWritesProgress()

Returns the current number of disk writes in progress.

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.

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.

getBucketCount

int getBucketCount()

Returns the number of buckets on this member. Only applicable for partitioned regions.

getPrimaryBucketCount

int getPrimaryBucketCount()

Returns the number of primary buckets on this member. Only applicable for partitioned regions.

getNumBucketsWithoutRedundancy

int getNumBucketsWithoutRedundancy()

Returns the number of buckets without full redundancy. Only applicable for partitioned regions.

getMinBucketSize

int getMinBucketSize()

Returns the minimum number of entries in a bucket. Only applicable for partitioned regions.

getMaxBucketSize

int getMaxBucketSize()

Returns the maximum number of entries in a bucket. Only applicable for partitioned regions.

getTotalBucketSize

int getTotalBucketSize()

Returns the total number of entries in all buckets. Only applicable for partitioned regions.

getAvgBucketSize

int getAvgBucketSize()

Returns the average number of entries in bucket. Only applicable for partitioned regions.

getDiskUsage

long getDiskUsage()

Returns the total number of megabytes used by all disks.

getAverageReads

float getAverageReads()

Returns the average number of read requests per second.

getAverageWrites

float getAverageWrites()

Returns the average number of write requests per second.

isGatewayEnabled

boolean isGatewayEnabled()

Returns whether the Region sends data to a GatewaySender.

Returns:

True if the Region sends data, false otherwise.

isPersistentEnabled

boolean isPersistentEnabled()

Returns whether persistence is enabled

Returns:

True if persistence is enabled, false otherwise

getEntrySize

long getEntrySize()

Returns the aggregate entry size (in megabytes) of all entries. This will provide a correct value only if the eviction algorithm has been set to EvictionAlgorithm.LRU_MEMORY.

getEmptyNodes

int getEmptyNodes()

Returns the number of members whose entry count is 0.