Skip to content

Commit cf2b2a8

Browse files
author
Sam Kleinman
committed
DOCS-377 adding cross references to the original server status index and linking the page.
1 parent 0bca88c commit cf2b2a8

File tree

3 files changed

+79
-9
lines changed

3 files changed

+79
-9
lines changed

source/reference.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Statuses and Errors
3131
.. toctree::
3232
:maxdepth: 1
3333

34+
35+
reference/server-status-index
3436
reference/server-status
3537
reference/database-statistics
3638
reference/collection-statistics
@@ -74,7 +76,7 @@ Current release:
7476

7577
- :wiki:`v2.0 Release Notes <2.0+Release+Notes>`
7678

77-
Previous release:
79+
Previous release:
7880

7981
- :wiki:`v1.8 Release Notes <1.8+Release+Notes>`
8082

source/reference/server-status-index.txt

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
:orphan:
2-
3-
===================
4-
Server Status Index
5-
===================
1+
==========================
2+
Server Status Output Index
3+
==========================
64

75
.. default-domain:: mongodb
86

@@ -23,6 +21,7 @@ documentation of the content of this output, see
2321
kind of node, including :program:`mongos`, :program:`mongod` or
2422
:term:`replica set` member.
2523

24+
.. _server-status-example-instance-information:
2625

2726
The ":ref:`server-status-instance-information`" section displays
2827
information regarding the specific :program:`mongod` and
@@ -40,6 +39,8 @@ information regarding the specific :program:`mongod` and
4039
"uptimeEstimate" : <num>,
4140
"localTime" : ISODate(""),
4241

42+
.. _server-status-example-locks:
43+
4344
The ":ref:`server-status-locks`" section reports data that reflect the
4445
state and use of both global (i.e. ``.``) and database specific locks:
4546

@@ -88,6 +89,8 @@ state and use of both global (i.e. ``.``) and database specific locks:
8889
}
8990
},
9091

92+
.. _server-status-example-globallock:
93+
9194
The ":ref:`server-status-globallock`" field reports on MongoDB's
9295
global system lock. In most cases the :ref:`locks <locks>` document
9396
provides more fine grained data that reflects lock use:
@@ -109,6 +112,7 @@ provides more fine grained data that reflects lock use:
109112
}
110113
},
111114

115+
.. _server-status-example-memory:
112116

113117
The ":ref:`server-status-memory`" field reports on MongoDB's
114118
current memory use:
@@ -124,6 +128,8 @@ current memory use:
124128
"mappedWithJournal" : <num>
125129
},
126130

131+
.. _server-status-example-connections:
132+
127133
The ":ref:`server-status-connections`" field reports on MongoDB's
128134
current memory use by the MongoDB process:
129135

@@ -134,6 +140,8 @@ current memory use by the MongoDB process:
134140
"available" : <num>
135141
},
136142

143+
.. _server-status-example-extrainfo:
144+
137145
The fields in the ":ref:`server-status-extra-info`" document provide
138146
platform specific information. The following example block is from a
139147
Linux-based system:
@@ -146,6 +154,7 @@ Linux-based system:
146154
"page_faults" : <num>
147155
},
148156

157+
.. _server-status-example-indexcounters:
149158

150159
The ":ref:`server-status-indexcounters`" document reports on index
151160
use:
@@ -162,6 +171,8 @@ use:
162171
}
163172
},
164173

174+
.. _server-status-example-backgroundflushing:
175+
165176
The ":ref:`server-status-backgroundflushing`" document reports on the
166177
process MongoDB uses to write data to disk:
167178

@@ -175,6 +186,7 @@ process MongoDB uses to write data to disk:
175186
"last_finished" : ISODate("")
176187
},
177188

189+
.. _server-status-example-cursors:
178190

179191
The ":ref:`server-status-cursors`" document reports on current cursor
180192
use and state:
@@ -187,6 +199,8 @@ use and state:
187199
"timedOut" : <num>
188200
},
189201

202+
.. _server-status-example-network:
203+
190204
The ":ref:`server-status-network`" document reports on network use and
191205
state:
192206

@@ -198,6 +212,8 @@ state:
198212
"numRequests" : <num>
199213
},
200214

215+
.. _server-status-example-repl:
216+
201217
The ":ref:`server-status-repl`" document reports on the state of
202218
replication and the :term:`replica set`. This document only appears
203219
for replica sets.
@@ -217,6 +233,8 @@ for replica sets.
217233
"me" : <hostname>
218234
},
219235

236+
.. _server-status-example-opcountersrepl:
237+
220238
The ":ref:`server-status-opcounters-repl`" document reports the number
221239
of replicated operations:
222240

@@ -231,6 +249,8 @@ of replicated operations:
231249
"command" : <num>
232250
},
233251

252+
.. _server-status-example-replnetworkqueue:
253+
234254
The ":ref:`server-status-repl-network-queue`" document holds
235255
information regarding the queue that :term:`secondaries <secondary>`
236256
use to poll data from other members of their set:
@@ -243,6 +263,8 @@ use to poll data from other members of their set:
243263
"numBytes" : <num>
244264
},
245265

266+
.. _server-status-example-opcounters:
267+
246268
The ":ref:`server-status-opcounters`" document reports the number of
247269
operations this MongoDB instance has processed:
248270

@@ -257,6 +279,8 @@ operations this MongoDB instance has processed:
257279
"command" : <num>
258280
},
259281

282+
.. _server-status-example-asserts:
283+
260284
The ":ref:`server-status-asserts`" document reports the number of
261285
assertions or errors produced by the server:
262286

@@ -270,13 +294,17 @@ assertions or errors produced by the server:
270294
"rollovers" : <num>
271295
},
272296

273-
The ":ref:`server-status-writebacks`" document reports the number of
297+
.. _server-status-example-writebacksqueued:
298+
299+
The ":ref:`server-status-writebacksqueued`" document reports the number of
274300
:term:`writebacks`:
275301

276302
.. code-block:: javascript
277303

278304
"writeBacksQueued" : <num>,
279305

306+
.. _server-status-example-journaling:
307+
280308
The ":ref:`server-status-journaling`" document reports data that
281309
reflect this :program:`mongod` journaling related operations and
282310
performance:
@@ -299,6 +327,8 @@ performance:
299327
}
300328
},
301329

330+
.. _server-status-example-recordstats:
331+
302332
The ":ref:`server-status-recordstats`" document reports data on
303333
MongoDB's ability to predict page faults and yield write operations
304334
when required data isn't in memory:

source/reference/server-status.txt

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,18 @@ your database.
1717

1818
.. seealso:: Much of the output of :dbcommand:`serverStatus` is also
1919
displayed dynamically by :program:`mongostat`. See the
20-
:doc:`/reference/mongostat` reference for more information.
20+
:doc:`/reference/mongostat` for more information.
21+
22+
For examples of the :dbcommand:`serverStatus` output, see
23+
:doc:`/reference/server-status-index`.
2124

2225
.. _server-status-instance-information:
2326

2427
Instance Information
2528
--------------------
2629

30+
.. example:: output of the :ref:`instance information <server-status-example-instance-information>` fields.
31+
2732
.. status:: host
2833

2934
The :status:`host` field contains the system's hostname. In Unix/Linux
@@ -69,6 +74,8 @@ locks
6974
All :status:`locks` statuses first appeared in the 2.1.2
7075
development release for the 2.2 series.
7176

77+
.. example:: output of the :ref:`locks <server-status-example-locks>` fields.
78+
7279
.. status:: locks
7380

7481
The :status:`locks` document contains sub-documents that provides a
@@ -262,6 +269,8 @@ locks
262269
globalLock
263270
----------
264271

272+
.. example:: output of the :ref:`globalLock <server-status-example-globallock>` fields.
273+
265274
.. status:: globalLock
266275

267276
The :status:`globalLock` data structure contains information regarding
@@ -378,6 +387,8 @@ globalLock.activeClients
378387
mem
379388
---
380389

390+
.. example:: output of the :ref:`memory <server-status-example-memory>` fields.
391+
381392
.. status:: mem
382393

383394
The :status:`mem` data structure holds information regarding the target
@@ -427,6 +438,8 @@ mem
427438
connections
428439
-----------
429440

441+
.. example:: output of the :ref:`connections <server-status-example-connections>` fields.
442+
430443
.. status:: connections
431444

432445
The :status:`connections` sub document data regarding the
@@ -461,6 +474,8 @@ connections
461474
extra_info
462475
----------
463476

477+
.. example:: output of the :ref:`extra_info <server-status-example-extrainfo>` fields.
478+
464479
.. status:: extra_info
465480

466481
The :status:`extra_info` data structure holds data collected by the
@@ -491,11 +506,12 @@ extra_info
491506
faults do not in and of themselves indicate an issue.
492507

493508
.. _server-status-indexcounters:
494-
.. _server-status-indexCounters:
495509

496510
indexCounters
497511
-------------
498512

513+
.. example:: output of the :ref:`indexCounters <server-status-example-indexcounters>` fields.
514+
499515
.. status:: indexCounters
500516

501517
.. versionchanged:: 2.2
@@ -564,6 +580,8 @@ indexCounters
564580
backgroundFlushing
565581
------------------
566582

583+
.. example:: output of the :ref:`backgroundFlushing <server-status-example-backgroundflushing>` fields.
584+
567585
.. status:: backgroundFlushing
568586

569587
:program:`mongod` periodically flushes writes to disk. In the default
@@ -625,6 +643,8 @@ backgroundFlushing
625643
cursors
626644
-------
627645

646+
.. example:: output of the :ref:`cursors <server-status-example-cursors>` fields.
647+
628648
.. status:: cursors
629649

630650
The :status:`cursors` data structure contains data regarding cursor state
@@ -655,6 +675,8 @@ cursors
655675
network
656676
-------
657677

678+
.. example:: output of the :ref:`network <server-status-example-network>` fields.
679+
658680
.. status:: network
659681

660682
The :status:`network` data structure contains data regarding MongoDB's
@@ -689,6 +711,8 @@ network
689711
repl
690712
----
691713

714+
.. example:: output of the :ref:`repl <server-status-example-repl>` fields.
715+
692716
.. status:: repl
693717

694718
The :status:`repl` data structure contains status information for
@@ -736,6 +760,8 @@ repl
736760
opcountersRepl
737761
--------------
738762

763+
.. example:: output of the :ref:`opcountersRepl <server-status-example-opcountersrepl>` fields.
764+
739765
.. status:: opcountersRepl
740766

741767
The :status:`opcountersRepl` data structure, similar to the
@@ -797,6 +823,8 @@ replNetworkQueue
797823

798824
.. versionadded:: 2.1.2
799825

826+
.. example:: output of the :ref:`replNetworkQueue <server-status-example-replnetworkqueue>` fields.
827+
800828
.. status:: replNetworkQueue
801829

802830
The :status:`replNetworkQueue` document reports on the network
@@ -827,6 +855,8 @@ replNetworkQueue
827855
opcounters
828856
----------
829857

858+
.. example:: output of the :ref:`opcounters <server-status-example-opcounters>` fields.
859+
830860
.. status:: opcounters
831861

832862
The :status:`opcounters` data structure provides an overview of
@@ -878,6 +908,8 @@ opcounters
878908
asserts
879909
-------
880910

911+
.. example:: output of the :ref:`asserts <server-status-example-asserts>` fields.
912+
881913
.. status:: asserts
882914

883915
The :status:`asserts` data structure provides an account of the
@@ -928,6 +960,8 @@ asserts
928960
writeBacksQueued
929961
----------------
930962

963+
.. example:: output of the :ref:`writeBacksQueued <server-status-example-writebacksqueued>` fields.
964+
931965
.. status:: writeBacksQueued
932966

933967
The value of :status:`writeBacksQueued` is ``true`` when there
@@ -948,6 +982,8 @@ dur
948982
Journaling
949983
~~~~~~~~~~
950984

985+
.. example:: output of the :ref:`journaling <server-status-example-journaling>` fields.
986+
951987
.. status:: dur
952988

953989
The :status:`dur` (for "durability") data structure contains data
@@ -1056,6 +1092,8 @@ timeMS
10561092
recordStats
10571093
-----------
10581094

1095+
.. example:: output of the :ref:`recordStats <server-status-example-recordstats>` fields.
1096+
10591097
.. versionadded::2.1.2
10601098
All :status:`recordStats` statuses first appeared in the 2.1.2
10611099
development release for the 2.2 series.

0 commit comments

Comments
 (0)