Document expensive IMap reporting threshold & property #1498
+7
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JackPGreen
approved these changes
Jan 23, 2025
Comment on lines
+22
to
+27
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| To identify this potential problematic usage, client invocations of `IMap` methods such as those described above returning large results are logged on the member side. | |
| 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. |
Nit - I feel like this could be split into two sections to be clearer. But I'm not sure mine is an improvement!
There was a problem hiding this comment.
Agree, but that opening sentence is a little hard to parse, and we need to be clear that it's a defined set of methods and a defined threshold. How about this:
Suggested change
| 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. | |
| 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^]. |
I could go either way on using a note box, but we need it here because this doesn't follow on from "you should follow these best practices".
Should I be able to see that field at that link?
Anything we can say / link to about what to do with the logs?
devOpsHazelcast
pushed a commit
to hazelcast/hazelcast
that referenced
this pull request
Jan 23, 2025
…5] (#3856) Adds the cluster property `hazelcast.expensive.imap.invocation.reporting.threshold` (default `100`) to define the threshold at or above which expensive client invocations are logged. This prevents excessive logging of normal operations, including internal operations such as Jet snapshot information retrieval. The default threshold is fairly arbitrarily based on the comment where this approach was first suggested: https://hazelcast.atlassian.net/browse/SUP-735?focusedCommentId=106331 Docs PR: hazelcast/hz-docs#1498 Fixes https://hazelcast.atlassian.net/browse/HZG-305 GitOrigin-RevId: 6e61e27d2d59d59a3124262cc9f0e54c068085ed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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