Dave Barnes created GEODE-9224:
----------------------------------
Summary: Resolve doc discrepancy on region's entrysize description
Key: GEODE-9224
URL: https://issues.apache.org/jira/browse/GEODE-9224
Project: Geode
Issue Type: Improvement
Components: docs, management
Affects Versions: 1.13.2
Reporter: Dave Barnes
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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
