upthewaterspout commented on a change in pull request #6437:
URL: https://github.com/apache/geode/pull/6437#discussion_r632676333
##########
File path:
geode-core/src/main/java/org/apache/geode/management/DistributedRegionMXBean.java
##########
@@ -290,8 +290,16 @@
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 may
include
+ * redundancies.
+ *
+ * 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
+ * on the node.
Review comment:
> so the reported value may include redundancies.
"may" seems a bit vague here though. Maybe it should be "will include any
redundant copies"
This comment could also use a `@return` tag that explains this will return
`-1` if the region is a replicate without LRU_MEMORY eviction.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
