Skip to content

DOCS-5964: Document removal of support for cursorInfo #2473

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion source/includes/ref-toc-command-diagnostic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 3 additions & 18 deletions source/reference/command/cursorInfo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
59 changes: 3 additions & 56 deletions source/reference/command/serverStatus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <server-status-metrics>` field instead.

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

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
Expand Down Expand Up @@ -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`.

Expand Down Expand Up @@ -1632,7 +1579,7 @@ section <server-status-example-wiredTiger>` 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:
Expand Down Expand Up @@ -1698,7 +1645,7 @@ section <server-status-example-wiredTiger>` of the

:data:`serverStatus.wiredTiger.log` returns statistics on
WiredTiger's write ahead log.

.. seealso:: :ref:`journaling-wiredTiger`

.. data:: serverStatus.wiredTiger.reconciliation
Expand Down
18 changes: 1 addition & 17 deletions source/reference/server-status.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -90,22 +90,6 @@ current number of open incoming connections:
"totalCreated" : NumberLong(<num>)
},

.. _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" : <num>,
"totalOpen" : <num>,
"pinned" : <num>,
"totalNoTimeout" : <num>,
"timedOut" : <num>
},

.. _server-status-example-journaling:

The :ref:`server-status-journaling` document reports on data that
Expand Down