(DOCSP-31707): Backport DOCSP-31484 to v6.0. (#5156)

corryroot · corryroot · commit ed641cdd6a2d · 2023-07-27T09:29:17.000-04:00
* (DOCSP-31484): Added -Xmn details to our heap memory tuning pages. * (DOCSP-31484): Incorporated Evelyn's feedback.
diff --git a/source/includes/extracts-troubleshooting.yaml b/source/includes/extracts-troubleshooting.yaml
@@ -245,41 +245,54 @@ content: |
               The key values in this line are:
 
               .. list-table::
-                 :widths: 40 60
+                 :widths: 10 40 40
+                 :header-rows: 1
                  :stub-columns: 1
 
+                 * - Key
+                   - Value
+                   - Default
+
                  * - ``-Xmx``
                    - Java Heap Maximum Memory
+                   - 4,352 :abbr:`MB (Megabytes)` (``4352m``)
                  * - ``-Xms``
                    - Java Heap Starting Memory
-
-              By default, these values are both set to 
-              4,352 :abbr:`MB (Megabytes)` (``4352m``).
+                   - 4,352 :abbr:`MB (Megabytes)` (``4352m``)
+                 * - ``-Xmn``
+                   - Java Heap Young Generation Memory
+                   - 1,500 :abbr:`MB (Megabytes)` (``1500m``)
 
               .. admonition:: Do not change other Java options
                  :class: warning
 
-                 Changing any option values other than ``-Xmx`` and 
-                 ``-Xms`` could have an unexpected impact on the 
-                 |application|. Do not change other values without 
-                 consulting MongoDB Support.
-
-           3. Change the ``-Xmx`` and ``-Xms`` values to a larger 
-              value. Both parameters should be set to the same value 
-              to remove any performance impact from the VM constantly 
-              reclaiming memory from the heap.
-
-              The value is specified as ``#k|m|g``: a number followed 
-              by 
+                 Changing any option values other than ``-Xmx``, 
+                 ``-Xms``, and ``-Xmn`` could have an unexpected impact 
+                 on the |application|. Do not change other values 
+                 without consulting MongoDB Support.
+
+           
+           3. Change the ``-Xmx``, ``-Xms``, and ``Xmn`` values:
+   
+              - Change the ``-Xmx`` and ``-Xms`` values to a larger
+                value. You should set both parameters to the same value
+                to remove any performance impact from the VM constantly
+                reclaiming memory from the heap.
+
+              - Change the ``-Xmn`` value to a quarter of the value 
+                that you specified for the ``-Xmx`` and ``-Xms`` keys.
+              
+              Specify the values as ``#k|m|g``: a number followed 
+              by:
 
               - ``k`` (kilobytes),
               - ``m`` (megabytes), or 
               - ``g`` (gigabytes)
 
               .. example::
 
-                 To set the Java heap to 10 :abbr:`GB (Gigabytes)`, 
-                 set this value to: ``-Xmx10g -Xms10g``
+                 To set the Java Heap to 12 :abbr:`GB (Gigabytes)`, 
+                 set the values to: ``-Xmx12g -Xms12g -Xmn3g``.
 
        - id: windows
          name: Windows Hosts
@@ -347,7 +360,7 @@ content: |
 
               .. example::
 
-                 To set the Java heap to 10 :abbr:`GB (Gigabytes)`, 
+                 To set the Java Heap to 10 :abbr:`GB (Gigabytes)`, 
                  set this value to: ``-Xmx10g -Xms10g``
 
   The optimal value for your |onprem| installation depends upon your
@@ -362,7 +375,7 @@ content: |
   
   .. important::
 
-     Your Java heap size must not be set to a value greater than the
+     Your Java Heap size must not be set to a value greater than the
      amount of physical memory in the |onprem| host or less than the
      default value of ``4352m`` (4,352 :abbr:`MB (Megabytes)`).
 
diff --git a/source/reference/troubleshooting/system.txt b/source/reference/troubleshooting/system.txt
@@ -29,46 +29,54 @@ hosts:
 
       JAVA_MMS_UI_OPTS="${JAVA_MMS_UI_OPTS} -Xss228k -Xmx4352m -Xms4352m -XX:NewSize=600m -Xmn1500m -XX:ReservedCodeCacheSize=128m -XX:-OmitStackTraceInFastThrow"
 
-   The key values in this line are:
-
    .. list-table::
-      :widths: 40 60
-      :stub-columns: 1
+      :widths: 10 40 40
       :header-rows: 1
+      :stub-columns: 1
 
       * - Key
         - Value
+        - Default
+
       * - ``-Xmx``
         - Java Heap Maximum Memory
+        - 4,352 :abbr:`MB (Megabytes)` (``4352m``)
       * - ``-Xms``
         - Java Heap Starting Memory
-
-   By default, these values are both set to 4,352 
-   :abbr:`MB (Megabytes)` (``4352m``).
+        - 4,352 :abbr:`MB (Megabytes)` (``4352m``)
+      * - ``-Xmn``
+        - Java Heap Young Generation Memory
+        - 1,500 :abbr:`MB (Megabytes)` (``1500m``)
 
    .. warning:: **Do not change other Java options**
 
-      Changing any option values other than ``-Xmx`` and
-      ``-Xms`` could have an unexpected impact on the
-      |application|. Do not change other values without
-      consulting MongoDB Support.
+      Changing any option values other than ``-Xmx``, 
+      ``-Xms``, and ``-Xmn`` could have an unexpected impact 
+      on the |application|. Do not change other values 
+      without consulting MongoDB Support.
 
-3. Change the ``-Xmx`` and ``-Xms`` values to a larger
-   value. Both parameters should be set to the same value
-   to remove any performance impact from the VM constantly
-   reclaiming memory from the heap.
+3. Change the ``-Xmx``, ``-Xms``, and ``Xmn`` values:
+   
+   - Change the ``-Xmx`` and ``-Xms`` values to a larger
+     value. You should set both parameters to the same value
+     to remove any performance impact from the VM constantly
+     reclaiming memory from the heap.
 
-   The value is specified as ``#k|m|g``: a number followed
-   by
+   - Change the ``-Xmn`` value to a quarter of the value 
+     that you specified for the ``-Xmx`` and ``-Xms`` keys.
+
+   Specify the values as ``#k|m|g``: a number followed 
+   by:
 
    - ``k`` (kilobytes),
    - ``m`` (megabytes), or
    - ``g`` (gigabytes)
 
    .. example::
 
-      To set the Java heap to 10 :abbr:`GB (Gigabytes)`,
-      set this value to: ``-Xmx10g -Xms10g``
+      To set the Java Heap to 12 :abbr:`GB (Gigabytes)`, 
+      set the values to: ``-Xmx12g -Xms12g -Xmn3g``.
+
 4. Restart each host running |a-mms| instance on which you made these
    changes.
 
@@ -85,7 +93,7 @@ collection, and the frequency of garbage collection.
 .. important::
 
    Consider the co-located MongoDB processes running on the host and
-   do not set your Java heap size to a value greater than the amount of
+   do not set your Java Heap size to a value greater than the amount of
    physical memory in the |onprem| host or less than the default value
    of ``4352m`` (4,352 :abbr:`MB (Megabytes)`).
 
diff --git a/source/tutorial/monitoring-large-deployments.txt b/source/tutorial/monitoring-large-deployments.txt
@@ -21,10 +21,13 @@ Allocate more RAM to Ops Manager Hosts
    editor.
 
 2. Find a line where the ``JAVA_MMS_UI_OPTS`` variable defines the
-   ``-Xms``/``-Xmx`` parameters.
+   ``-Xms``, ``-Xmx``, and ``-Xmn`` parameters.
 
-3. Update the values from the default of 4352 MB to 8192 MB or more if
-   the hosts have extra free memory.
+3. Update the ``-Xms`` and ``-Xmx`` values from the default of 4352 MB 
+   to 8192 MB or more if the hosts have extra free memory.
+
+4. Update the ``-Xmn`` value from the default of 1500 MB to a quarter 
+   of the value that you specified for ``-Xms`` and ``-Xmx``.
 
 To learn about how to resolve this error in greater detail, see our
 troubleshooting entry on the
