Skip to content

Commit 0af906f

Browse files
davidhou17ksuarz
andauthored
(DOCS-7159): Add tcmalloc verbosity section to serverStatus() (#2167) (#2182)
* 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]> Co-authored-by: Kyle Suarez <[email protected]>
1 parent 2497764 commit 0af906f

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
@@ -123,6 +123,30 @@ the inclusion:
123123

124124
db.runCommand( { serverStatus: 1, latchAnalysis: 1 } )
125125

126+
Change ``tcmalloc`` Verbosity
127+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128+
129+
By default, ``tcmalloc`` information is included in the output. This
130+
section provides memory allocation statistics for your database. To
131+
change the verbosity of the ``tcmalloc`` section, specify an integer
132+
between ``0`` and ``2`` (inclusive):
133+
134+
.. code-block:: javascript
135+
136+
db.runCommand( { serverStatus: 1, tcmalloc: <int> } )
137+
138+
The command has the following behavior:
139+
140+
- By default, ``tcmalloc`` is set to ``1``.
141+
- Passing a larger integer value increases the verbosity.
142+
- Passing ``0`` or ``false`` omits the ``tcmalloc`` section from the
143+
output.
144+
- Passing any other input results in the default setting.
145+
146+
For more information about how MongoDB allocates memory, see `TCMalloc`_.
147+
148+
.. _`TCMalloc`: http://goog-perftools.sourceforge.net/doc/tcmalloc.html
149+
126150
.. _server-status-output:
127151

128152
Output

0 commit comments

Comments
 (0)