Skip to content

Commit 4c1a907

Browse files
Backport-queryStats-v6.0 (#8490)
* standardize queryStats page * update versionadded * (DOCSP-33099): queryStats serverStatus metrics (#4811) * (DOCSP-26200): queryStats aggregation stage * WIP * WIP * WIP * Remove accidental file * add TODO * add missing ref * formatting * WIP * WIP * WIP * wording * WIP * edits * add examples * try to fix table format * add transformed example * remove TODO * more table formatting * add atlas data collection * table formatting * clarity * add more context for data collection * table formatting * wording tweaks * address review comments * formatting * use simplified examples * add input/output * edits * add link to transformed example * spacing * edits * (DOCSP-33099): queryStats serverStatus metrics * (DOCSP-33099): serverStatus metrics for queryStats * formatting * clarity * address review comments * fix incomplete sentence * rework transformation section * edits * remove notion of a 'cache' * remove extra queryStats heading * minimalism * fix collation link formatting * move virtual collection details to the queryStats page * change wording for output fields * (DOCSP-26200): queryStats aggregation stage * WIP * WIP * WIP * Remove accidental file * add TODO * add missing ref * formatting * WIP * WIP * WIP * wording * WIP * edits * add examples * try to fix table format * add transformed example * remove TODO * more table formatting * add atlas data collection * table formatting * clarity * add more context for data collection * table formatting * wording tweaks * address review comments * formatting * use simplified examples * add input/output * edits * add link to transformed example * spacing * edits * address review comments * fix incomplete sentence * rework transformation section * edits * fix collation link formatting * change wording for output fields * edit glossary * more edits * remove glossary entry * formatting * edits * Address review feedback * wording * review edit * address review comments * edit * wording * WIP review edits * remove Atlas data collection info * (DOCSP-33347): Re-add Atlas data collection info * typo * minimalism * typo * clarity * remove Atlas data collection info * edits * (DOCSP-33347): Re-add Atlas data collection info * add find queryShape properties * change case * formatting * abstracted > normalized consistency * clarify privilege * address review comments * review edits * undo unrelated change
1 parent b7db789 commit 4c1a907

File tree

2 files changed

+378
-89
lines changed

2 files changed

+378
-89
lines changed

source/reference/command/serverStatus.txt

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3690,6 +3690,55 @@ oplogTruncation
36903690

36913691
Available in the :doc:`/core/wiredtiger`.
36923692

3693+
.. _server-status-queryStats:
3694+
3695+
queryStats
3696+
~~~~~~~~~~
3697+
3698+
.. versionadded:: 6.0.7
3699+
3700+
.. code-block:: javascript
3701+
3702+
queryStats: {
3703+
numEvicted: Long("<num>"),
3704+
numRateLimitedRequests: Long("<num>"),
3705+
queryStatsStoreSizeEstimateBytes: Long("<num>"),
3706+
numQueryStatsStoreWriteErrors: Long("<num>"),
3707+
numHmacApplicationErrors: Long("<num>")
3708+
},
3709+
3710+
.. serverstatus:: queryStats
3711+
3712+
A document that contains metrics for the :pipeline:`$queryStats`
3713+
aggregation stage.
3714+
3715+
.. serverstatus:: queryStats.numEvicted
3716+
3717+
Number of queries that the ``$queryStats`` virtual collection has
3718+
evicted due to space contraints.
3719+
3720+
.. serverstatus:: queryStats.numRateLimitedRequests
3721+
3722+
Number of times that query stats were not recorded for a query due to
3723+
rate limiting.
3724+
3725+
.. serverstatus:: queryStats.queryStatsStoreSizeEstimateBytes
3726+
3727+
Current estimated size of objects in the ``$queryStats`` virtual
3728+
collection.
3729+
3730+
.. serverstatus:: queryStats.numQueryStatsStoreWriteErrors
3731+
3732+
Number of times this MongoDB process failed to store a new query
3733+
stats key. Generally, these failures happen when the
3734+
``$queryStats`` virtual collection runs out of space.
3735+
3736+
.. serverstatus:: queryStats.numHmacApplicationErrors
3737+
3738+
Number of times this MongoDB process failed to compute a one-way
3739+
tokenized query stats key when ``$queryStats`` was called with the
3740+
``transformIdentifiers`` option.
3741+
36933742
.. _server-status-readConcernCounters:
36943743

36953744
readConcernCounters
@@ -6328,4 +6377,3 @@ writeBacksQueued
63286377
A boolean that indicates whether there are operations from a
63296378
:binary:`~bin.mongos` instance queued for retrying. Typically, this
63306379
value is false. See also :term:`writeBacks`.
6331-

0 commit comments

Comments
 (0)