upthewaterspout commented on a change in pull request #6437:
URL: https://github.com/apache/geode/pull/6437#discussion_r632814431
##########
File path:
geode-core/src/main/java/org/apache/geode/management/RegionMXBean.java
##########
@@ -297,12 +297,13 @@
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
+ * on the node.
Review comment:
This should also use a `@return` tag that spells out that return value
will be `-1` for replicated regions without LRU_MEMORY eviction.
##########
File path:
geode-core/src/main/java/org/apache/geode/management/RegionMXBean.java
##########
@@ -297,12 +297,13 @@
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
+ * on the node.
Review comment:
This could also use a `@return` tag that spells out that return value
will be `-1` for replicated regions 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]
