From 3bb7a5951b5cc710ab3dbd6f981607c36e2f70f9 Mon Sep 17 00:00:00 2001 From: James Holgate Date: Thu, 23 Jan 2025 11:23:16 +0000 Subject: [PATCH 1/2] Document expensive IMap reporting threshold & property 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: https://github.com/hazelcast/hazelcast-mono/pull/3856 --- .../pages/imap-bulk-read-operations.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc b/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc index e04eb2188..d869c3837 100644 --- a/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc +++ b/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc @@ -19,6 +19,13 @@ 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: Client invocations of certain `IMap` methods such as those described above +are logged on the member side when their results meet or exceed a threshold defined +by the Hazelcast property `hazelcast.expensive.imap.invocation.reporting.threshold`, +which has a default value of `100` results. +See the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/spi/properties/ClusterProperty.html#EXPENSIVE_IMAP_INVOCATION_REPORTING_THRESHOLD[relevant Javadocs^] +for details on which `IMap` methods are logged. + == Plan capacity Proper capacity planning is crucial for providing sufficient system resources to the Hazelcast cluster. This From c9ae13eb2772802277c8e116c41ec7c87303f713 Mon Sep 17 00:00:00 2001 From: James Holgate <130981049+JamesHazelcast@users.noreply.github.com> Date: Fri, 24 Jan 2025 17:57:33 +0000 Subject: [PATCH 2/2] Update docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc Co-authored-by: Rob Swain --- .../pages/imap-bulk-read-operations.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc b/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc index d869c3837..96fc15ea5 100644 --- a/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc +++ b/docs/modules/cluster-performance/pages/imap-bulk-read-operations.adoc @@ -19,12 +19,11 @@ 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: Client invocations of certain `IMap` methods such as those described above -are logged on the member side when their results meet or exceed a threshold defined +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. -See the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/spi/properties/ClusterProperty.html#EXPENSIVE_IMAP_INVOCATION_REPORTING_THRESHOLD[relevant Javadocs^] -for details on which `IMap` methods are logged. +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