Skip to content

Commit

Permalink
GEODE-9224: Resolve doc discrepancy on region's entrysize description (
Browse files Browse the repository at this point in the history
…#6437)

* GEODE-9224: Resolve doc discrepancy on region's entrysize description
  • Loading branch information
davebarnes97 committed May 15, 2021
1 parent fb00b27 commit dd6a4e1
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,16 @@ public interface DistributedRegionMXBean {
boolean isPersistentEnabled();

/**
* 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 {@link EvictionAlgorithm#LRU_MEMORY}.
* Returns the aggregate entry size (in bytes) of all entries.
* For replicated regions, provides a value only if the eviction algorithm
* is set to {@link EvictionAlgorithm#LRU_MEMORY}.
* The entry size in this distributed context represents the sum total of memory
* used for data in the region across all members, so the reported value will
* include any redundant copies.
*
* All partitioned regions can report entry size, but the value also includes
* redundant entries and also counts the size of all the secondary entries in
* the node.
*/
long getEntrySize();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,12 +297,15 @@ public interface RegionMXBean {
long getDiskUsage();

/**
* 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 {@link EvictionAlgorithm#LRU_MEMORY}.
* Returns the aggregate entry size (in bytes) of all entries.
* For replicated regions, provides a value only if the eviction algorithm
* is set to {@link 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
* All partitioned regions can report entry size, but the value also includes
* redundant entries and also counts the size of all the secondary entries in
* the node.
*
* @return total entry size in bytes, -1 for replicated regions without LRU_MEMORY eviction
*/
long getEntrySize();

Expand Down
6 changes: 3 additions & 3 deletions geode-docs/tools_modules/pulse/pulse-views.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ The following table describes the data elements displayed on the Member View scr
<li><em>Name</em>. Region name.</li>
<li><em>Type</em>. For example, REPLICATE, PARTITION.</li>
<li><em>EntryCount</em>. Number of entries in the region.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries. For replicated regions this field provides a value only if the eviction algorithm is set to EvictionAlgorithm#LRU_ MEMORY. All partition regions can report entry size, but note that the value includes redundant entries and also counts the size of all the secondary entries on the node.</li>
</ul></td>
</tr>
<tr>
Expand All @@ -270,7 +270,7 @@ The following table describes the data elements displayed on the Member View scr
<li><em>Name</em>. Region name.</li>
<li><em>Type</em>. For example, REPLICATE, PARTITION.</li>
<li><em>EntryCount</em>. Number of entries in the region.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries. For replicated regions this field provides a value only if the eviction algorithm is set to EvictionAlgorithm#LRU_ MEMORY. All partition regions can report entry size, but note that the value includes redundant entries and also counts the size of all the secondary entries on the node.</li>
<li><em>Scope</em>. Scope configured for the region.</li>
<li><em>Disk Store Name</em>. Name of disk stores (if any) associated with the region.</li>
<li><em>Disk Synchronous</em>. True if writes to disk are set to synchronous and false if not. This field reflects the configured disk-synchronous region attribute.</li>
Expand Down Expand Up @@ -370,7 +370,7 @@ The following table describes the data elements displayed on the Region View scr
<ul>
<li><em>Member Name</em>. The name of the <%=vars.product_name%> member hosting the region.</li>
<li><em>EntryCount</em>. Number of entries for the region on that member.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries on that member. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.</li>
<li><em>EntrySize</em>. The aggregate entry size (in bytes) of all entries. For replicated regions this field provides a value only if the eviction algorithm is set to EvictionAlgorithm#LRU_ MEMORY. All partition regions can report entry size, but note that the value includes redundant entries and also counts the size of all the secondary entries on the node.</li>
<li><em>Accessor</em>. Indicates whether the member is an accessor member.</li>
<li><em>Reads/Writes</em>. Summary of reads and writes served from memory and from disk stores over the last 15 minutes.</li>
</ul></td>
Expand Down

0 comments on commit dd6a4e1

Please sign in to comment.