[GEODE-9224] Resolve doc discrepancy on region's entrysize description

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.13.2
• Fix Version/s: 1.14.0, 1.15.0
• Component/s: docs, management
• Labels: pull-request-available
• Assignee: Dave Barnes
• Reporter: Dave Barnes
• Created: 30/Apr/21 21:09
• Updated: 03/Sep/21 05:23
• Resolved: 15/May/21 17:26

Description

A community member a document discrepancy between RegionMXBean’s getEntrySize
and Pulse’s region EntrySize description. Customer is concerned with which description is correct and if the eviction algorithm is not the right one, how “incorrect” will the figure be ? What is the error margin?

1) For *RegionMXBean's getEntrySize:

 

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.

https://geode.apache.org/releases/latest/javadoc/org/apache/geode/management/RegionMXBean.html#getEntrySize--

2) For Pulse's region entry size (same text is replicated 3 times in this section):

 

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.

https://geode.apache.org/docs/guide/113/tools_modules/pulse/pulse-views.html

ps:
I also noticed DistributedRegionMXBean’s getEntrySize also has a different version of description there.
https://geode.apache.org/releases/latest/javadoc/org/apache/geode/management/DistributedRegionMXBean.html#getEntrySize--

 

Note: This docs-oriented issue involves a user guide source file and a code source file containing javadoc comments.

Issue Links

• links to: GitHub Pull Request #6437