DOCS-14144-report-histogram-data-on-cursors-drain

Author: jason-price-mongodb

source/reference/command/serverStatus.txt

@@ -4594,6 +4594,15 @@ metrics
             "moreThanOneBatch" : NumberLong(<num>),
             "timedOut" : NumberLong(<num>),
             "totalOpened" : NumberLong(<num>),
+            "lifespan" : {
+               "greaterThanOrEqual10Minutes" : NumberLong(<num>),
+               "lessThan10Minutes" : NumberLong(<num>),
+               "lessThan15Seconds" : NumberLong(<num>),
+               "lessThan1Minute" : NumberLong(<num>),
+               "lessThan1Second" : NumberLong(<num>),
+               "lessThan30Seconds" : NumberLong(<num>),
+               "lessThan5Seconds" : NumberLong(<num>)
+            },
             "open" : {
                "noTimeout" : NumberLong(<num>),
                "pinned" : NumberLong(<num>),
@@ -5314,6 +5323,76 @@ metrics
 
    .. versionadded:: 5.0
 
+.. _server-status-metrics-cursor-lifespan:
+
+.. serverstatus:: metrics.cursor.lifespan
+
+   A document that reports the number of cursors that have lifespans
+   within specified time periods. The cursor lifespan is the time period
+   from when the cursor is created to when the cursor is killed using
+   the :dbcommand:`killCursors` command or the cursor has no remaining
+   objects in the :ref:`batch <cursor-batches>`.
+
+   The lifespan time periods are:
+
+   - < 1 second
+
+   - >= 1 second to < 5 seconds
+
+   - >= 5 seconds to < 15 seconds
+
+   - >= 15 seconds to < 30 seconds
+
+   - >= 30 seconds to < 1 minute
+
+   - >= 1 minute to < 10 minutes
+
+   - >= 10 minutes
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.greaterThanOrEqual10Minutes
+
+   The number of cursors with a lifespan >= 10 minutes.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan10Minutes
+
+   The number of cursors with a lifespan >= 1 minute to < 10 minutes.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan15Seconds
+
+   The number of cursors with a lifespan >= 5 seconds to < 15 seconds.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan1Minute
+
+   The number of cursors with a lifespan >= 30 seconds to < 1 minute.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan1Second
+
+   The number of cursors with a lifespan < 1 second.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan30Seconds
+
+   The number of cursors with a lifespan >= 15 seconds to < 30 seconds.
+
+   .. versionadded:: 5.0
+
+.. serverstatus:: metrics.cursor.lifespan.lessThan5Seconds
+
+   The number of cursors with a lifespan >= 1 second to < 5 seconds.
+
+   .. versionadded:: 5.0
+
 .. serverstatus:: metrics.cursor.open
 
    A document that contains data regarding open cursors.

source/release-notes/5.0.txt

@@ -382,6 +382,9 @@ output:
                report the total number of cursors that have been opened
                on :binary:`~bin.mongod` and :binary:`~bin.mongos`
                respectively
+             | :serverstatus:`metrics.cursor.lifespan`, which reports
+               the number of cursors that have lifespans within
+               specified time periods
 
 .. _5.0-rel-notes-shell: