From 3b437875bd11f6575d925e289838e1dc917fb206 Mon Sep 17 00:00:00 2001 From: Ed Costello Date: Mon, 12 Nov 2012 13:21:19 -0500 Subject: [PATCH] Various edits for style, some typos --- source/reference/server-status.txt | 59 +++++++++++++++--------------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/source/reference/server-status.txt b/source/reference/server-status.txt index 1ba39070e3a..b4cad96b2a8 100644 --- a/source/reference/server-status.txt +++ b/source/reference/server-status.txt @@ -8,7 +8,7 @@ Server Status Reference ``docs/source/reference/server-status-index.txt`` document also reflects those changes. -The :dbcommand:`serverStatus` returns a collection of information that +The :dbcommand:`serverStatus` command returns a collection of information that reflects the database's status. These data are useful for diagnosing and assessing the performance of your MongoDB instance. This reference catalogs each datum included in the output of this command and @@ -17,7 +17,7 @@ your database. .. seealso:: Much of the output of :dbcommand:`serverStatus` is also displayed dynamically by :program:`mongostat`. See the - :doc:`/reference/mongostat` for more information. + :doc:`/reference/mongostat` command for more information. For examples of the :dbcommand:`serverStatus` output, see :doc:`/reference/server-status-index`. @@ -32,7 +32,7 @@ Instance Information .. status:: host The :status:`host` field contains the system's hostname. In Unix/Linux - system, this should be the same as the output of the ``hostname`` + systems, this should be the same as the output of the ``hostname`` command. .. status:: version @@ -113,38 +113,38 @@ locks .. status:: locks...timeLockedMicros.W The ``W`` field reports the amount of time in microseconds that any - database databases has held the global write lock. + database has held the global write lock. .. status:: locks...timeLockedMicros.r The ``r`` field reports the amount of time in microseconds that any - database databases has held the local read lock. + database has held the local read lock. .. status:: locks...timeLockedMicros.w The ``w`` field reports the amount of time in microseconds that any - database databases has held the local write lock. + database has held the local write lock. .. status:: locks...timeAcquiringMicros The :status:`locks...timeAcquiringMicros` document reports the amount of time in microseconds that operations have spent waiting to acquire - a lock in all database in this :program:`mongod` instance. + a lock in all databases in this :program:`mongod` instance. .. status:: locks...timeAcquiringMicros.R The ``R`` field reports the amount of time in microseconds that any - database databases has spent waiting for the global read lock. + database has spent waiting for the global read lock. .. status:: locks...timeAcquiringMicros.W The ``W`` field reports the amount of time in microseconds that any - database databases has spent waiting for the global write lock. + database has spent waiting for the global write lock. .. status:: locks.admin The :status:`locks.admin` document contains two sub-documents that - reports data regarding lock use in the :term:`admin database`. + report data regarding lock use in the :term:`admin database`. .. status:: locks.admin.timeLockedMicros @@ -171,19 +171,19 @@ locks .. status:: locks.admin.timeAcquiringMicros.r The ``r`` field reports the amount of time in microseconds that - operations have spent waiting a read lock on the + operations have spent waiting to acquire a read lock on the :term:`admin database`. .. status:: locks.admin.timeAcquiringMicros.w The ``w`` field reports the amount of time in microseconds that - operations have spent waiting a write lock on the + operations have spent waiting to acquire a write lock on the :term:`admin database`. .. status:: locks.local The :status:`locks.local` document contains two sub-documents that - reports data regarding lock use in the ``local`` database. The + report data regarding lock use in the ``local`` database. The local database contains a number of instance specific data, including the :term:`oplog` for replication. @@ -212,13 +212,13 @@ locks .. status:: locks.local.timeAcquiringMicros.r The ``r`` field reports the amount of time in microseconds that - operations have spent waiting a read lock on the ``local`` + operations have spent waiting to acquire a read lock on the ``local`` database. .. status:: locks.local.timeAcquiringMicros.w The ``w`` field reports the amount of time in microseconds that - operations have spent waiting a write lock on the ``local`` + operations have spent waiting to acquire a write lock on the ``local`` database. .. status:: locks. @@ -252,13 +252,13 @@ locks .. status:: locks..timeAcquiringMicros.r The ``r`` field reports the amount of time in microseconds that - operations have spent waiting a read lock on the ```` + operations have spent waiting to acquire a read lock on the ```` database. .. status:: locks..timeAcquiringMicros.w The ``w`` field reports the amount of time in microseconds that - operations have spent waiting a write lock on the ```` + operations have spent waiting to acquire a write lock on the ```` database. .. _globallock: @@ -335,13 +335,13 @@ globalLock.currentQueue should cause no concern. Also, consider this value in light of the size of queue waiting for the read lock (e.g. :status:`globalLock.currentQueue.readers`) and write-lock - (e.g. :status:`globalLock.currentQueue.readers`) individually. + (e.g. :status:`globalLock.currentQueue.writers`) individually. .. status:: globalLock.currentQueue.readers The value of :status:`globalLock.currentQueue.readers` is the number of operations that are currently queued and waiting for the - read-lock. A consistently small write-queue, particularly of + read-lock. A consistently small read-queue, particularly of shorter operations should cause no concern. .. status:: globalLock.currentQueue.writers @@ -492,19 +492,19 @@ extra_info .. status:: extra_info.heap_usage_bytes The :status:`extra_info.heap_usage_bytes` field is only available on - Unix/Linux systems, and relates the total size in bytes of heap space + Unix/Linux systems, and reports the total size in bytes of heap space used by the database process. .. status:: extra_info.page_faults The :status:`extra_info.page_faults` field is only available on Unix/Linux - systems, and relates the total number of page faults that require + systems, and reports the total number of page faults that require disk operations. Page faults refer to operations that require the database server to access data which isn't available in active memory. The :status:`page_fault ` counter may increase dramatically during moments of poor performance and may correlate with limited memory environments and larger data sets. Limited and sporadic page - faults do not in and of themselves indicate an issue. + faults do not necessarily indicate an issue. .. _server-status-indexcounters: @@ -562,7 +562,7 @@ indexCounters .. status:: indexCounters.btree.resets - The :status:`index Counter.btree.resets` value reflects the number + The :status:`indexCounters.btree.resets` value reflects the number of times that the index counters have been reset since the database last restarted. Typically this value is ``0``, but use this value to provide context for the data specified by other @@ -587,7 +587,7 @@ backgroundFlushing :program:`mongod` periodically flushes writes to disk. In the default configuration, this happens every 60 seconds. The - :status:`backgroundFlushing` data structure contains data that regarding + :status:`backgroundFlushing` data structure contains data regarding these operations. Consider these values if you have concerns about write performance and :ref:`journaling `. @@ -775,7 +775,7 @@ opcountersRepl because of how MongoDB serializes operations during replication. See :doc:`/core/replication` for more information on replication. - These numbers will grow over time and in response to database + These numbers will grow over time in response to database use. Analyze these values over time to track database utilization. .. status:: opcountersRepl.insert @@ -953,7 +953,7 @@ asserts times that the rollover counters have rolled over since the last time the server process started. The counters will rollover to zero after 2\ :superscript:`30` assertions. Use this value to provide - context to the other values in the :status:`asserts` data structure + context to the other values in the :status:`asserts` data structure. .. _server-status-writebacksqueued: .. _server-status-write-backs-queued: @@ -1003,15 +1003,14 @@ Journaling interval is configurable using the ``--journalCommitInterval`` option. - See the ":wiki:`Journaling`" wiki page for more information about - journaling operations. + .. seealso:: ":wiki:`Journaling`" for more information about journaling operations. .. STUB :doc:`/core/journaling` .. status:: dur.commits The :status:`dur.commits` provides the number of transactions - written to :term:`journal` during the last :wiki:`journal group + written to the :term:`journal` during the last :wiki:`journal group commit interval `. .. status:: dur.journaledMB @@ -1047,7 +1046,7 @@ Journaling .. status:: dur.earlyCommits - The :status:`dur.earlyCommits` value reflects the number of time + The :status:`dur.earlyCommits` value reflects the number of times MongoDB requested a commit before the scheduled :wiki:`journal group commit interval `. Use this value to ensure that your :wiki:`journal group commit interval