GemFire 7.0

com.gemstone.gemfire.management
Interface RegionMXBean


public interface RegionMXBean

Member's local view of region. Member may have 0..n of these.

Since:
7.0

Method Summary
 int getActualRedundancy()
          Applicable only for partitioned regions
 float getAverageReads()
          Pulse Attribute
 float getAverageWrites()
          Pulse Attribute
 int getAvgBucketSize()
          Applicable only for partitioned regions
 int getBucketCount()
          Applicable only for partitioned regions
 long getCacheListenerCallsAvgLatency()
           
 long getCacheWriterCallsAvgLatency()
           
 int getConfiguredRedundancy()
          Applicable only for partitioned regions
 float getCreatesRate()
           
 float getDestroyRate()
           
 long getDiskReadsAverageLatency()
           
 float getDiskReadsRate()
          Rate of reads for region entries that have been read from disk
 long getDiskTaskWaiting()
           
 long getDiskUsage()
          The total number of MBs currently being used on disk for this region.
 long getDiskWritesAverageLatency()
           
 float getDiskWritesRate()
          Rate of writes of region entries that have been written to disk.
 long getEntryCount()
          Pulse Attribute
 long getEntrySize()
          This will give a positive value only if the region has set eviction algorithm to LRU_MEMORY Aggregate Entry size of all the entries in the region
 String getFullPath()
          Pulse Attribute
 float getGetsRate()
           
 long getHitCount()
          Will return value only if statistics is enables for this region
 float getHitRatio()
          Will return value only if statistics is enables for this region
 long getLastAccessedTime()
          Will return value only if statistics is enables for this region
 long getLastModifiedTime()
          Will return value only if statistics is enables for this region
 float getLruDestroyRate()
           
 float getLruEvictionRate()
           
 int getMaxBucketSize()
          Applicable only for partitioned regions
 String getMember()
          Member hosting the region
 int getMinBucketSize()
          Applicable only for partitioned regions
 long getMissCount()
          Will return value only if statistics is enables for this region
 String getName()
          Pulse Attribute
 int getNumBucketsWithoutRedundancy()
          Applicable only for partitioned regions
 String getParentRegion()
           
 int getPrimaryBucketCount()
          Applicable only for partitioned regions
 float getPutAllRate()
           
 float getPutLocalRate()
           
 long getPutRemoteAvgLatency()
           
 long getPutRemoteLatency()
           
 float getPutRemoteRate()
           
 float getPutsRate()
           
 String getRegionType()
          Pulse Attribute
 int getTotalBucketSize()
          Applicable only for partitioned regions
 long getTotalBytesOnDisk()
           
 long getTotalDiskEntriesInVM()
           
 long getTotalDiskWritesProgress()
           
 long getTotalEntriesOnlyOnDisk()
           
 boolean isGatewayEnabled()
          Pulse Attribute Whether this region sends data to any GatewaySender or not
 boolean isPersistentEnabled()
           
 EvictionAttributesData listEvictionAttributes()
           
 FixedPartitionAttributesData[] listFixedPartitionAttributes()
           
 MembershipAttributesData listMembershipAttributes()
           
 PartitionAttributesData listPartitionAttributes()
           
 RegionAttributesData listRegionAttributes()
           
 String[] listSubRegionPaths(boolean recursive)
           
 

Method Detail

getName

String getName()
Pulse Attribute

Returns:
name of the Region

getRegionType

String getRegionType()
Pulse Attribute

Returns:
type of the Region. It returns the DataPolicy for this particular region

getFullPath

String getFullPath()
Pulse Attribute

Returns:
FullPath of the region

getParentRegion

String getParentRegion()
Returns:
Parent Region Name

listSubRegionPaths

String[] listSubRegionPaths(boolean recursive)
Parameters:
recursive - if true, recursively traverses to find sub regions.
Returns:
String array of sub region paths

listRegionAttributes

RegionAttributesData listRegionAttributes()
Returns:
Region Attributes

listPartitionAttributes

PartitionAttributesData listPartitionAttributes()
Returns:
Partition Region Attributes

listFixedPartitionAttributes

FixedPartitionAttributesData[] listFixedPartitionAttributes()
Returns:
Fixed Partition Region Attributes

listEvictionAttributes

EvictionAttributesData listEvictionAttributes()
Returns:
Eviction Attribute

listMembershipAttributes

MembershipAttributesData listMembershipAttributes()
Returns:
Membership attributes

getLastModifiedTime

long getLastModifiedTime()
Will return value only if statistics is enables for this region

Returns:
last update time of the region

getLastAccessedTime

long getLastAccessedTime()
Will return value only if statistics is enables for this region

Returns:
returns the last time the region was accessed

getMissCount

long getMissCount()
Will return value only if statistics is enables for this region

Returns:
number of times cache missed on the local region

getHitCount

long getHitCount()
Will return value only if statistics is enables for this region

Returns:
total hit count

getHitRatio

float getHitRatio()
Will return value only if statistics is enables for this region

Returns:
hit to miss ratio

getEntryCount

long getEntryCount()
Pulse Attribute

Returns:
number of entry

getGetsRate

float getGetsRate()
Returns:
gets per second for the Regions

getPutsRate

float getPutsRate()
Returns:
puts per second for the Regions

getCreatesRate

float getCreatesRate()
Returns:
creates per second for the Regions

getDestroyRate

float getDestroyRate()
Returns:
destroy per second for the Regions

getPutAllRate

float getPutAllRate()
Returns:
putAll per second for the Regions

getPutLocalRate

float getPutLocalRate()
Returns:
Partition Region local put rate

getPutRemoteRate

float getPutRemoteRate()
Returns:
Partition Region remote put rate

getPutRemoteLatency

long getPutRemoteLatency()
Returns:
Latency for last remote put

getPutRemoteAvgLatency

long getPutRemoteAvgLatency()
Returns:
Average Latency for remote put

getTotalEntriesOnlyOnDisk

long getTotalEntriesOnlyOnDisk()
Returns:
The current number of entries whose value is on disk and is not in memory. This is true of overflowed entries. It is also true of recovered entries that have not yet been faulted in.

getTotalDiskEntriesInVM

long getTotalDiskEntriesInVM()
Returns:
The current number of entries whose value resides in the VM. The value may also have been written to disk.

getTotalBytesOnDisk

long getTotalBytesOnDisk()
Returns:
consolidated count of bytes on each disk of the region

getDiskReadsRate

float getDiskReadsRate()
Rate of reads for region entries that have been read from disk

Returns:
disk reads rate for disk belonging to Region

getDiskReadsAverageLatency

long getDiskReadsAverageLatency()
Returns:
Average latency of disk reads

getDiskWritesAverageLatency

long getDiskWritesAverageLatency()
Returns:
Average latency of disk writes

getDiskWritesRate

float getDiskWritesRate()
Rate of writes of region entries that have been written to disk. A write is done every time an entry is created on disk or every time its value is modified.

Returns:
disk writes rate across region

getTotalDiskWritesProgress

long getTotalDiskWritesProgress()
Returns:
current number of oplog writes that are in progress

getDiskTaskWaiting

long getDiskTaskWaiting()
Returns:
Current number of disk tasks (oplog compactions, asynchronous recoveries, etc) that are waiting for a thread to run the operation

getCacheWriterCallsAvgLatency

long getCacheWriterCallsAvgLatency()
Returns:
Avg Latency of cache writer call

getCacheListenerCallsAvgLatency

long getCacheListenerCallsAvgLatency()
Returns:
Avg Latency of cache listener call

getLruEvictionRate

float getLruEvictionRate()
Returns:
entry evictions rate triggered by LRU.

getLruDestroyRate

float getLruDestroyRate()
Returns:
entries destroyed rate in the region through both destroy cache operations and eviction.

getBucketCount

int getBucketCount()
Applicable only for partitioned regions

Returns:
Number of buckets in this node.

getPrimaryBucketCount

int getPrimaryBucketCount()
Applicable only for partitioned regions

Returns:
Current number of primary buckets hosted locally.

getNumBucketsWithoutRedundancy

int getNumBucketsWithoutRedundancy()
Applicable only for partitioned regions

Returns:
Current number of buckets without full redundancy.

getConfiguredRedundancy

int getConfiguredRedundancy()
Applicable only for partitioned regions

Returns:
Configured number of redundant copies for this partitioned region.

getActualRedundancy

int getActualRedundancy()
Applicable only for partitioned regions

Returns:
Actual number of redundant copies for this partitioned region.

getMinBucketSize

int getMinBucketSize()
Applicable only for partitioned regions

Returns:
Minimum number of entries in a bucket.

getMaxBucketSize

int getMaxBucketSize()
Applicable only for partitioned regions

Returns:
Maximum number of entries in a bucket.

getTotalBucketSize

int getTotalBucketSize()
Applicable only for partitioned regions

Returns:
Total number of entries in buckets

getAvgBucketSize

int getAvgBucketSize()
Applicable only for partitioned regions

Returns:
Average entries per bucket.

getDiskUsage

long getDiskUsage()
The total number of MBs currently being used on disk for this region.

Returns:
long value of disk size

getEntrySize

long getEntrySize()
This will give a positive value only if the region has set eviction algorithm to LRU_MEMORY Aggregate Entry size of all the entries in the region

Returns:
long value in MB

isGatewayEnabled

boolean isGatewayEnabled()
Pulse Attribute Whether this region sends data to any GatewaySender or not

Returns:
boolean

getAverageReads

float getAverageReads()
Pulse Attribute

Returns:
Average Read requests per second

getAverageWrites

float getAverageWrites()
Pulse Attribute

Returns:
Average Write requests per second

isPersistentEnabled

boolean isPersistentEnabled()
Returns:
true if persistence is enabled for this region

getMember

String getMember()
Member hosting the region

Returns:
String

GemFire 7.0

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