Skip to content

Commit ae34c8f

Browse files
Docsp 34942 5.0 backport (#5797)
* 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]>
1 parent ccff0eb commit ae34c8f

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

source/reference/parameters.txt

+31-1
Original file line numberDiff line numberDiff line change
@@ -1579,6 +1579,30 @@ General Parameters
15791579
.. seealso: :ref:`storage-node-watchdog`
15801580

15811581

1582+
.. parameter:: tcmallocAggressiveMemoryDecommit
1583+
1584+
*Type*: integer (``0`` or ``1`` only)
1585+
1586+
Default: 1
1587+
1588+
If you enable ``tmallocAggressiveMemoryDecommit``, MongoDB:
1589+
1590+
- releases a :term:`chunk <chunk>` of memory to system, and
1591+
1592+
- attempts to return all neighboring free chunks.
1593+
1594+
A value of ``1`` enables ``tcmallocAggressiveMemoryDecommit``;
1595+
``0`` disables this parameter.
1596+
1597+
If you enable this parameter, the system will require new memory allocations
1598+
for use. Consider enabling ``tcmallocAggressiveMemoryDecommit``
1599+
only on memory-constrained systems and after pursuing other memory and
1600+
performance options.
1601+
1602+
Despite the potential performance degradation when using
1603+
``tcmallocAggressiveMemoryDecommit``, it is often preferred over using
1604+
:parameter:`tcmallocReleaseRate`.
1605+
15821606
.. parameter:: tcmallocReleaseRate
15831607

15841608
.. versionadded:: 4.2.3
@@ -1595,7 +1619,13 @@ General Parameters
15951619
return memory faster; decrease it to return memory slower.
15961620
Reasonable rates are in the range [0,10]."
15971621

1598-
To modify the release rate during runtime, you can use the
1622+
.. note::
1623+
1624+
Consider using :parameter:`tcmallocAggressiveMemoryDecommit` instead of
1625+
:parameter:`tcmallocReleaseRate`, unless you see a significant performance
1626+
degradation when using ``tcmallocAggressiveMemoryDecommit``.
1627+
1628+
To modify the release rate during run time, you can use the
15991629
:dbcommand:`setParameter` command; for example:
16001630

16011631
.. code-block:: javascript

0 commit comments

Comments
 (0)