Skip to content

Commit bece48e

Browse files
authored
DOCS-16389 query plan cache subdocument (#5217)
* DOCS-16389 query plan cache subdocument * * * IF feedback * clarity * nit * move to compatibility * * * wording * wording
1 parent fd42c6e commit bece48e

File tree

2 files changed

+46
-7
lines changed

2 files changed

+46
-7
lines changed

source/reference/command/serverStatus.txt

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1645,7 +1645,6 @@ metrics
16451645
},
16461646
query: {
16471647
allowDiskUseFalse: Long("<num>"),
1648-
planCacheTotalSizeEstimateBytes: Long("<num>"),
16491648
updateOneOpStyleBroadcastWithExactIDCount: Long("<num>"),
16501649
lookup: {
16511650
hashLookup: Long("<num>"),
@@ -3854,15 +3853,42 @@ planCache
38543853

38553854
.. code-block:: javascript
38563855

3857-
planCache: {
3858-
classic: { hits: Long("<num>"), misses: Long("<num>") },
3859-
sbe: { hits: Long("<num>"), misses: Long("<num>") }
3856+
planCache : {
3857+
totalQueryShapes : Long("<num>"),
3858+
totalSizeEstimateBytes : Long("<num>"),
3859+
classic : {
3860+
hits : Long("<num>"),
3861+
misses : Long("<num>")
3862+
},
3863+
sbe : {
3864+
hits : Long("<num>"),
3865+
misses: Long("<num>")
3866+
}
38603867
}
38613868

38623869
.. serverstatus:: planCache
38633870

38643871
A document that reports query plan cache statistics.
38653872

3873+
.. serverstatus:: planCache.totalQueryShapes
3874+
3875+
Approximate number of :term:`query shapes <query shape>`.
3876+
3877+
Prior to version 7.2, information on the number of query shapes was stored in
3878+
the ``query.planCacheTotalQueryShapes`` field.
3879+
3880+
.. versionadded:: 7.2
3881+
3882+
.. serverstatus:: planCache.totalSizeEstimateBytes
3883+
3884+
Total size of the plan cache in bytes.
3885+
3886+
Prior to version 7.2, information on the plan cache size was stored in the
3887+
``query.planCacheTotalSizeEstimateBytes`` field.
3888+
3889+
3890+
.. versionadded:: 7.2
3891+
38663892
.. serverstatus:: planCache.classic.hits
38673893

38683894
Number of classic execution engine query plans found in the query
@@ -3875,12 +3901,12 @@ planCache
38753901

38763902
.. serverstatus:: planCache.sbe.hits
38773903

3878-
Number of slot-based execution engine query plans found in the query
3904+
Number of |sbe-short| query plans found in the query
38793905
cache and reused to avoid the query planning phase.
38803906

38813907
.. serverstatus:: planCache.sbe.misses
38823908

3883-
Number of slot-based execution engine query plans which were not found
3909+
Number of |sbe-short| plans which were not found
38843910
in the query cache and went through the query planning phase.
38853911

38863912
.. _server-status-queryAnalyzers:
@@ -6741,7 +6767,7 @@ wiredTiger
67416767

67426768
.. serverstatus:: wiredTiger.cache.bytes currently in the cache
67436769

6744-
Size in byte of the data currently in cache. This value should
6770+
Size in bytes of the data currently in cache. This value should
67456771
not be greater than the ``maximum bytes configured`` value.
67466772

67476773
.. serverstatus:: wiredTiger.cache.unmodified pages evicted

source/release-notes/7.2-compatibility.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,16 @@ Backward-Incompatible Features
2323

2424
General Changes
2525
---------------
26+
27+
``serverStatus`` Metrics
28+
~~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
Starting in MongoDB 7.2, the :dbcommand:`serverStatus` command and the
31+
:method:`db.serverStatus()` method have these output changes:
32+
33+
Renamed Metrics
34+
```````````````
35+
36+
- ``query.planCacheTotalQueryShapes`` is now :serverstatus:`planCache.totalQueryShapes`
37+
- ``query.planCacheTotalSizeEstimateBytes`` is now :serverstatus:`planCache.totalSizeEstimateBytes`
38+

0 commit comments

Comments
 (0)