Skip to content

Commit

Permalink
Document expensive IMap reporting threshold & property (#1498)
Browse files Browse the repository at this point in the history
Adds documentation about the expensive IMap client invocations logging,
including the property used to control this threshold and guidance on
which methods utilize this reporting.

Related PR: hazelcast/hazelcast-mono#3856
  • Loading branch information
JamesHazelcast authored Jan 27, 2025
1 parent 12e68a8 commit 9b2cc5c
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Methods like `IMap#entrySet()` and `IMap#values()` can trigger an OOME, dependin
on the size of your map and the available memory on each member.
To mitigate this risk, you should follow these best practices.

NOTE: To help you to monitor this potential problem, client invocations of certain `IMap` methods are logged on the member side when their results meet or exceed a threshold.
The threshold for logging large results is defined
by the Hazelcast property `hazelcast.expensive.imap.invocation.reporting.threshold`,
which has a default value of `100` results.
The relevant methods are listed in the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/spi/properties/ClusterProperty.html#EXPENSIVE_IMAP_INVOCATION_REPORTING_THRESHOLD[Javadocs^].

== Plan capacity
Proper capacity planning is crucial for providing
sufficient system resources to the Hazelcast cluster. This
Expand Down

0 comments on commit 9b2cc5c

Please sign in to comment.