Skip to content

DOCS-3883 #1964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions source/reference/program/mongostat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ instance. :program:`mongostat` is functionally similar to the
UNIX/Linux file system utility ``vmstat``, but provides data regarding
:program:`mongod` and :program:`mongos` instances.

.. important:: In order to connect to a :program:`mongod` that enforces
authorization with the :option:`--auth <mongod --auth>` option, the
:option:`--username <mongostat --username>` and
:option:`--password <mongostat --password>` options must be used, and the
user specified must have the :authaction:`serverStatus` privilege.

The most appropriate built-in role that has this privilege is
:authrole:`clusterMonitor`.

.. seealso::

For more information about monitoring MongoDB, see
Expand All @@ -32,12 +41,6 @@ UNIX/Linux file system utility ``vmstat``, but provides data regarding
For an additional utility that provides MongoDB metrics see
:doc:`mongotop </reference/program/mongotop>`.

:program:`mongostat` connects to the :program:`mongod` instance running
on the local host interface on TCP port ``27017``; however,
:program:`mongostat` can connect to any accessible remote :program:`mongod`
instance.


Options
-------

Expand Down
10 changes: 10 additions & 0 deletions source/reference/program/mongotop.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ MongoDB instance spends reading and writing data. :program:`mongotop`
provides statistics on a per-collection level. By default,
:program:`mongotop` returns values every second.

.. important:: In order to connect to a :program:`mongod` that enforces
authorization with the :option:`--auth <mongod --auth>` option, the
:option:`--username <mongotop --username>` and
:option:`--password <mongotop --password>` options must be used, and the
user specified must have the :authaction:`serverStatus` and
:authaction:`top` privileges.

The most appropriate built-in role that has these privileges is
:authrole:`clusterMonitor`.

.. seealso::

For more information about monitoring MongoDB, see
Expand Down