diff --git a/source/reference/mongostat.txt b/source/reference/mongostat.txt index a3fe9850d2b..7b0dea4c00a 100644 --- a/source/reference/mongostat.txt +++ b/source/reference/mongostat.txt @@ -11,9 +11,10 @@ Synopsis The :program:`mongostat` utility provides a quick overview of the status of a currently running :program:`mongod` +or :program:`mongos` instance. :program:`mongostat` is functionally similar to the UNIX/Linux file system utility ``vmstat``, but provides data regarding -:program:`mongod` instances. +:program:`mongod` and :program:`mongos` instances. .. seealso:: @@ -30,10 +31,11 @@ UNIX/Linux file system utility ``vmstat``, but provides data regarding For an additional utility that provides MongoDB metrics see ":doc:`mongotop `." -:program:`mongostat` connects to the :program:`mongod` process running +: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 MongoDB -process. +:program:`mongostat` can connect to any accessible remote :program:`mongod` +instance. + Options ------- @@ -60,7 +62,7 @@ Options Specifies a resolvable hostname for the :program:`mongod` from which you want to export data. By default :program:`mongostat` attempts to connect - to a MongoDB process running on the localhost port number ``27017``. + to a MongoDB instance running on the localhost port number ``27017``. Optionally, specify a port number to connect a MongoDB instance running on a port other than ``27017``. @@ -101,15 +103,16 @@ Options .. option:: --rowcount , -n Controls the number of rows to output. Use in conjunction with - ":command:`mongostat `" to control the duration of a + :program:`mongostat ` to control the duration of a :program:`mongostat` operation. - Unless specification, :program:`mongostat` will return an infinite number + Unless :option:`--rowcount` is specified, :program:`mongostat` + will return an infinite number of rows (e.g. value of ``0``.) .. option:: --http - Configures :program:`mongostat` to collect data using HTTP interface + Configures :program:`mongostat` to collect data using the HTTP interface rather than a raw database connection. .. option:: --discover @@ -134,7 +137,7 @@ Options .. option:: - The final argument the length of time, in seconds, that + The final argument is the length of time, in seconds, that :program:`mongostat` waits in between calls. By default :program:`mongostat` returns one call every second. @@ -260,13 +263,13 @@ average operations per second. .. describe:: netIn - The amount of network traffic, in *bits*, received by the MongoDB. + The amount of network traffic, in *bytes*, received by the MongoDB instance. This includes traffic from :program:`mongostat` itself. .. describe:: netOut - The amount of network traffic, in *bits*, sent by the MongoDB. + The amount of network traffic, in *bytes*, sent by the MongoDB instance. This includes traffic from :program:`mongostat` itself.