From 4dcc69d568dc7c17f9f84ce2d42e7cf1bdf4ae4b Mon Sep 17 00:00:00 2001 From: Andrew Aldridge Date: Wed, 9 Dec 2015 11:54:03 -0500 Subject: [PATCH] DOCS-5964: Document removal of support for cursorInfo --- .../includes/ref-toc-command-diagnostic.yaml | 2 +- source/reference/command/cursorInfo.txt | 21 +------ source/reference/command/serverStatus.txt | 59 +------------------ source/reference/server-status.txt | 18 +----- 4 files changed, 8 insertions(+), 92 deletions(-) diff --git a/source/includes/ref-toc-command-diagnostic.yaml b/source/includes/ref-toc-command-diagnostic.yaml index 854987af984..e2d2263b237 100644 --- a/source/includes/ref-toc-command-diagnostic.yaml +++ b/source/includes/ref-toc-command-diagnostic.yaml @@ -47,7 +47,7 @@ description: "Reports storage utilization statistics for the specified database. --- name: ":dbcommand:`cursorInfo`" file: /reference/command/cursorInfo -description: "Deprecated. Reports statistics on active cursors." +description: "Removed in MongoDB 3.2. Replaced with :data:`serverStatus.metrics.cursor`." --- name: ":dbcommand:`dataSize`" file: /reference/command/dataSize diff --git a/source/reference/command/cursorInfo.txt b/source/reference/command/cursorInfo.txt index 43426e74a6a..527193c86b5 100644 --- a/source/reference/command/cursorInfo.txt +++ b/source/reference/command/cursorInfo.txt @@ -4,24 +4,9 @@ cursorInfo .. default-domain:: mongodb -.. deprecated:: 2.6 - - Use the :dbcommand:`serverStatus` command to return the - :data:`serverStatus.metrics.cursor` information instead. - .. dbcommand:: cursorInfo - The :dbcommand:`cursorInfo` command returns information about current cursor - allotment and use. Use the following form: - - .. code-block:: javascript + .. versionchanged:: 3.2 Removed. - { cursorInfo: 1 } - - The value (e.g. ``1`` above) does not affect the output of the - command. - - :dbcommand:`cursorInfo` returns the total number of open cursors - (``totalOpen``), the size of client cursors in current use - (``clientCursors_size``), and the number of timed out cursors - since the last server restart (``timedOut``). + Use the :dbcommand:`serverStatus` command to return the + :data:`serverStatus.metrics.cursor` information. diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index 773db7ccc1e..77fff549527 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -473,59 +473,6 @@ For an example of the ``backgroundFlushing`` output, see the Also consider ongoing operations that might skew this value by routinely block write operations. -.. _server-status-cursors: - -cursors -~~~~~~~ - -.. deprecated:: 2.6 - See the :ref:`serverStatus.metrics.cursor ` field instead. - -For an example of the ``cursors`` output, see the :ref:`cursors section -` of the :doc:`/reference/server-status` -page. - -.. data:: serverStatus.cursors - - The :data:`~serverStatus.cursors` data structure contains data regarding cursor state - and use. - -.. data:: serverStatus.cursors.note - - A note specifying to use the :data:`serverStatus.metrics.cursor` - field instead of :data:`serverStatus.cursors`. - -.. data:: serverStatus.cursors.totalOpen - - :data:`~serverStatus.cursors.totalOpen` provides the number of cursors that - MongoDB is maintaining for clients. Because MongoDB exhausts unused - cursors, typically this value small or zero. However, if there is a - queue, stale :term:`tailable cursor`, or a large number of - operations, this value may rise. - -.. data:: serverStatus.cursors.clientCursors_size - - .. deprecated:: 1.x - See :data:`~serverStatus.cursors.totalOpen` for this datum. - -.. data:: serverStatus.cursors.timedOut - - :data:`~serverStatus.cursors.timedOut` provides a counter of the total number - of cursors that have timed out since the server process started. If - this number is large or growing at a regular rate, this may - indicate an application error. - -.. data:: serverStatus.cursors.totalNoTimeout - - :data:`~serverStatus.cursors.totalNoTimeout` provides the number of open - cursors with the option :data:`DBQuery.Option.noTimeout` set to - prevent timeout after a period of inactivity. - -.. data:: serverStatus.cursors.pinned - - :data:`serverStatus.cursors.pinned` provides the number - of "pinned" open cursors. - .. _server-status-network: network @@ -639,7 +586,7 @@ page. .. data:: serverStatus.repl.replicationProgress .. versionchanged:: 3.2.0 - + MongoDB 3.2.0 renamed this field from ``serverStatus.repl.slaves`` to :data:`serverStatus.repl.replicationProgress`. @@ -1632,7 +1579,7 @@ section ` of the .. versionadded:: 3.0.0 :data:`serverStatus.wiredTiger.cache` returns statistics on the - cache and page evictions from the cache. + cache and page evictions from the cache. The following describes some of the key :data:`serverStatus.wiredTiger.cache` statistics: @@ -1698,7 +1645,7 @@ section ` of the :data:`serverStatus.wiredTiger.log` returns statistics on WiredTiger's write ahead log. - + .. seealso:: :ref:`journaling-wiredTiger` .. data:: serverStatus.wiredTiger.reconciliation diff --git a/source/reference/server-status.txt b/source/reference/server-status.txt index b4c0be90c87..5d500fa0fcc 100644 --- a/source/reference/server-status.txt +++ b/source/reference/server-status.txt @@ -11,7 +11,7 @@ documentation of the content of this output, see :doc:`/reference/command/serverStatus`. .. When adding status fields to this document, make sure that the -.. ``docs/source/reference/command/serverStatus.txt`` document also +.. ``docs/source/reference/command/serverStatus.txt`` document also .. reflects those changes. .. note:: @@ -90,22 +90,6 @@ current number of open incoming connections: "totalCreated" : NumberLong() }, -.. _server-status-example-cursors: - -The :ref:`server-status-cursors` document reports on current cursor -use and state: - -.. code-block:: javascript - - "cursors" : { - "note" : "deprecated, use server status metrics", - "clientCursors_size" : , - "totalOpen" : , - "pinned" : , - "totalNoTimeout" : , - "timedOut" : - }, - .. _server-status-example-journaling: The :ref:`server-status-journaling` document reports on data that