Docsp 34942 4.4 backport (#5798)

* Add tcmallocAggressiveMemoryDecommit (#5650) * add tcmallocAggressiveMemoryDecommit * wordsmithing * external review suggestions and clarifications * writing review * Update source/reference/parameters.txt Co-authored-by: Alison Huh <[email protected]> * Update source/reference/parameters.txt Co-authored-by: Alison Huh <[email protected]> * fix formatting * final? review * Update source/reference/parameters.txt Co-authored-by: Alison Huh <[email protected]> * final changes, I hope... * fix formatting --------- Co-authored-by: Alison Huh <[email protected]> * fix single-hash issue (#5789) --------- Co-authored-by: Alison Huh <[email protected]>
mongodb · Jan 10, 2024 · 425b057 · 425b057
1 parent d231e3b
commit 425b057
Showing 1 changed file with 31 additions and 1 deletion.
diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt
@@ -1532,6 +1532,30 @@ General Parameters
    .. seealso: :ref:`storage-node-watchdog`
 
 
+.. parameter:: tcmallocAggressiveMemoryDecommit
+
+   *Type*: integer (``0`` or ``1`` only)
+
+   Default: 1
+
+   If you enable ``tmallocAggressiveMemoryDecommit``, MongoDB:
+
+   - releases a :term:`chunk <chunk>` of memory to system, and 
+
+   - attempts to return all neighboring free chunks. 
+
+   A value of ``1`` enables ``tcmallocAggressiveMemoryDecommit``; 
+   ``0`` disables this parameter.
+
+   If you enable this parameter, the system will require new memory allocations 
+   for use. Consider enabling ``tcmallocAggressiveMemoryDecommit`` 
+   only on memory-constrained systems and after pursuing other memory and 
+   performance options.
+
+   Despite the potential performance degradation when using 
+   ``tcmallocAggressiveMemoryDecommit``, it is often preferred over using 
+   :parameter:`tcmallocReleaseRate`.
+
 .. parameter:: tcmallocReleaseRate
 
    .. versionadded:: 4.2.3 
@@ -1548,7 +1572,13 @@ General Parameters
    return memory faster; decrease it to return memory slower.
    Reasonable rates are in the range [0,10]."
 
-   To modify the release rate during runtime, you can use the
+   .. note::
+
+      Consider using :parameter:`tcmallocAggressiveMemoryDecommit` instead of 
+      :parameter:`tcmallocReleaseRate`, unless you see a significant performance 
+      degradation when using ``tcmallocAggressiveMemoryDecommit``.
+
+   To modify the release rate during run time, you can use the
    :dbcommand:`setParameter` command; for example:
 
    .. code-block:: javascript