Skip to content

DOCS-737 correct bits to bytes for netIn/Out, also edits for style #398

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 13, 2012
Merged

DOCS-737 correct bits to bytes for netIn/Out, also edits for style #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 14 additions & 11 deletions source/reference/mongostat.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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 </reference/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
-------
Expand All @@ -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``.
Expand Down Expand Up @@ -101,15 +103,16 @@ Options
.. option:: --rowcount <number>, -n <number>

Controls the number of rows to output. Use in conjunction with
":command:`mongostat <sleeptime>`" to control the duration of a
:program:`mongostat <sleeptime>` 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
Expand All @@ -134,7 +137,7 @@ Options

.. option:: <sleeptime>

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.

Expand Down Expand Up @@ -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.

Expand Down