Add guidelines for setting jvm heap size

Fixes #11716
This commit is contained in:
Karen Metts 2020-03-24 18:19:17 -04:00
parent f4b9349145
commit 0a4aa8b491
3 changed files with 32 additions and 1 deletions

View file

@ -214,6 +214,9 @@ include::{plugins-repo-dir}/plugins/codecs.asciidoc[]
:edit_url!: :edit_url!:
include::static/best-practice.asciidoc[] include::static/best-practice.asciidoc[]
:edit_url!:
include::static/config-details.asciidoc[]
:edit_url!: :edit_url!:
include::static/troubleshooting.asciidoc[] include::static/troubleshooting.asciidoc[]

View file

@ -109,4 +109,3 @@ reached the PQ can be committed.

29
docs/static/config-details.asciidoc vendored Normal file
View file

@ -0,0 +1,29 @@
[[heap-size]]
=== Setting the heap size
NOTE: Heap size should be no less than 4GB and no more than 8GB.
Here are some additional tips for adjusting the JVM heap size:
* CPU utilization can increase unnecessarily if the heap size is too low,
resulting in the JVM constantly garbage collecting. You can check for this issue
by doubling the heap size to see if performance improves.
* Do not increase the heap size past the amount of physical
memory. Leave at least 1GB free for the OS and other processes.
* Set the minimum (Xms) and maximum (Xmx) heap allocation size to the same
value to prevent the heap from resizing at runtime, which is a very costly
process.
* You can make more accurate measurements of the JVM heap by using either the
`jmap` command line utility distributed with Java or by using VisualVM. For more
info, see <<profiling-the-heap>>.