Skip to content

Commit 068253f

Browse files
davidhou17ksuarz
andauthored
(DOCS-7159): Add tcmalloc verbosity section to serverStatus() (#2167)
* Add tcmalloc section to serverStatus() * copy review feedback * Update source/reference/command/serverStatus.txt Co-authored-by: Kyle Suarez <[email protected]> Co-authored-by: Kyle Suarez <[email protected]>
1 parent 3c2fb05 commit 068253f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

source/reference/command/serverStatus.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,30 @@ the inclusion:
135135

136136
db.runCommand( { serverStatus: 1, latchAnalysis: 1 } )
137137

138+
Change ``tcmalloc`` Verbosity
139+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140+
141+
By default, ``tcmalloc`` information is included in the output. This
142+
section provides memory allocation statistics for your database. To
143+
change the verbosity of the ``tcmalloc`` section, specify an integer
144+
between ``0`` and ``2`` (inclusive):
145+
146+
.. code-block:: javascript
147+
148+
db.runCommand( { serverStatus: 1, tcmalloc: <int> } )
149+
150+
The command has the following behavior:
151+
152+
- By default, ``tcmalloc`` is set to ``1``.
153+
- Passing a larger integer value increases the verbosity.
154+
- Passing ``0`` or ``false`` omits the ``tcmalloc`` section from the
155+
output.
156+
- Passing any other input results in the default setting.
157+
158+
For more information about how MongoDB allocates memory, see `TCMalloc`_.
159+
160+
.. _`TCMalloc`: http://goog-perftools.sourceforge.net/doc/tcmalloc.html
161+
138162
.. _server-status-output:
139163

140164
Output

0 commit comments

Comments
 (0)