GemFire 7.0.1

com.gemstone.gemfire.management
Interface RegionMXBean


public interface RegionMXBean

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

Since:
7.0

Method Summary
 int getActualRedundancy()
          Returns the actual number of redundant copies available for buckets in this partitioned region.
 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.
 int getConfiguredRedundancy()
          Returns the number of redundant copies configured for this partitioned region.
 float getCreatesRate()
          Returns the number of creates per second.
 float getDestroyRate()
          Returns the number of destroys per second.
 long getDiskReadsAverageLatency()
          Returns the average latency of disk reads.
 float getDiskReadsRate()
          Returns the number of reads per second for all disks.
 long getDiskTaskWaiting()
          Deprecated.  
 long getDiskUsage()
          Returns the total number of bytes used by all disks.
 long getDiskWritesAverageLatency()
          Returns the average latency of disk writes.
 float getDiskWritesRate()
          Returns the number of writes per second for all disks.
 long getEntryCount()
          Returns the number of entries in the Region within this member.
 long getEntrySize()
          Returns the aggregate entry size (in bytes) 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.
 String getMember()
          Returns the name/ID of the member hosting this 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 number of local puts per second.
 long getPutRemoteAvgLatency()
          Returns the average latency for remote puts.
 long getPutRemoteLatency()
          Returns the latency for the most recent remote put.
 float getPutRemoteRate()
          Returns the number of remote puts per second.
 float getPutsRate()
          Returns the number of puts per second.
 String getRegionType()
          Returns the type (data policy) of the Region.
 int getTotalBucketSize()
          Returns the total number of entries in all buckets.
 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 this region sends data using a GatewaySender.
 boolean isPersistentEnabled()
          Returns whether persistence is enabled.
 EvictionAttributesData listEvictionAttributes()
          Returns the eviction attributes of the Region.
 FixedPartitionAttributesData[] listFixedPartitionAttributes()
          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 subregions.
 

Method Detail

getName

String getName()
Returns the name of the Region.


getRegionType

String getRegionType()
Returns the type (data policy) of the Region.


getFullPath

String getFullPath()
Returns the full path of the Region.


getParentRegion

String getParentRegion()
Returns the name of the parent Region.

Returns:
The name of the parent Region or null if the Region has no parent.

listSubRegionPaths

String[] listSubRegionPaths(boolean recursive)
Returns a list of the names of the subregions.

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.


listFixedPartitionAttributes

FixedPartitionAttributesData[] listFixedPartitionAttributes()
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. For partitioned region it will be -1 . This feature is not supported for partitioned regions.


getLastAccessedTime

long getLastAccessedTime()
Returns the time of the most recent access. For partitioned region it will be -1. This feature is not supported for partitioned regions.


getMissCount

long getMissCount()
Returns the number of times that a cache miss occurred. For partitioned region it will be -1 . This feature is not supported for partitioned regions.


getHitCount

long getHitCount()
Returns the number of times that a hit occurred. For partitioned region it will be -1.This feature is not supported for partitioned regions.


getHitRatio

float getHitRatio()
Returns the hit to miss ratio. For partitioned region it will be -1 .This feature is not supported for partitioned regions.


getEntryCount

long getEntryCount()
Returns the number of entries in the Region within this member. For partitioned regions it will be the entry count for the primary buckets hosted within this member.


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 number of local puts per second.


getPutRemoteRate

float getPutRemoteRate()
Returns the number of remote puts per second.


getPutRemoteLatency

long getPutRemoteLatency()
Returns the latency for the most recent remote put.


getPutRemoteAvgLatency

long getPutRemoteAvgLatency()
Returns 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.


getDiskReadsRate

float getDiskReadsRate()
Returns the number of reads per second for all disks.


getDiskReadsAverageLatency

long getDiskReadsAverageLatency()
Returns the average latency of disk reads.


getDiskWritesAverageLatency

long getDiskWritesAverageLatency()
Returns the average latency of disk writes.


getDiskWritesRate

float getDiskWritesRate()
Returns the number of writes per second for all disks.


getTotalDiskWritesProgress

long getTotalDiskWritesProgress()
Returns the current number of disk writes in progress.


getDiskTaskWaiting

long getDiskTaskWaiting()
Deprecated. 

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


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.


getConfiguredRedundancy

int getConfiguredRedundancy()
Returns the number of redundant copies configured for this partitioned region.


getActualRedundancy

int getActualRedundancy()
Returns the actual number of redundant copies available for buckets in this partitioned region. Usually this is the number of redundant copies configured for buckets in the region. However, during initialization or error states the actual number of copies for any given bucket may be less than the configured number. In that case, the value returned will be the smallest number of redundant copies available for any single bucket.


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 bytes used by all disks.


getEntrySize

long getEntrySize()
Returns the aggregate entry size (in bytes) of all entries. This will provide a correct value only if the eviction algorithm has been set to EvictionAlgorithm.LRU_MEMORY. For all partition regions it will show entry size in bytes. It will also include size of all the secondary entries in the data store. So while referring to size one should take redundancy into account


isGatewayEnabled

boolean isGatewayEnabled()
Returns whether this region sends data using a GatewaySender.

Returns:
True if this region sends data, false otherwise.

getAverageReads

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


getAverageWrites

float getAverageWrites()
Returns the average number of write requests per second.


isPersistentEnabled

boolean isPersistentEnabled()
Returns whether persistence is enabled.

Returns:
True if persistence is enabled, false otherwise.

getMember

String getMember()
Returns the name/ID of the member hosting this Region.


GemFire 7.0.1

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