DOCS-377 adding cross references to the original server status index and linking the page.

Author: Sam Kleinman

source/reference.txt

@@ -31,6 +31,8 @@ Statuses and Errors
 .. toctree::
    :maxdepth: 1
 
+
+   reference/server-status-index
    reference/server-status
    reference/database-statistics
    reference/collection-statistics
@@ -74,7 +76,7 @@ Current release:
 
 - :wiki:`v2.0 Release Notes <2.0+Release+Notes>`
 
-Previous release: 
+Previous release:
 
 - :wiki:`v1.8 Release Notes <1.8+Release+Notes>`
 

source/reference/server-status-index.txt

@@ -1,8 +1,6 @@
-:orphan:
-
-===================
-Server Status Index
-===================
+==========================
+Server Status Output Index
+==========================
 
 .. default-domain:: mongodb
 
@@ -23,6 +21,7 @@ documentation of the content of this output, see
    kind of node, including :program:`mongos`, :program:`mongod` or
    :term:`replica set` member.
 
+.. _server-status-example-instance-information:
 
 The ":ref:`server-status-instance-information`" section displays
 information regarding the specific :program:`mongod` and
@@ -40,6 +39,8 @@ information regarding the specific :program:`mongod` and
            "uptimeEstimate" : <num>,
            "localTime" : ISODate(""),
 
+.. _server-status-example-locks:
+
 The ":ref:`server-status-locks`" section reports data that reflect the
 state and use of both global (i.e. ``.``) and database specific locks:
 
@@ -88,6 +89,8 @@ state and use of both global (i.e. ``.``) and database specific locks:
                    }
            },
 
+.. _server-status-example-globallock:
+
 The ":ref:`server-status-globallock`" field reports on MongoDB's
 global system lock. In most cases the :ref:`locks <locks>` document
 provides more fine grained data that reflects lock use:
@@ -109,6 +112,7 @@ provides more fine grained data that reflects lock use:
                    }
            },
 
+.. _server-status-example-memory:
 
 The ":ref:`server-status-memory`" field reports on MongoDB's
 current memory use:
@@ -124,6 +128,8 @@ current memory use:
                    "mappedWithJournal" : <num>
            },
 
+.. _server-status-example-connections:
+
 The ":ref:`server-status-connections`" field reports on MongoDB's
 current memory use by the MongoDB process:
 
@@ -134,6 +140,8 @@ current memory use by the MongoDB process:
                    "available" : <num>
            },
 
+.. _server-status-example-extrainfo:
+
 The fields in the ":ref:`server-status-extra-info`" document provide
 platform specific information. The following example block is from a
 Linux-based system:
@@ -146,6 +154,7 @@ Linux-based system:
                    "page_faults" : <num>
            },
 
+.. _server-status-example-indexcounters:
 
 The ":ref:`server-status-indexcounters`" document reports on index
 use:
@@ -162,6 +171,8 @@ use:
                    }
            },
 
+.. _server-status-example-backgroundflushing:
+
 The ":ref:`server-status-backgroundflushing`" document reports on the
 process MongoDB uses to write data to disk:
 
@@ -175,6 +186,7 @@ process MongoDB uses to write data to disk:
                    "last_finished" : ISODate("")
            },
 
+.. _server-status-example-cursors:
 
 The ":ref:`server-status-cursors`" document reports on current cursor
 use and state:
@@ -187,6 +199,8 @@ use and state:
                    "timedOut" : <num>
            },
 
+.. _server-status-example-network:
+
 The ":ref:`server-status-network`" document reports on network use and
 state:
 
@@ -198,6 +212,8 @@ state:
                    "numRequests" : <num>
            },
 
+.. _server-status-example-repl:
+
 The ":ref:`server-status-repl`" document reports on the state of
 replication and the :term:`replica set`. This document only appears
 for replica sets.
@@ -217,6 +233,8 @@ for replica sets.
                    "me" : <hostname>
            },
 
+.. _server-status-example-opcountersrepl:
+
 The ":ref:`server-status-opcounters-repl`" document reports the number
 of replicated operations:
 
@@ -231,6 +249,8 @@ of replicated operations:
                    "command" : <num>
            },
 
+.. _server-status-example-replnetworkqueue:
+
 The ":ref:`server-status-repl-network-queue`" document holds
 information regarding the queue that :term:`secondaries <secondary>`
 use to poll data from other members of their set:
@@ -243,6 +263,8 @@ use to poll data from other members of their set:
                    "numBytes" : <num>
            },
 
+.. _server-status-example-opcounters:
+
 The ":ref:`server-status-opcounters`" document reports the number of
 operations this MongoDB instance has processed:
 
@@ -257,6 +279,8 @@ operations this MongoDB instance has processed:
                    "command" : <num>
            },
 
+.. _server-status-example-asserts:
+
 The ":ref:`server-status-asserts`" document reports the number of
 assertions or errors produced by the server:
 
@@ -270,13 +294,17 @@ assertions or errors produced by the server:
                    "rollovers" : <num>
            },
 
-The ":ref:`server-status-writebacks`" document reports the number of
+.. _server-status-example-writebacksqueued:
+
+The ":ref:`server-status-writebacksqueued`" document reports the number of
 :term:`writebacks`:
 
 .. code-block:: javascript
 
            "writeBacksQueued" : <num>,
 
+.. _server-status-example-journaling:
+
 The ":ref:`server-status-journaling`" document reports data that
 reflect this :program:`mongod` journaling related operations and
 performance:
@@ -299,6 +327,8 @@ performance:
                    }
            },
 
+.. _server-status-example-recordstats:
+
 The ":ref:`server-status-recordstats`" document reports data on
 MongoDB's ability to predict page faults and yield write operations
 when required data isn't in memory:

source/reference/server-status.txt

@@ -17,13 +17,18 @@ your database.
 
 .. seealso:: Much of the output of :dbcommand:`serverStatus` is also
    displayed dynamically by :program:`mongostat`. See the
-   :doc:`/reference/mongostat`  reference for more information.
+   :doc:`/reference/mongostat` for more information.
+
+   For examples of the :dbcommand:`serverStatus` output, see
+   :doc:`/reference/server-status-index`.
 
 .. _server-status-instance-information:
 
 Instance Information
 --------------------
 
+.. example:: output of the :ref:`instance information <server-status-example-instance-information>` fields.
+
 .. status:: host
 
    The :status:`host` field contains the system's hostname. In Unix/Linux
@@ -69,6 +74,8 @@ locks
    All :status:`locks` statuses first appeared in the 2.1.2
    development release for the 2.2 series.
 
+.. example:: output of the :ref:`locks <server-status-example-locks>` fields.
+
 .. status:: locks
 
    The :status:`locks` document contains sub-documents that provides a
@@ -262,6 +269,8 @@ locks
 globalLock
 ----------
 
+.. example:: output of the :ref:`globalLock <server-status-example-globallock>` fields.
+
 .. status:: globalLock
 
    The :status:`globalLock` data structure contains information regarding
@@ -378,6 +387,8 @@ globalLock.activeClients
 mem
 ---
 
+.. example:: output of the :ref:`memory <server-status-example-memory>` fields.
+
 .. status:: mem
 
    The :status:`mem` data structure holds information regarding the target
@@ -427,6 +438,8 @@ mem
 connections
 -----------
 
+.. example:: output of the :ref:`connections <server-status-example-connections>` fields.
+
 .. status:: connections
 
    The :status:`connections` sub document data regarding the
@@ -461,6 +474,8 @@ connections
 extra_info
 ----------
 
+.. example:: output of the :ref:`extra_info <server-status-example-extrainfo>` fields.
+
 .. status:: extra_info
 
    The :status:`extra_info` data structure holds data collected by the
@@ -491,11 +506,12 @@ extra_info
    faults do not in and of themselves indicate an issue.
 
 .. _server-status-indexcounters:
-.. _server-status-indexCounters:
 
 indexCounters
 -------------
 
+.. example:: output of the :ref:`indexCounters <server-status-example-indexcounters>` fields.
+
 .. status:: indexCounters
 
    .. versionchanged:: 2.2
@@ -564,6 +580,8 @@ indexCounters
 backgroundFlushing
 ------------------
 
+.. example:: output of the :ref:`backgroundFlushing <server-status-example-backgroundflushing>` fields.
+
 .. status:: backgroundFlushing
 
    :program:`mongod` periodically flushes writes to disk. In the default
@@ -625,6 +643,8 @@ backgroundFlushing
 cursors
 -------
 
+.. example:: output of the :ref:`cursors <server-status-example-cursors>` fields.
+
 .. status:: cursors
 
    The :status:`cursors` data structure contains data regarding cursor state
@@ -655,6 +675,8 @@ cursors
 network
 -------
 
+.. example:: output of the :ref:`network <server-status-example-network>` fields.
+
 .. status:: network
 
    The :status:`network` data structure contains data regarding MongoDB's
@@ -689,6 +711,8 @@ network
 repl
 ----
 
+.. example:: output of the :ref:`repl <server-status-example-repl>` fields.
+
 .. status:: repl
 
    The :status:`repl` data structure contains status information for
@@ -736,6 +760,8 @@ repl
 opcountersRepl
 --------------
 
+.. example:: output of the :ref:`opcountersRepl <server-status-example-opcountersrepl>` fields.
+
 .. status:: opcountersRepl
 
    The :status:`opcountersRepl` data structure, similar to the
@@ -797,6 +823,8 @@ replNetworkQueue
 
 .. versionadded:: 2.1.2
 
+.. example:: output of the :ref:`replNetworkQueue <server-status-example-replnetworkqueue>` fields.
+
 .. status:: replNetworkQueue
 
    The :status:`replNetworkQueue` document reports on the network
@@ -827,6 +855,8 @@ replNetworkQueue
 opcounters
 ----------
 
+.. example:: output of the :ref:`opcounters <server-status-example-opcounters>` fields.
+
 .. status:: opcounters
 
    The :status:`opcounters` data structure provides an overview of
@@ -878,6 +908,8 @@ opcounters
 asserts
 -------
 
+.. example:: output of the :ref:`asserts <server-status-example-asserts>` fields.
+
 .. status:: asserts
 
    The :status:`asserts` data structure provides an account of the
@@ -928,6 +960,8 @@ asserts
 writeBacksQueued
 ----------------
 
+.. example:: output of the :ref:`writeBacksQueued <server-status-example-writebacksqueued>` fields.
+
 .. status:: writeBacksQueued
 
    The value of :status:`writeBacksQueued` is ``true`` when there
@@ -948,6 +982,8 @@ dur
 Journaling
 ~~~~~~~~~~
 
+.. example:: output of the :ref:`journaling <server-status-example-journaling>` fields.
+
 .. status:: dur
 
    The :status:`dur` (for "durability") data structure contains data
@@ -1056,6 +1092,8 @@ timeMS
 recordStats
 -----------
 
+.. example:: output of the :ref:`recordStats <server-status-example-recordstats>` fields.
+
 .. versionadded::2.1.2
    All :status:`recordStats` statuses first appeared in the 2.1.2
    development release for the 2.2 series.