Skip to content

serverStatus style change #1038

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

Closed
wants to merge 1 commit into from
Closed

serverStatus style change #1038

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
93 changes: 65 additions & 28 deletions source/reference/command/serverStatus.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ your database.
Instance Information
~~~~~~~~~~~~~~~~~~~~

.. example:: :ref:`output of the instance information fields <server-status-example-instance-information>`.
For an example of the instance information, see the :ref:`Instance
Information section <server-status-example-instance-information>` of
the :doc:`/reference/server-status` page.

.. data:: serverStatus.host

Expand Down Expand Up @@ -110,7 +112,9 @@ locks
All :data:`~serverStatus.locks` statuses first appeared in the 2.1.2
development release for the 2.2 series.

.. example:: :ref:`output of the locks fields <server-status-example-locks>`.
For an example of the ``locks`` output, see the :ref:`locks section
<server-status-example-locks>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.locks

Expand Down Expand Up @@ -304,7 +308,9 @@ locks
globalLock
~~~~~~~~~~

.. example:: :ref:`output of the globalLock fields <server-status-example-globallock>`.
For an example of the ``globalLock`` output, see the :ref:`globalLock
section <server-status-example-globallock>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.globalLock

Expand Down Expand Up @@ -417,7 +423,9 @@ globalLock.activeClients
mem
~~~

.. example:: :ref:`output of the memory fields <server-status-example-memory>`.
For an example of the ``mem`` output, see the :ref:`mem section
<server-status-example-memory>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.mem

Expand Down Expand Up @@ -478,7 +486,9 @@ mem
connections
~~~~~~~~~~~

.. example:: :ref:`output of the connections fields <server-status-example-connections>`.
For an example of the ``connections`` output, see the :ref:`connections
section <server-status-example-connections>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.connections

Expand Down Expand Up @@ -521,7 +531,9 @@ connections
extra_info
~~~~~~~~~~

.. example:: :ref:`output of the extra_info fields <server-status-example-extrainfo>`.
For an example of the ``extra_info`` output, see the :ref:`extra_info
section <server-status-example-extrainfo>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.extra_info

Expand Down Expand Up @@ -559,7 +571,9 @@ extra_info
indexCounters
~~~~~~~~~~~~~

.. example:: :ref:`output of the indexCounters fields <server-status-example-indexcounters>`.
For an example of the ``indexCounters`` output, see the
:ref:`indexCounters section <server-status-example-indexcounters>` of
the :doc:`/reference/server-status` page.

.. data:: serverStatus.indexCounters

Expand Down Expand Up @@ -629,7 +643,10 @@ indexCounters
backgroundFlushing
~~~~~~~~~~~~~~~~~~

.. example:: :ref:`output of the backgroundFlushing fields <server-status-example-backgroundflushing>`.
For an example of the ``backgroundFlushing`` output, see the
:ref:`backgroundFlushing section
<server-status-example-backgroundflushing>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.backgroundFlushing

Expand Down Expand Up @@ -692,7 +709,9 @@ backgroundFlushing
cursors
~~~~~~~

.. example:: :ref:`output of the cursors <server-status-example-cursors>` fields.
For an example of the ``cursors`` output, see the :ref:`cursors section
<server-status-example-cursors>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.cursors

Expand Down Expand Up @@ -724,7 +743,9 @@ cursors
network
~~~~~~~

.. example:: :ref:`output of the network fields <server-status-example-network>`.
For an example of the ``network`` output, see the :ref:`network section
<server-status-example-network>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.network

Expand Down Expand Up @@ -760,7 +781,9 @@ network
repl
~~~~

.. example:: :ref:`output of the repl fields <server-status-example-repl>`.
For an example of the ``repl`` output, see the :ref:`repl section
<server-status-example-repl>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.repl

Expand Down Expand Up @@ -810,7 +833,9 @@ repl
opcountersRepl
~~~~~~~~~~~~~~

.. example:: :ref:`output of the opcountersRepl fields <server-status-example-opcountersrepl>`.
For an example of the ``opcountersRepl`` output, see the
:ref:`opcountersRepl section <server-status-example-opcountersrepl>` of
the :doc:`/reference/server-status` page.

.. data:: serverStatus.opcountersRepl

Expand Down Expand Up @@ -870,7 +895,9 @@ opcountersRepl
opcounters
~~~~~~~~~~

.. example:: :ref:`output of the opcounters fields <server-status-example-opcounters>`.
For an example of the ``opcounters`` output, see the :ref:`opcounters
section <server-status-example-opcounters>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.opcounters

Expand Down Expand Up @@ -931,7 +958,9 @@ opcounters
asserts
~~~~~~~

.. example:: :ref:`output of the asserts fields <server-status-example-asserts>`.
For an example of the ``asserts`` output, see the :ref:`asserts section
<server-status-example-asserts>` of the :doc:`/reference/server-status`
page.

.. data:: serverStatus.asserts

Expand Down Expand Up @@ -982,7 +1011,10 @@ asserts
writeBacksQueued
~~~~~~~~~~~~~~~~

.. example:: :ref:`output of the writeBacksQueued fields <server-status-example-writebacksqueued>`.
For an example of the ``writeBacksQueued`` output, see the
:ref:`writeBacksQueued section
<server-status-example-writebacksqueued>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.writeBacksQueued

Expand All @@ -1001,7 +1033,9 @@ Journaling (dur)

.. versionadded:: 1.8

.. example:: :ref:`output of the journaling fields <server-status-example-journaling>`.
For an example of the ``Journaling (dur)`` output, see the
:ref:`journaling section <server-status-example-journaling>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.dur

Expand Down Expand Up @@ -1114,7 +1148,9 @@ Journaling (dur)
recordStats
~~~~~~~~~~~

.. example:: :ref:`output of the recordStats <server-status-example-recordstats>` fields.
For an example of the ``recordStats`` output, see the :ref:`recordStats
section <server-status-example-recordstats>` of the
:doc:`/reference/server-status` page.

.. versionadded::2.1.2
All :data:`~serverStatus.recordStats` statuses first appeared in the 2.1.2
Expand Down Expand Up @@ -1191,20 +1227,20 @@ workingSet

.. versionadded:: 2.4

.. example:: :ref:`output of the workingSet <server-status-example-workingset>` fields.

.. note::

The :data:`~serverStatus.workingSet` data is only included in the
output of :dbcommand:`serverStatus` *if* explicitly enabled. To
return the :data:`~serverStatus.workingSet` use one of the
.. note:: The :data:`~serverStatus.workingSet` data is only included in
the output of :dbcommand:`serverStatus` if explicitly enabled. To
return the :data:`~serverStatus.workingSet`, use one of the
following commands:

.. code-block:: javascript

db.serverStatus( { workingSet: 1 } )
db.runCommand( { serverStatus: 1, workingSet: 1 } )

For an example of the ``workingSet`` output, see the :ref:`workingSet
section <server-status-example-workingset>` of the
:doc:`/reference/server-status` page.

.. data:: serverStatus.workingSet

:data:`~serverStatus.workingSet` is a document that contains values
Expand Down Expand Up @@ -1269,8 +1305,9 @@ workingSet
metrics
~~~~~~~

.. example:: :ref:`output of the metrics <server-status-example-metrics>`
fields.
For an example of the metrics output, see the :ref:`metrics section
<server-status-example-metrics>` of the :doc:`/reference/server-status`
page.

.. versionadded:: 2.4

Expand Down Expand Up @@ -1449,7 +1486,7 @@ metrics
.. data:: serverStatus.metrics.repl.buffer.count

:data:`~serverStatus.metrics.repl.buffer.count` reports the current
number of operations in the oplog buffer.
number of operations in the oplog buffer.

.. data:: serverStatus.metrics.repl.buffer.maxSizeBytes

Expand Down Expand Up @@ -1529,7 +1566,7 @@ metrics
.. data:: serverStatus.metrics.repl.oplog.insert.num

:data:`~serverStatus.metrics.repl.oplog.insert.num` reports the total
number of items inserted into the :term:`oplog`.
number of items inserted into the :term:`oplog`.

.. data:: serverStatus.metrics.repl.oplog.insert.totalMillis

Expand Down